Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Cloud SQL Admin V1 API - Class Google::Cloud::Sql::V1::Backup (v0.1.0)

Reference documentation and code samples for the Cloud SQL Admin V1 API class Google::Cloud::Sql::V1::Backup.

A backup resource.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#backup_interval

def backup_interval() -> ::Google::Type::Interval

Returns

(::Google::Type::Interval) — Output only. This output contains the following values: start_time: All database writes up to this time are available. end_time: Any database writes after this time aren't available.

#backup_kind

def backup_kind() -> ::Google::Cloud::Sql::V1::SqlBackupKind

Returns

(::Google::Cloud::Sql::V1::SqlBackupKind) — Output only. Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.

#backup_run

def backup_run() -> ::String

Returns

(::String) — Output only. The mapping to backup run resource used for IAM validations.

#database_version

def database_version() -> ::Google::Cloud::Sql::V1::SqlDatabaseVersion

Returns

(::Google::Cloud::Sql::V1::SqlDatabaseVersion) — Output only. The database version of the instance of at the time this backup was made.

#description

def description() -> ::String

Returns

(::String) — The description of this backup.

#description=

def description=(value) -> ::String

Parameter

value (::String) — The description of this backup.

Returns

(::String) — The description of this backup.

#error

def error() -> ::Google::Cloud::Sql::V1::OperationError

Returns

(::Google::Cloud::Sql::V1::OperationError) — Output only. Information about why the backup operation fails (for example, when the backup state fails).

#expiry_time

def expiry_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Backup expiration time. A UTC timestamp of when this backup expired.

Note: The following fields are mutually exclusive: expiry_time, ttl_days. If a field in that set is populated, all other fields in the set will automatically be cleared.

#expiry_time=

def expiry_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

value (::Google::Protobuf::Timestamp) — Backup expiration time. A UTC timestamp of when this backup expired.

Note: The following fields are mutually exclusive: expiry_time, ttl_days. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Protobuf::Timestamp) — Backup expiration time. A UTC timestamp of when this backup expired.

Note: The following fields are mutually exclusive: expiry_time, ttl_days. If a field in that set is populated, all other fields in the set will automatically be cleared.

#instance

def instance() -> ::String

Returns

(::String) — The name of the source database instance.

#instance=

def instance=(value) -> ::String

Parameter

value (::String) — The name of the source database instance.

Returns

(::String) — The name of the source database instance.

#instance_deletion_time

def instance_deletion_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Optional. Output only. Timestamp in UTC of when the instance associated with this backup is deleted.

#instance_settings

def instance_settings() -> ::Google::Cloud::Sql::V1::DatabaseInstance

Returns

(::Google::Cloud::Sql::V1::DatabaseInstance) — Optional. Output only. The instance setting of the source instance that's associated with this backup.

#kind

def kind() -> ::String

Returns

(::String) — Output only. This is always sql#backup.

#kms_key

def kms_key() -> ::String

Returns

(::String) — Output only. This output contains the encryption configuration for a backup and the resource name of the KMS key for disk encryption.

#kms_key_version

def kms_key_version() -> ::String

Returns

(::String) — Output only. This output contains the encryption status for a backup and the version of the KMS key that's used to encrypt the Cloud SQL instance.

#location

def location() -> ::String

Returns

(::String) — The storage location of the backups. The location can be multi-regional.

#location=

def location=(value) -> ::String

Parameter

value (::String) — The storage location of the backups. The location can be multi-regional.

Returns

(::String) — The storage location of the backups. The location can be multi-regional.

#max_chargeable_bytes

def max_chargeable_bytes() -> ::Integer

Returns

(::Integer) — Output only. The maximum chargeable bytes for the backup.

#name

def name() -> ::String

Returns

(::String) — Output only. The resource name of the backup. Format: projects/{project}/backups/{backup}.

#satisfies_pzi

def satisfies_pzi() -> ::Google::Protobuf::BoolValue

Returns

(::Google::Protobuf::BoolValue) — Output only. This status indicates whether the backup satisfies PZI.

The status is reserved for future use.

#satisfies_pzs

def satisfies_pzs() -> ::Google::Protobuf::BoolValue

Returns

(::Google::Protobuf::BoolValue) — Output only. This status indicates whether the backup satisfies PZS.

The status is reserved for future use.

#self_link

def self_link() -> ::String

Returns

(::String) — Output only. The URI of this resource.

#state

def state() -> ::Google::Cloud::Sql::V1::Backup::SqlBackupState

Returns

(::Google::Cloud::Sql::V1::Backup::SqlBackupState) — Output only. The status of this backup.

#time_zone

def time_zone() -> ::String

Returns

(::String) — Output only. This output contains a backup time zone. If a Cloud SQL for SQL Server instance has a different time zone from the backup's time zone, then the restore to the instance doesn't happen.

#ttl_days

def ttl_days() -> ::Integer

Returns

(::Integer) — Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created.

Note: The following fields are mutually exclusive: ttl_days, expiry_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

#ttl_days=

def ttl_days=(value) -> ::Integer

Parameter

value (::Integer) — Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created.

Note: The following fields are mutually exclusive: ttl_days, expiry_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Integer) — Input only. The time-to-live (TTL) interval for this resource (in days). For example: ttlDays:7, means 7 days from the current time. The expiration time can't exceed 365 days from the time that the backup is created.

Note: The following fields are mutually exclusive: ttl_days, expiry_time. If a field in that set is populated, all other fields in the set will automatically be cleared.

#type

def type() -> ::Google::Cloud::Sql::V1::Backup::SqlBackupType

Returns

(::Google::Cloud::Sql::V1::Backup::SqlBackupType) — Output only. The type of this backup. The type can be "AUTOMATED", "ON_DEMAND" or “FINAL”.