Reference documentation and code samples for the Cloud SQL Admin V1 API class Google::Cloud::Sql::V1::Operation.
An Operation resource. For successful operations that return an Operation resource, only the fields relevant to the operation are populated in the resource.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#acquire_ssrs_lease_context
def acquire_ssrs_lease_context() -> ::Google::Cloud::Sql::V1::AcquireSsrsLeaseContext
Returns
- (::Google::Cloud::Sql::V1::AcquireSsrsLeaseContext) — The context for acquire SSRS lease operation, if applicable.
#acquire_ssrs_lease_context=
def acquire_ssrs_lease_context=(value) -> ::Google::Cloud::Sql::V1::AcquireSsrsLeaseContext
Parameter
- value (::Google::Cloud::Sql::V1::AcquireSsrsLeaseContext) — The context for acquire SSRS lease operation, if applicable.
Returns
- (::Google::Cloud::Sql::V1::AcquireSsrsLeaseContext) — The context for acquire SSRS lease operation, if applicable.
#api_warning
def api_warning() -> ::Google::Cloud::Sql::V1::ApiWarning
Returns
- (::Google::Cloud::Sql::V1::ApiWarning) — An Admin API warning message.
#api_warning=
def api_warning=(value) -> ::Google::Cloud::Sql::V1::ApiWarning
Parameter
- value (::Google::Cloud::Sql::V1::ApiWarning) — An Admin API warning message.
Returns
- (::Google::Cloud::Sql::V1::ApiWarning) — An Admin API warning message.
#backup_context
def backup_context() -> ::Google::Cloud::Sql::V1::BackupContext
Returns
- (::Google::Cloud::Sql::V1::BackupContext) — The context for backup operation, if applicable.
#backup_context=
def backup_context=(value) -> ::Google::Cloud::Sql::V1::BackupContext
Parameter
- value (::Google::Cloud::Sql::V1::BackupContext) — The context for backup operation, if applicable.
Returns
- (::Google::Cloud::Sql::V1::BackupContext) — The context for backup operation, if applicable.
#end_time
def end_time() -> ::Google::Protobuf::Timestamp
Returns
-
(::Google::Protobuf::Timestamp) — The time this operation finished 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 this operation finished in UTC timezone in RFC
3339 format, for example
2012-11-15T16:19:00.094Z.
Returns
-
(::Google::Protobuf::Timestamp) — The time this operation finished in UTC timezone in RFC
3339 format, for example
2012-11-15T16:19:00.094Z.
#error
def error() -> ::Google::Cloud::Sql::V1::OperationErrors
Returns
- (::Google::Cloud::Sql::V1::OperationErrors) — If errors occurred during processing of this operation, this field will be populated.
#error=
def error=(value) -> ::Google::Cloud::Sql::V1::OperationErrors
Parameter
- value (::Google::Cloud::Sql::V1::OperationErrors) — If errors occurred during processing of this operation, this field will be populated.
Returns
- (::Google::Cloud::Sql::V1::OperationErrors) — If errors occurred during processing of this operation, this field will be populated.
#export_context
def export_context() -> ::Google::Cloud::Sql::V1::ExportContext
Returns
- (::Google::Cloud::Sql::V1::ExportContext) — The context for export operation, if applicable.
#export_context=
def export_context=(value) -> ::Google::Cloud::Sql::V1::ExportContext
Parameter
- value (::Google::Cloud::Sql::V1::ExportContext) — The context for export operation, if applicable.
Returns
- (::Google::Cloud::Sql::V1::ExportContext) — The context for export operation, if applicable.
#import_context
def import_context() -> ::Google::Cloud::Sql::V1::ImportContext
Returns
- (::Google::Cloud::Sql::V1::ImportContext) — The context for import operation, if applicable.
#import_context=
def import_context=(value) -> ::Google::Cloud::Sql::V1::ImportContext
Parameter
- value (::Google::Cloud::Sql::V1::ImportContext) — The context for import operation, if applicable.
Returns
- (::Google::Cloud::Sql::V1::ImportContext) — The context for import operation, if applicable.
#insert_time
def insert_time() -> ::Google::Protobuf::Timestamp
Returns
-
(::Google::Protobuf::Timestamp) — The time this operation was enqueued in UTC timezone in RFC
3339 format, for example
2012-11-15T16:19:00.094Z.
#insert_time=
def insert_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
-
value (::Google::Protobuf::Timestamp) — The time this operation was enqueued in UTC timezone in RFC
3339 format, for example
2012-11-15T16:19:00.094Z.
Returns
-
(::Google::Protobuf::Timestamp) — The time this operation was enqueued in UTC timezone in RFC
3339 format, for example
2012-11-15T16:19:00.094Z.
#kind
def kind() -> ::String
Returns
-
(::String) — This is always
sql#operation.
#kind=
def kind=(value) -> ::String
Parameter
-
value (::String) — This is always
sql#operation.
Returns
-
(::String) — This is always
sql#operation.
#name
def name() -> ::String
Returns
- (::String) — An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
#name=
def name=(value) -> ::String
Parameter
- value (::String) — An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
Returns
- (::String) — An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
#operation_type
def operation_type() -> ::Google::Cloud::Sql::V1::Operation::SqlOperationType
Returns
-
(::Google::Cloud::Sql::V1::Operation::SqlOperationType) —
The type of the operation. Valid values are:
-
CREATE -
DELETE -
UPDATE -
RESTART -
IMPORT -
EXPORT -
BACKUP_VOLUME -
RESTORE_VOLUME -
CREATE_USER -
DELETE_USER -
CREATE_DATABASE -
DELETE_DATABASE
-
#operation_type=
def operation_type=(value) -> ::Google::Cloud::Sql::V1::Operation::SqlOperationType
Parameter
-
value (::Google::Cloud::Sql::V1::Operation::SqlOperationType) —
The type of the operation. Valid values are:
-
CREATE -
DELETE -
UPDATE -
RESTART -
IMPORT -
EXPORT -
BACKUP_VOLUME -
RESTORE_VOLUME -
CREATE_USER -
DELETE_USER -
CREATE_DATABASE -
DELETE_DATABASE
-
Returns
-
(::Google::Cloud::Sql::V1::Operation::SqlOperationType) —
The type of the operation. Valid values are:
-
CREATE -
DELETE -
UPDATE -
RESTART -
IMPORT -
EXPORT -
BACKUP_VOLUME -
RESTORE_VOLUME -
CREATE_USER -
DELETE_USER -
CREATE_DATABASE -
DELETE_DATABASE
-
#pre_check_major_version_upgrade_context
def pre_check_major_version_upgrade_context() -> ::Google::Cloud::Sql::V1::PreCheckMajorVersionUpgradeContext
Returns
- (::Google::Cloud::Sql::V1::PreCheckMajorVersionUpgradeContext) — This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
#pre_check_major_version_upgrade_context=
def pre_check_major_version_upgrade_context=(value) -> ::Google::Cloud::Sql::V1::PreCheckMajorVersionUpgradeContext
Parameter
- value (::Google::Cloud::Sql::V1::PreCheckMajorVersionUpgradeContext) — This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
Returns
- (::Google::Cloud::Sql::V1::PreCheckMajorVersionUpgradeContext) — This field is only populated when the operation_type is PRE_CHECK_MAJOR_VERSION_UPGRADE. The PreCheckMajorVersionUpgradeContext message itself contains the details for that pre-check, such as the target database version for the upgrade and the results of the check (including any warnings or errors found).
#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 this 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 this operation actually started in UTC timezone in RFC
3339 format, for example
2012-11-15T16:19:00.094Z.
Returns
-
(::Google::Protobuf::Timestamp) — The time this 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::Operation::SqlOperationStatus
Returns
- (::Google::Cloud::Sql::V1::Operation::SqlOperationStatus) — The status of an operation.
#status=
def status=(value) -> ::Google::Cloud::Sql::V1::Operation::SqlOperationStatus
Parameter
- value (::Google::Cloud::Sql::V1::Operation::SqlOperationStatus) — The status of an operation.
Returns
- (::Google::Cloud::Sql::V1::Operation::SqlOperationStatus) — The status of an operation.
#sub_operation_type
def sub_operation_type() -> ::Google::Cloud::Sql::V1::SqlSubOperationType
Returns
- (::Google::Cloud::Sql::V1::SqlSubOperationType) — Optional. The sub operation based on the operation type.
#sub_operation_type=
def sub_operation_type=(value) -> ::Google::Cloud::Sql::V1::SqlSubOperationType
Parameter
- value (::Google::Cloud::Sql::V1::SqlSubOperationType) — Optional. The sub operation based on the operation type.
Returns
- (::Google::Cloud::Sql::V1::SqlSubOperationType) — Optional. The sub operation based on the operation type.
#target_id
def target_id() -> ::String
Returns
- (::String) — Name of the resource on which this operation runs.
#target_id=
def target_id=(value) -> ::String
Parameter
- value (::String) — Name of the resource on which this operation runs.
Returns
- (::String) — Name of the resource on which this operation runs.
#target_link
def target_link() -> ::String
Returns
- (::String)
#target_link=
def target_link=(value) -> ::String
Parameter
- value (::String)
Returns
- (::String)
#target_project
def target_project() -> ::String
Returns
- (::String) — The project ID of the target instance related to this operation.
#target_project=
def target_project=(value) -> ::String
Parameter
- value (::String) — The project ID of the target instance related to this operation.
Returns
- (::String) — The project ID of the target instance related to this operation.
#user
def user() -> ::String
Returns
- (::String) — The email address of the user who initiated this operation.
#user=
def user=(value) -> ::String
Parameter
- value (::String) — The email address of the user who initiated this operation.
Returns
- (::String) — The email address of the user who initiated this operation.