Reference documentation and code samples for the Cloud SQL Admin V1 API class Google::Cloud::Sql::V1::BackupRun.
A BackupRun resource.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#backup_kind
def backup_kind() -> ::Google::Cloud::Sql::V1::SqlBackupKind
Returns
- (::Google::Cloud::Sql::V1::SqlBackupKind) — Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
#backup_kind=
def backup_kind=(value) -> ::Google::Cloud::Sql::V1::SqlBackupKind
Parameter
- value (::Google::Cloud::Sql::V1::SqlBackupKind) — Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
Returns
- (::Google::Cloud::Sql::V1::SqlBackupKind) — Specifies the kind of backup, PHYSICAL or DEFAULT_SNAPSHOT.
#database_version
def database_version() -> ::Google::Cloud::Sql::V1::SqlDatabaseVersion
Returns
- (::Google::Cloud::Sql::V1::SqlDatabaseVersion) — Output only. The instance database version at the time this backup was made.
#description
def description() -> ::String
Returns
- (::String) — The description of this run, only applicable to on-demand backups.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — The description of this run, only applicable to on-demand backups.
Returns
- (::String) — The description of this run, only applicable to on-demand backups.
#disk_encryption_configuration
def disk_encryption_configuration() -> ::Google::Cloud::Sql::V1::DiskEncryptionConfiguration
Returns
- (::Google::Cloud::Sql::V1::DiskEncryptionConfiguration) — Encryption configuration specific to a backup.
#disk_encryption_configuration=
def disk_encryption_configuration=(value) -> ::Google::Cloud::Sql::V1::DiskEncryptionConfiguration
Parameter
- value (::Google::Cloud::Sql::V1::DiskEncryptionConfiguration) — Encryption configuration specific to a backup.
Returns
- (::Google::Cloud::Sql::V1::DiskEncryptionConfiguration) — Encryption configuration specific to a backup.
#disk_encryption_status
def disk_encryption_status() -> ::Google::Cloud::Sql::V1::DiskEncryptionStatus
Returns
- (::Google::Cloud::Sql::V1::DiskEncryptionStatus) — Encryption status specific to a backup.
#disk_encryption_status=
def disk_encryption_status=(value) -> ::Google::Cloud::Sql::V1::DiskEncryptionStatus
Parameter
- value (::Google::Cloud::Sql::V1::DiskEncryptionStatus) — Encryption status specific to a backup.
Returns
- (::Google::Cloud::Sql::V1::DiskEncryptionStatus) — Encryption status specific to a backup.
#end_time
def end_time() -> ::Google::Protobuf::Timestamp
Returns
-
(::Google::Protobuf::Timestamp) — The time the backup operation completed in UTC timezone in
RFC 3339 format, for example
2012-11-15T16:19:00.094Z.
#end_time=
def end_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
-
value (::Google::Protobuf::Timestamp) — The time the backup operation completed in UTC timezone in
RFC 3339 format, for example
2012-11-15T16:19:00.094Z.
Returns
-
(::Google::Protobuf::Timestamp) — The time the backup operation completed in UTC timezone in
RFC 3339 format, for example
2012-11-15T16:19:00.094Z.
#enqueued_time
def enqueued_time() -> ::Google::Protobuf::Timestamp
Returns
-
(::Google::Protobuf::Timestamp) — The time the run was enqueued in UTC timezone in
RFC 3339 format, for example
2012-11-15T16:19:00.094Z.
#enqueued_time=
def enqueued_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
-
value (::Google::Protobuf::Timestamp) — The time the run was enqueued in UTC timezone in
RFC 3339 format, for example
2012-11-15T16:19:00.094Z.
Returns
-
(::Google::Protobuf::Timestamp) — The time the run was enqueued in UTC timezone in
RFC 3339 format, for example
2012-11-15T16:19:00.094Z.
#error
def error() -> ::Google::Cloud::Sql::V1::OperationError
Returns
- (::Google::Cloud::Sql::V1::OperationError) — Information about why the backup operation failed. This is only present if the run has the FAILED status.
#error=
def error=(value) -> ::Google::Cloud::Sql::V1::OperationError
Parameter
- value (::Google::Cloud::Sql::V1::OperationError) — Information about why the backup operation failed. This is only present if the run has the FAILED status.
Returns
- (::Google::Cloud::Sql::V1::OperationError) — Information about why the backup operation failed. This is only present if the run has the FAILED status.
#id
def id() -> ::Integer
Returns
- (::Integer) — The identifier for this backup run. Unique only for a specific Cloud SQL instance.
#id=
def id=(value) -> ::Integer
Parameter
- value (::Integer) — The identifier for this backup run. Unique only for a specific Cloud SQL instance.
Returns
- (::Integer) — The identifier for this backup run. Unique only for a specific Cloud SQL instance.
#instance
def instance() -> ::String
Returns
- (::String) — Name of the database instance.
#instance=
def instance=(value) -> ::String
Parameter
- value (::String) — Name of the database instance.
Returns
- (::String) — Name of the database instance.
#kind
def kind() -> ::String
Returns
-
(::String) — This is always
sql#backupRun.
#kind=
def kind=(value) -> ::String
Parameter
-
value (::String) — This is always
sql#backupRun.
Returns
-
(::String) — This is always
sql#backupRun.
#location
def location() -> ::String
Returns
- (::String) — Location of the backups.
#location=
def location=(value) -> ::String
Parameter
- value (::String) — Location of the backups.
Returns
- (::String) — Location of the backups.
#max_chargeable_bytes
def max_chargeable_bytes() -> ::Integer
Returns
- (::Integer) — Output only. The maximum chargeable bytes for the backup.
#self_link
def self_link() -> ::String
Returns
- (::String) — The URI of this resource.
#self_link=
def self_link=(value) -> ::String
Parameter
- value (::String) — The URI of this resource.
Returns
- (::String) — The URI of this resource.
#start_time
def start_time() -> ::Google::Protobuf::Timestamp
Returns
-
(::Google::Protobuf::Timestamp) — The time the backup operation actually started in UTC timezone in
RFC 3339 format, for example
2012-11-15T16:19:00.094Z.
#start_time=
def start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
-
value (::Google::Protobuf::Timestamp) — The time the backup operation actually started in UTC timezone in
RFC 3339 format, for example
2012-11-15T16:19:00.094Z.
Returns
-
(::Google::Protobuf::Timestamp) — The time the backup operation actually started in UTC timezone in
RFC 3339 format, for example
2012-11-15T16:19:00.094Z.
#status
def status() -> ::Google::Cloud::Sql::V1::SqlBackupRunStatus
Returns
- (::Google::Cloud::Sql::V1::SqlBackupRunStatus) — The status of this run.
#status=
def status=(value) -> ::Google::Cloud::Sql::V1::SqlBackupRunStatus
Parameter
- value (::Google::Cloud::Sql::V1::SqlBackupRunStatus) — The status of this run.
Returns
- (::Google::Cloud::Sql::V1::SqlBackupRunStatus) — The status of this run.
#time_zone
def time_zone() -> ::String
Returns
- (::String) — Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
#time_zone=
def time_zone=(value) -> ::String
Parameter
- value (::String) — Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
Returns
- (::String) — Backup time zone to prevent restores to an instance with a different time zone. Now relevant only for SQL Server.
#type
def type() -> ::Google::Cloud::Sql::V1::SqlBackupRunType
Returns
- (::Google::Cloud::Sql::V1::SqlBackupRunType) — The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
#type=
def type=(value) -> ::Google::Cloud::Sql::V1::SqlBackupRunType
Parameter
- value (::Google::Cloud::Sql::V1::SqlBackupRunType) — The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
Returns
- (::Google::Cloud::Sql::V1::SqlBackupRunType) — The type of this run; can be either "AUTOMATED" or "ON_DEMAND" or "FINAL". This field defaults to "ON_DEMAND" and is ignored, when specified for insert requests.
#window_start_time
def window_start_time() -> ::Google::Protobuf::Timestamp
Returns
-
(::Google::Protobuf::Timestamp) — The start time of the backup window during which this the backup was
attempted in RFC 3339 format, for
example
2012-11-15T16:19:00.094Z.
#window_start_time=
def window_start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
-
value (::Google::Protobuf::Timestamp) — The start time of the backup window during which this the backup was
attempted in RFC 3339 format, for
example
2012-11-15T16:19:00.094Z.
Returns
-
(::Google::Protobuf::Timestamp) — The start time of the backup window during which this the backup was
attempted in RFC 3339 format, for
example
2012-11-15T16:19:00.094Z.