Class: Google::Apis::SpannerV1::Database

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

Overview

A Cloud Spanner database.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Database

Returns a new instance of Database.



2288
2289
2290
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2288

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

Instance Attribute Details

#create_time ⇒ String

Output only. If exists, the time at which the database creation started. Corresponds to the JSON property createTime

Returns:

  • (String) 


2202
2203
2204
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2202

def create_time
  @create_time
end

#database_dialect ⇒ String

Output only. The dialect of the Cloud Spanner Database. Corresponds to the JSON property databaseDialect

Returns:

  • (String) 


2207
2208
2209
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2207

def database_dialect
  @database_dialect
end

#default_leader ⇒ String

Output only. The read-write region which contains the database's leader replicas. This is the same as the value of default_leader database option set using DatabaseAdmin.CreateDatabase or DatabaseAdmin.UpdateDatabaseDdl. If not explicitly set, this is empty. Corresponds to the JSON property defaultLeader

Returns:

  • (String) 


2215
2216
2217
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2215

def default_leader
  @default_leader
end

#earliest_version_time ⇒ String

Output only. Earliest timestamp at which older versions of the data can be read. This value is continuously updated by Cloud Spanner 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) 


2224
2225
2226
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2224

def earliest_version_time
  @earliest_version_time
end

#enable_drop_protection ⇒ Boolean Also known as: enable_drop_protection?

Optional. Whether drop protection is enabled for this database. Defaults to false, if not set. For more details, please see how to prevent accidental database deletion. Corresponds to the JSON property enableDropProtection

Returns:

  • (Boolean) 


2232
2233
2234
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2232

def enable_drop_protection
  @enable_drop_protection
end

#encryption_config ⇒ Google::Apis::SpannerV1::EncryptionConfig

Encryption configuration for a Cloud Spanner database. Corresponds to the JSON property encryptionConfig

Returns:



2238
2239
2240
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2238

def encryption_config
  @encryption_config
end

#encryption_info ⇒ Array<Google::Apis::SpannerV1::EncryptionInfo>

Output only. For databases that are using customer managed encryption, this field contains the encryption information for the database, such as all Cloud KMS key versions that are in use. The encryption_status field inside of each EncryptionInfo is not populated. For databases that are using Google default or other types of encryption, this field is empty. This field is propagated lazily from the backend. There might be a delay from when a key version is being used and when it appears in this field. Corresponds to the JSON property encryptionInfo

Returns:



2249
2250
2251
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2249

def encryption_info
  @encryption_info
end

#name ⇒ String

Required. The name of the database. Values are of the form projects// instances//databases/, where `is as specified in theCREATE DATABASE statement. This name can be passed to other API methods to identify the database. Corresponds to the JSON propertyname`

Returns:

  • (String) 


2257
2258
2259
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2257

def name
  @name
end

#quorum_info ⇒ Google::Apis::SpannerV1::QuorumInfo

Information about the dual-region quorum. Corresponds to the JSON property quorumInfo

Returns:



2262
2263
2264
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2262

def quorum_info
  @quorum_info
end

#reconciling ⇒ Boolean Also known as: reconciling?

Output only. If true, the database is being updated. If false, there are no ongoing update operations for the database. Corresponds to the JSON property reconciling

Returns:

  • (Boolean) 


2268
2269
2270
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2268

def reconciling
  @reconciling
end

#restore_info ⇒ Google::Apis::SpannerV1::RestoreInfo

Information about the database restore. Corresponds to the JSON property restoreInfo

Returns:



2274
2275
2276
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2274

def restore_info
  @restore_info
end

#state ⇒ String

Output only. The current database state. Corresponds to the JSON property state

Returns:

  • (String) 


2279
2280
2281
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2279

def state
  @state
end

#version_retention_period ⇒ String

Output only. The period in which Cloud Spanner retains all versions of data for the database. This is the same as the value of version_retention_period database option set using UpdateDatabaseDdl. Defaults to 1 hour, if not set. Corresponds to the JSON property versionRetentionPeriod

Returns:

  • (String) 


2286
2287
2288
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2286

def version_retention_period
  @version_retention_period
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2293

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @database_dialect = args[:database_dialect] if args.key?(:database_dialect)
  @default_leader = args[:default_leader] if args.key?(:default_leader)
  @earliest_version_time = args[:earliest_version_time] if args.key?(:earliest_version_time)
  @enable_drop_protection = args[:enable_drop_protection] if args.key?(:enable_drop_protection)
  @encryption_config = args[:encryption_config] if args.key?(:encryption_config)
  @encryption_info = args[:encryption_info] if args.key?(:encryption_info)
  @name = args[:name] if args.key?(:name)
  @quorum_info = args[:quorum_info] if args.key?(:quorum_info)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @restore_info = args[:restore_info] if args.key?(:restore_info)
  @state = args[:state] if args.key?(:state)
  @version_retention_period = args[:version_retention_period] if args.key?(:version_retention_period)
end