Class: Google::Apis::SpannerV1::Backup

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 backup of a Cloud Spanner database.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Backup

Returns a new instance of Backup.



119
120
121
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 119

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

Instance Attribute Details

#create_time ⇒ String

Output only. The time the CreateBackup request is received. If the request does not specify version_time, the version_time of the backup will be equivalent to the create_time. Corresponds to the JSON property createTime

Returns:

  • (String) 


34
35
36
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 34

def create_time
  @create_time
end

#database ⇒ String

Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form projects//instances//databases/. Corresponds to the JSON property database

Returns:

  • (String) 


41
42
43
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 41

def database
  @database
end

#database_dialect ⇒ String

Output only. The database dialect information for the backup. Corresponds to the JSON property databaseDialect

Returns:

  • (String) 


46
47
48
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 46

def database_dialect
  @database_dialect
end

#encryption_info ⇒ Google::Apis::SpannerV1::EncryptionInfo

Encryption information for a Cloud Spanner database or backup. Corresponds to the JSON property encryptionInfo

Returns:



51
52
53
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 51

def encryption_info
  @encryption_info
end

#expire_time ⇒ String

Required for the CreateBackup operation. The expiration time of the backup, with microseconds granularity that must be at least 6 hours and at most 366 days from the time the CreateBackup request is processed. Once the expire_time has passed, the backup is eligible to be automatically deleted by Cloud Spanner to free the resources used by the backup. Corresponds to the JSON property expireTime

Returns:

  • (String) 


60
61
62
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 60

def expire_time
  @expire_time
end

#max_expire_time ⇒ String

Output only. The max allowed expiration time of the backup, with microseconds granularity. A backup's expiration time can be configured in multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or copying an existing backup, the expiration time specified must be less than Backup. max_expire_time. Corresponds to the JSON property maxExpireTime

Returns:

  • (String) 


69
70
71
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 69

def max_expire_time
  @max_expire_time
end

#name ⇒ String

Output only for the CreateBackup operation. Required for the UpdateBackup operation. A globally unique identifier for the backup which cannot be changed. Values are of the form projects//instances//backups/a-z*[a-z0-9] The final segment of the name must be between 2 and 60 characters in length. The backup is stored in the location(s) specified in the instance configuration of the instance containing the backup, identified by the prefix of the backup name of the form projects//instances/. Corresponds to the JSON property name

Returns:

  • (String) 


80
81
82
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 80

def name
  @name
end

#referencing_backups ⇒ Array<String>

Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form projects//instances// backups/. Referencing backups may exist in different instances. The existence of any referencing backup prevents the backup from being deleted. When the copy operation is done (either successfully completed or cancelled or the destination backup is deleted), the reference to the backup is removed. Corresponds to the JSON property referencingBackups

Returns:

  • (Array<String>) 


90
91
92
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 90

def referencing_backups
  @referencing_backups
end

#referencing_databases ⇒ Array<String>

Output only. The names of the restored databases that reference the backup. The database names are of the form projects//instances//databases/. Referencing databases may exist in different instances. The existence of any referencing database prevents the backup from being deleted. When a restored database from the backup enters the READY state, the reference to the backup is removed. Corresponds to the JSON property referencingDatabases

Returns:

  • (Array<String>) 


100
101
102
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 100

def referencing_databases
  @referencing_databases
end

#size_bytes ⇒ Fixnum

Output only. Size of the backup in bytes. Corresponds to the JSON property sizeBytes

Returns:

  • (Fixnum) 


105
106
107
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 105

def size_bytes
  @size_bytes
end

#state ⇒ String

Output only. The current state of the backup. Corresponds to the JSON property state

Returns:

  • (String) 


110
111
112
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 110

def state
  @state
end

#version_time ⇒ String

The backup will contain an externally consistent copy of the database at the timestamp specified by version_time. If version_time is not specified, the system will set version_time to the create_time of the backup. Corresponds to the JSON property versionTime

Returns:

  • (String) 


117
118
119
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 117

def version_time
  @version_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 124

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @database = args[:database] if args.key?(:database)
  @database_dialect = args[:database_dialect] if args.key?(:database_dialect)
  @encryption_info = args[:encryption_info] if args.key?(:encryption_info)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @max_expire_time = args[:max_expire_time] if args.key?(:max_expire_time)
  @name = args[:name] if args.key?(:name)
  @referencing_backups = args[:referencing_backups] if args.key?(:referencing_backups)
  @referencing_databases = args[:referencing_databases] if args.key?(:referencing_databases)
  @size_bytes = args[:size_bytes] if args.key?(:size_bytes)
  @state = args[:state] if args.key?(:state)
  @version_time = args[:version_time] if args.key?(:version_time)
end