Class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Database

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firestore_v1/classes.rb,
lib/google/apis/firestore_v1/representations.rb,
lib/google/apis/firestore_v1/representations.rb

Overview

A Cloud Firestore Database.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleFirestoreAdminV1Database

Returns a new instance of GoogleFirestoreAdminV1Database.



1294
1295
1296
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1294

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#app_engine_integration_mode ⇒ String

The App Engine integration mode to use for this database. Corresponds to the JSON property appEngineIntegrationMode

Returns:

  • (String) 


1199
1200
1201
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1199

def app_engine_integration_mode
  @app_engine_integration_mode
end

#cmek_config ⇒ Google::Apis::FirestoreV1::GoogleFirestoreAdminV1CmekConfig

The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. Corresponds to the JSON property cmekConfig

Returns:



1206
1207
1208
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1206

def cmek_config
  @cmek_config
end

#concurrency_mode ⇒ String

The concurrency control mode to use for this database. Corresponds to the JSON property concurrencyMode

Returns:

  • (String) 


1211
1212
1213
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1211

def concurrency_mode
  @concurrency_mode
end

#create_time ⇒ String

Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time. Corresponds to the JSON property createTime

Returns:

  • (String) 


1217
1218
1219
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1217

def create_time
  @create_time
end

#delete_protection_state ⇒ String

State of delete protection for the database. Corresponds to the JSON property deleteProtectionState

Returns:

  • (String) 


1222
1223
1224
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1222

def delete_protection_state
  @delete_protection_state
end

#earliest_version_time ⇒ String

Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with now - version_retention_period. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery. Corresponds to the JSON property earliestVersionTime

Returns:

  • (String) 


1232
1233
1234
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1232

def earliest_version_time
  @earliest_version_time
end

#etag ⇒ String

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up- to-date value before proceeding. Corresponds to the JSON property etag

Returns:

  • (String) 


1239
1240
1241
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1239

def etag
  @etag
end

#key_prefix ⇒ String

Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL- encoded keys is the project_id (eg: foo instead of v~foo). Corresponds to the JSON property keyPrefix

Returns:

  • (String) 


1248
1249
1250
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1248

def key_prefix
  @key_prefix
end

#location_id ⇒ String

The location of the database. Available locations are listed at https://cloud. google.com/firestore/docs/locations. Corresponds to the JSON property locationId

Returns:

  • (String) 


1254
1255
1256
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1254

def location_id
  @location_id
end

#name ⇒ String

The resource name of the Database. Format: projects/project/databases/ database` Corresponds to the JSON propertyname`

Returns:

  • (String) 


1260
1261
1262
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1260

def name
  @name
end

#point_in_time_recovery_enablement ⇒ String

Whether to enable the PITR feature on this database. Corresponds to the JSON property pointInTimeRecoveryEnablement

Returns:

  • (String) 


1265
1266
1267
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1265

def point_in_time_recovery_enablement
  @point_in_time_recovery_enablement
end

#type ⇒ String

The type of the database. See https://cloud.google.com/datastore/docs/ firestore-or-datastore for information about how to choose. Corresponds to the JSON property type

Returns:

  • (String) 


1271
1272
1273
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1271

def type
  @type
end

#uid ⇒ String

Output only. The system-generated UUID4 for this Database. Corresponds to the JSON property uid

Returns:

  • (String) 


1276
1277
1278
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1276

def uid
  @uid
end

#update_time ⇒ String

Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database. Corresponds to the JSON property updateTime

Returns:

  • (String) 


1283
1284
1285
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1283

def update_time
  @update_time
end

#version_retention_period ⇒ String

Output only. The period during which past versions of data are retained in the database. Any read or query can specify a read_time within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour. Corresponds to the JSON property versionRetentionPeriod

Returns:

  • (String) 


1292
1293
1294
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1292

def version_retention_period
  @version_retention_period
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
 
# File 'lib/google/apis/firestore_v1/classes.rb', line 1299

def update!(**args)
  @app_engine_integration_mode = args[:app_engine_integration_mode] if args.key?(:app_engine_integration_mode)
  @cmek_config = args[:cmek_config] if args.key?(:cmek_config)
  @concurrency_mode = args[:concurrency_mode] if args.key?(:concurrency_mode)
  @create_time = args[:create_time] if args.key?(:create_time)
  @delete_protection_state = args[:delete_protection_state] if args.key?(:delete_protection_state)
  @earliest_version_time = args[:earliest_version_time] if args.key?(:earliest_version_time)
  @etag = args[:etag] if args.key?(:etag)
  @key_prefix = args[:key_prefix] if args.key?(:key_prefix)
  @location_id = args[:location_id] if args.key?(:location_id)
  @name = args[:name] if args.key?(:name)
  @point_in_time_recovery_enablement = args[:point_in_time_recovery_enablement] if args.key?(:point_in_time_recovery_enablement)
  @type = args[:type] if args.key?(:type)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
  @version_retention_period = args[:version_retention_period] if args.key?(:version_retention_period)
end