google-cloud-sql-v1beta4 0.2.0 → 0.3.0

data/proto_docs/google/cloud/sql/v1beta4/cloud_sql_blue_green_deployments.rb

@@ -0,0 +1,428 @@
+# frozen_string_literal: true
+
+# Copyright 2026 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Sql
+      module V1beta4
+        # A `BlueGreenDeployment` resource represents a Cloud SQL blue-green deployment
+        # setup. It orchestrates the lifecycle of creating a synchronized "green"
+        # environment from a "blue" production environment, performing updates, and
+        # managing the switchover process to minimize downtime.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. Identifier. The full resource name of the deployment.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/blueGreenDeployments/\\{deployment_id}
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. User-provided description for the deployment.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The time when the deployment was created.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::State]
+        #     Output only. The current state of the blue-green deployment.
+        # @!attribute [rw] source_instance
+        #   @return [::String]
+        #     Required. Immutable. The instance ID of the source instance (the "blue"
+        #     instance). The value for this field does not include the project ID, for
+        #     example, `my-instance-id`. This field is immutable.
+        # @!attribute [rw] target_config
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::TargetConfig]
+        #     Optional. Immutable. Deprecated: Use requested_config instead.
+        #     The configuration intended for the target instance(s) when the deployment
+        #     was created. This field is immutable.
+        # @!attribute [r] switchover_target_instance
+        #   @return [::String]
+        #     Output only. Details about the primary target instance (the "Green"
+        #     instance) that will be promoted during switchover.
+        # @!attribute [r] paired_nodes
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::Array<::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::SourceTargetPairedNode>]
+        #     Output only. Deprecated: Use deployment_mappings instead.
+        #     Output only. A list representing the pairs of source and target instances
+        #     in the deployment.
+        # @!attribute [r] error_detail
+        #   @return [::String]
+        #     Output only. Provides an error message with details on why switchover is
+        #     not possible.
+        # @!attribute [r] deployment_mappings
+        #   @return [::Array<::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::SourceTargetPairedNode>]
+        #     Output only. A list representing the pairs of source and target instances
+        #     in the deployment.
+        # @!attribute [r] deployment_tasks
+        #   @return [::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::DeploymentTasks]
+        #     Output only. Combined list of tasks for all paired nodes.
+        # @!attribute [rw] requested_config
+        #   @return [::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::RequestedConfig]
+        #     Optional. Immutable. Optional on create, and immutable. The configuration
+        #     intended for the target instance(s) when the deployment was created.
+        class BlueGreenDeployment
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Deprecated: Use RequestedConfig instead.
+          # Configuration specified by the user at creation time for the target (Green)
+          # instance.
+          # @deprecated This message is deprecated and may be removed in the next major version update.
+          # @!attribute [rw] database_version
+          #   @return [::String]
+          #     Optional. The target database major version for the upgrade.
+          class TargetConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Combined list of tasks for all paired nodes in the deployment.
+          # @!attribute [r] task
+          #   @return [::Array<::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::SourceTargetPairedNode::DeploymentTask>]
+          #     Output only. Tasks performed or being performed on the paired nodes
+          #     of the deployment at a consolidated level.
+          class DeploymentTasks
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration specified by the user at creation time for the target (Green)
+          # instance.
+          # @!attribute [rw] database_version
+          #   @return [::String]
+          #     Optional. The target database major version for the upgrade.
+          class RequestedConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Represents a pairing of a source instance node and a target instance node.
+          # @!attribute [r] source
+          #   @return [::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::SourceTargetPairedNode::NodeInfo]
+          #     Output only. Resource name of the source instance in this pair.
+          # @!attribute [r] target
+          #   @return [::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::SourceTargetPairedNode::NodeInfo]
+          #     Output only. Details of the corresponding target instance in this pair.
+          # @!attribute [r] state
+          #   @return [::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::SourceTargetPairedNode::State]
+          #     Output only. The current state of this specific source-target pair.
+          # @!attribute [r] currently_serving_traffic
+          #   @deprecated This field is deprecated and may be removed in the next major version update.
+          #   @return [::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::SourceTargetPairedNode::CurrentlyServingTraffic]
+          #     Output only. Deprecated: Indicates which instance (SOURCE or TARGET) in
+          #     the pair is currently live. Used for internal implementation and
+          #     deprecated for external use.
+          # @!attribute [r] tasks
+          #   @return [::Array<::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::SourceTargetPairedNode::DeploymentTask>]
+          #     Output only. Tasks performed or being performed on the target instance of
+          #     this pair.
+          # @!attribute [r] diffs
+          #   @return [::Array<::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::SourceTargetPairedNode::ConfigDiff>]
+          #     Output only. Describes the list of differences for this pair.
+          class SourceTargetPairedNode
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Details about an instance within the deployment.
+            # @!attribute [r] instance
+            #   @return [::String]
+            #     Output only. The full resource name of the instance.
+            #     Format: projects/\\{project}/instances/\\{instance}
+            # @!attribute [r] connection
+            #   @return [::String]
+            #     Output only. The instance connection name.
+            # @!attribute [r] dns
+            #   @return [::String]
+            #     Output only. The unique DNS name for this instance.
+            # @!attribute [r] ip_mappings
+            #   @return [::Array<::Google::Cloud::Sql::V1beta4::IpMapping>]
+            #     Output only. The list of IP addresses for this instance.
+            class NodeInfo
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # Represents a task executed as part of the deployment on a target
+            # instance.
+            # @!attribute [r] type
+            #   @return [::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::SourceTargetPairedNode::DeploymentTask::Type]
+            #     Output only. The type of the task.
+            # @!attribute [r] state
+            #   @return [::Google::Cloud::Sql::V1beta4::BlueGreenDeployment::SourceTargetPairedNode::DeploymentTask::State]
+            #     Output only. The current state of the task.
+            # @!attribute [r] start_time
+            #   @return [::Google::Protobuf::Timestamp]
+            #     Output only. Task start time.
+            # @!attribute [r] end_time
+            #   @return [::Google::Protobuf::Timestamp]
+            #     Output only. Task end time (if completed).
+            # @!attribute [r] error_message
+            #   @return [::String]
+            #     Output only. Optional Error details if the task state is FAILED.
+            class DeploymentTask
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+
+              # The type of the task.
+              # This enum is not frozen, and new values may be added in the future.
+              module Type
+                # The default value. This value is used if the type is omitted.
+                TYPE_UNSPECIFIED = 0
+
+                # Creating target instance.
+                PROVISION = 1
+
+                # e.g., Major Version Upgrade on Target.
+                UPGRADE = 2
+
+                # Promoting Target, Demoting Source for this pair.
+                SWITCHOVER = 3
+
+                # The task is to delete deployment.
+                DELETE = 4
+
+                # Post-switchover operations, including cleaning up resources of the
+                # old instance, taking final backups, and updating metadata.
+                POST_SWITCHOVER_OPERATIONS = 5
+              end
+
+              # The state of the task.
+              # This enum is not frozen, and new values may be added in the future.
+              module State
+                # The state of the task is unknown.
+                STATE_UNSPECIFIED = 0
+
+                # The task is pending.
+                PENDING = 1
+
+                # The task is running.
+                RUNNING = 2
+
+                # The task has succeeded.
+                SUCCEEDED = 3
+
+                # The task has failed.
+                FAILED = 4
+              end
+            end
+
+            # Represents a specific configuration difference between Blue and Green
+            # instances.
+            # @!attribute [r] field
+            #   @return [::String]
+            #     Output only. The name of the field that differs, fully-qualified.
+            #     Example: settings.tier
+            # @!attribute [r] source_value
+            #   @return [::String]
+            #     Output only. The value on the source instance.
+            # @!attribute [r] target_value
+            #   @return [::String]
+            #     Output only. The value on the target instance.
+            class ConfigDiff
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # The state of a pair of source and target instances in deployment (paired
+            # node).
+            module State
+              # The state of the paired node is unknown.
+              STATE_UNSPECIFIED = 0
+
+              # The paired node is being provisioned.
+              PROVISIONING = 1
+
+              # The paired node is provisioned.
+              PROVISIONED = 2
+
+              # The paired node is upgrading.
+              UPGRADING = 3
+
+              # The paired node is upgraded.
+              UPGRADED = 4
+
+              # Upgrade failed on the paired node.
+              UPGRADE_FAILED = 5
+
+              # Switchover is in progress.
+              SWITCHOVER_IN_PROGRESS = 6
+
+              # Switchover failed on the paired node.
+              SWITCHOVER_FAILED = 7
+
+              # Switchover completed successfully.
+              SWITCHOVER_SUCCEEDED = 8
+
+              # The paired node is being deleted.
+              DELETING = 11
+            end
+
+            # The instance currently serving traffic.
+            module CurrentlyServingTraffic
+              # The instance serving traffic is unknown.
+              CURRENTLY_SERVING_TRAFFIC_UNSPECIFIED = 0
+
+              # The source instance is serving traffic.
+              SOURCE = 1
+
+              # The target instance is serving traffic.
+              TARGET = 2
+            end
+          end
+
+          # The state of the blue-green deployment.
+          # This enum is not frozen, and new values may be added in the future.
+          module State
+            # The state of the deployment is unknown.
+            STATE_UNSPECIFIED = 0
+
+            # The deployment is being provisioned.
+            PROVISIONING = 1
+
+            # The deployment is ready for switchover.
+            SWITCHOVER_READY = 2
+
+            # The deployment is not ready for switchover.
+            SWITCHOVER_NOT_READY = 3
+
+            # The deployment is in the process of switching over.
+            SWITCHOVER_IN_PROGRESS = 4
+
+            # The deployment has completed switchover.
+            SWITCHOVER_COMPLETED = 5
+
+            # The deployment is being deleted.
+            DELETING = 6
+          end
+        end
+
+        # The request message for creating a `BlueGreenDeployment` resource.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource where this blue-green deployment will be
+        #     created. Format: projects/\\{project}/locations/\\{location}
+        # @!attribute [rw] blue_green_deployment_id
+        #   @return [::String]
+        #     Required. The ID to use for the blue-green deployment, which will become
+        #     the final component of the deployment's resource name.
+        # @!attribute [rw] blue_green_deployment
+        #   @return [::Google::Cloud::Sql::V1beta4::BlueGreenDeployment]
+        #     Required. The `BlueGreenDeployment` resource to create.
+        class CreateBlueGreenDeploymentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request message for getting a `BlueGreenDeployment` resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the blue-green deployment to retrieve.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/blueGreenDeployments/\\{blue_green_deployment}
+        # @!attribute [rw] view
+        #   @return [::Google::Cloud::Sql::V1beta4::GetBlueGreenDeploymentRequest::BlueGreenDeploymentView]
+        #     Optional. Specifies whether to return the basic or detailed view of the
+        #     resource in the response.
+        class GetBlueGreenDeploymentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The view of a `BlueGreenDeployment` resource.
+          module BlueGreenDeploymentView
+            # Blue-green deployment view enumeration. This allows the caller to specify
+            # what view they query. If unspecified
+            # (BLUE_GREEN_DEPLOYMENT_VIEW_UNSPECIFIED), the behavior is the same as
+            # BASIC.
+            BLUE_GREEN_DEPLOYMENT_VIEW_UNSPECIFIED = 0
+
+            # Includes basic metadata about the blue-green deployment.
+            # `BASIC` is the default view.
+            BASIC = 1
+
+            # Includes basic metadata and configuration differences between source and
+            # target instances (`database_version`, `tier`, `edition`,
+            # `availability_type`, `data_disk_size_gb`, and `data_disk_type`).
+            DETAILED = 2
+          end
+        end
+
+        # The request message for listing blue-green deployment resources.
+        # @!attribute [rw] parent
+        #   @return [::String]
+        #     Required. The parent resource whose blue-green deployments are to be
+        #     listed. Format: projects/\\{project}/locations/\\{location}
+        # @!attribute [rw] page_size
+        #   @return [::Integer]
+        #     Optional. The maximum number of deployments to return.
+        # @!attribute [rw] page_token
+        #   @return [::String]
+        #     Optional. A page token, received from a previous `ListBlueGreenDeployments`
+        #     call. Provide this to retrieve the subsequent page.
+        # @!attribute [rw] filter
+        #   @return [::String]
+        #     Optional. A filter expression that filters the results.
+        # @!attribute [rw] order_by
+        #   @return [::String]
+        #     Optional. A comma-separated list of fields to order the results by.
+        class ListBlueGreenDeploymentsRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for switching over a `BlueGreenDeployment` resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the blue-green deployment to switch over.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/blueGreenDeployments/\\{blue_green_deployment}
+        class SwitchoverBlueGreenDeploymentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Request message for deleting a `BlueGreenDeployment` resource.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Required. The name of the blue-green deployment to delete.
+        #     Format:
+        #     projects/\\{project}/locations/\\{location}/blueGreenDeployments/\\{blue_green_deployment}
+        # @!attribute [rw] delete_old_source
+        #   @return [::Boolean]
+        #     Optional. If set to true, and the switchover is complete, this deletes the
+        #     old source instance along with the deployment.
+        class DeleteBlueGreenDeploymentRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response message for listing blue-green deployment resources.
+        # @!attribute [rw] blue_green_deployments
+        #   @return [::Array<::Google::Cloud::Sql::V1beta4::BlueGreenDeployment>]
+        #     The list of blue-green deployment resources.
+        # @!attribute [rw] next_page_token
+        #   @return [::String]
+        #     A token to retrieve the next page of results, or empty if there are no
+        #     more results.
+        class ListBlueGreenDeploymentsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+      end
+    end
+  end
+end