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

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

Overview

A backup of a Cloud Spanner database.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Backup

Returns a new instance of Backup.



92
93
94
# File 'generated/google/apis/spanner_v1/classes.rb', line 92

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

Instance Attribute Details

#create_timeString

Output only. The backup will contain an externally consistent copy of the database at the timestamp specified by create_time. create_time is approximately the time the CreateBackup request is received. Corresponds to the JSON property createTime

Returns:

  • (String)


35
36
37
# File 'generated/google/apis/spanner_v1/classes.rb', line 35

def create_time
  @create_time
end

#databaseString

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/<project>/instances/<instance>/databases/<database>. Corresponds to the JSON property database

Returns:

  • (String)


44
45
46
# File 'generated/google/apis/spanner_v1/classes.rb', line 44

def database
  @database
end

#expire_timeString

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)


54
55
56
# File 'generated/google/apis/spanner_v1/classes.rb', line 54

def expire_time
  @expire_time
end

#nameString

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/<project>/instances/<instance>/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/<project>/instances/<instance>. Corresponds to the JSON property name

Returns:

  • (String)


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

def name
  @name
end

#referencing_databasesArray<String>

Output only. The names of the restored databases that reference the backup. The database names are of the form projects/<project>/instances/<instance>/databases/<database>. 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>)


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

def referencing_databases
  @referencing_databases
end

#size_bytesFixnum

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

Returns:

  • (Fixnum)


85
86
87
# File 'generated/google/apis/spanner_v1/classes.rb', line 85

def size_bytes
  @size_bytes
end

#stateString

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

Returns:

  • (String)


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

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



97
98
99
100
101
102
103
104
105
# File 'generated/google/apis/spanner_v1/classes.rb', line 97

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @database = args[:database] if args.key?(:database)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @name = args[:name] if args.key?(:name)
  @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)
end