Reference documentation and code samples for the Cloud SQL Admin V1 API class Google::Cloud::Sql::V1::BlueGreenDeployment.
A BlueGreenDeployment resource represents a Cloud SQL blue-green deployment
setup.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
-
(::Google::Protobuf::Timestamp) — Output only. The time when the deployment was created.
Example:
2024-01-01T00:00:00Z
#deployment_mappings
def deployment_mappings() -> ::Array<::Google::Cloud::Sql::V1::BlueGreenDeployment::SourceTargetPairedNode>
Returns
- (::Array<::Google::Cloud::Sql::V1::BlueGreenDeployment::SourceTargetPairedNode>) — Output only. A list representing the pairs of source and target instances in the deployment.
#deployment_tasks
def deployment_tasks() -> ::Google::Cloud::Sql::V1::BlueGreenDeployment::DeploymentTasks
Returns
- (::Google::Cloud::Sql::V1::BlueGreenDeployment::DeploymentTasks) — Output only. Combined list of tasks for all paired nodes.
#description
def description() -> ::String
Returns
- (::String) — Optional. User-provided description for the deployment. The description can be up to 255 characters long.
#description=
def description=(value) -> ::String
Parameter
- value (::String) — Optional. User-provided description for the deployment. The description can be up to 255 characters long.
Returns
- (::String) — Optional. User-provided description for the deployment. The description can be up to 255 characters long.
#error_detail
def error_detail() -> ::String
Returns
-
(::String) — Output only. Provides details on why switchover is not possible.
This field is empty unless a switchover attempt failed or the state is
SWITCHOVER_NOT_READY. Example: "The target database version does not match the source instance database version."
#name
def name() -> ::String
Returns
- (::String) — Output only. Identifier. The full resource name of the deployment. Format: projects/{project}/locations/{location}/blueGreenDeployments/{deployment_id}
#requested_config
def requested_config() -> ::Google::Cloud::Sql::V1::BlueGreenDeployment::RequestedConfig
Returns
- (::Google::Cloud::Sql::V1::BlueGreenDeployment::RequestedConfig) — Optional. Immutable. Optional on create, and immutable. The configuration intended for the target instance(s) when the deployment was created.
#requested_config=
def requested_config=(value) -> ::Google::Cloud::Sql::V1::BlueGreenDeployment::RequestedConfig
Parameter
- value (::Google::Cloud::Sql::V1::BlueGreenDeployment::RequestedConfig) — Optional. Immutable. Optional on create, and immutable. The configuration intended for the target instance(s) when the deployment was created.
Returns
- (::Google::Cloud::Sql::V1::BlueGreenDeployment::RequestedConfig) — Optional. Immutable. Optional on create, and immutable. The configuration intended for the target instance(s) when the deployment was created.
#source_instance
def source_instance() -> ::String
Returns
- (::String) — Required. Immutable. Required on create, and immutable. The full resource name of the source instance (the "blue" instance). Format: projects/{project}/instances/{instance}
#source_instance=
def source_instance=(value) -> ::String
Parameter
- value (::String) — Required. Immutable. Required on create, and immutable. The full resource name of the source instance (the "blue" instance). Format: projects/{project}/instances/{instance}
Returns
- (::String) — Required. Immutable. Required on create, and immutable. The full resource name of the source instance (the "blue" instance). Format: projects/{project}/instances/{instance}
#state
def state() -> ::Google::Cloud::Sql::V1::BlueGreenDeployment::State
Returns
- (::Google::Cloud::Sql::V1::BlueGreenDeployment::State) — Output only. The current state of the blue-green deployment.
#switchover_target_instance
def switchover_target_instance() -> ::String
Returns
- (::String) — Output only. The full resource name of the primary target instance (the "green" instance) that will be promoted during switchover. This field is always populated once the deployment is created. Format: projects/{project}/instances/{instance}