Class: Google::Cloud::Spanner::Admin::Database::V1::Backup

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/spanner/admin/database/v1/backup.rb

Overview

A backup of a Cloud Spanner database.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#backup_schedules ⇒ ::Array<::String> (readonly)

Returns Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups.

To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.

Returns:

  • (::Array<::String>) —

    Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups.

    To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns 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.

Returns:

  • (::Google::Protobuf::Timestamp) —

    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.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#database ⇒ ::String

Returns 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>.

Returns:

  • (::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/<project>/instances/<instance>/databases/<database>.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#database_dialect ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseDialect (readonly)

Returns Output only. The database dialect information for the backup.

Returns:



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#encryption_info ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::EncryptionInfo (readonly)

Returns Output only. The encryption information for the backup.

Returns:



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#encryption_information ⇒ ::Array<::Google::Cloud::Spanner::Admin::Database::V1::EncryptionInfo> (readonly)

Returns Output only. The encryption information for the backup, whether it is protected by one or more KMS keys. The information includes all Cloud KMS key versions used to encrypt the backup. The encryption_status' field inside of eachEncryptionInfo` is not populated. At least one of the key versions must be available for the backup to be restored. If a key version is revoked in the middle of a restore, the restore behavior is undefined.

Returns:

  • (::Array<::Google::Cloud::Spanner::Admin::Database::V1::EncryptionInfo>) —

    Output only. The encryption information for the backup, whether it is protected by one or more KMS keys. The information includes all Cloud KMS key versions used to encrypt the backup. The encryption_status' field inside of eachEncryptionInfo` is not populated. At least one of the key versions must be available for the backup to be restored. If a key version is revoked in the middle of a restore, the restore behavior is undefined.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#exclusive_size_bytes ⇒ ::Integer (readonly)

Returns Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired.

This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field.

Returns:

  • (::Integer) —

    Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired.

    This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#expire_time ⇒ ::Google::Protobuf::Timestamp

Returns 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.

Returns:

  • (::Google::Protobuf::Timestamp) —

    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.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#freeable_size_bytes ⇒ ::Integer (readonly)

Returns Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired.

Returns:

  • (::Integer) —

    Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#incremental_backup_chain_id ⇒ ::String (readonly)

Returns Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup version_time.

Returns:

  • (::String) —

    Output only. Populated only for backups in an incremental backup chain. Backups share the same chain id if and only if they belong to the same incremental backup chain. Use this field to determine which backups are part of the same incremental backup chain. The ordering of backups in the chain can be determined by ordering the backup version_time.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#max_expire_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns 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.

Returns:

  • (::Google::Protobuf::Timestamp) —

    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.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#name ⇒ ::String

Returns 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_\-]*[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>.

Returns:

  • (::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/<project>/instances/<instance>/backups/[a-z][a-z0-9_\-]*[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>.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#oldest_version_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.

Returns:

  • (::Google::Protobuf::Timestamp) —

    Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#referencing_backups ⇒ ::Array<::String> (readonly)

Returns Output only. The names of the destination backups being created by copying this source backup. The backup names are of the form projects/<project>/instances/<instance>/backups/<backup>. 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.

Returns:

  • (::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/<project>/instances/<instance>/backups/<backup>. 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.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#referencing_databases ⇒ ::Array<::String> (readonly)

Returns 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.

Returns:

  • (::Array<::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.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#size_bytes ⇒ ::Integer (readonly)

Returns Output only. Size of the backup in bytes.

Returns:

  • (::Integer) —

    Output only. Size of the backup in bytes.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#state ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::Backup::State (readonly)

Returns Output only. The current state of the backup.

Returns:



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end

#version_time ⇒ ::Google::Protobuf::Timestamp

Returns 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.

Returns:

  • (::Google::Protobuf::Timestamp) —

    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.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'proto_docs/google/spanner/admin/database/v1/backup.rb', line 162

class Backup
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Indicates the current state of the backup.
  module State
    # Not specified.
    STATE_UNSPECIFIED = 0

    # The pending backup is still being created. Operations on the
    # backup may fail with `FAILED_PRECONDITION` in this state.
    CREATING = 1

    # The backup is complete and ready for use.
    READY = 2
  end
end