google-cloud-deploy-v1 0.10.0 → 0.12.0

data/proto_docs/google/cloud/deploy/v1/cloud_deploy.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Deploy
       module V1
-        # A `DeliveryPipeline` resource in the Google Cloud Deploy API.
+        # A `DeliveryPipeline` resource in the Cloud Deploy API.
         #
         # A `DeliveryPipeline` defines a pipeline through which a Skaffold
         # configuration can progress.
@@ -38,12 +38,11 @@ module Google
         # @!attribute [rw] annotations
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     User annotations. These attributes can only be set and used by the
-        #     user, and not by Google Cloud Deploy.
+        #     user, and not by Cloud Deploy.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Labels are attributes that can be set and used by both the
-        #     user and by Google Cloud Deploy. Labels must meet the following
-        #     constraints:
+        #     user and by Cloud Deploy. Labels must meet the following constraints:
         #
         #     * Keys and values can contain only lowercase letters, numeric characters,
         #     underscores, and dashes.
@@ -178,10 +177,38 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Predeploy contains the predeploy job configuration information.
+        # @!attribute [rw] actions
+        #   @return [::Array<::String>]
+        #     Optional. A sequence of skaffold custom actions to invoke during execution
+        #     of the predeploy job.
+        class Predeploy
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Postdeploy contains the postdeploy job configuration information.
+        # @!attribute [rw] actions
+        #   @return [::Array<::String>]
+        #     Optional. A sequence of skaffold custom actions to invoke during execution
+        #     of the postdeploy job.
+        class Postdeploy
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Standard represents the standard deployment strategy.
         # @!attribute [rw] verify
         #   @return [::Boolean]
         #     Whether to verify a deployment.
+        # @!attribute [rw] predeploy
+        #   @return [::Google::Cloud::Deploy::V1::Predeploy]
+        #     Optional. Configuration for the predeploy job. If this is not configured,
+        #     predeploy job will not be present.
+        # @!attribute [rw] postdeploy
+        #   @return [::Google::Cloud::Deploy::V1::Postdeploy]
+        #     Optional. Configuration for the postdeploy job. If this is not configured,
+        #     postdeploy job will not be present.
         class Standard
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -215,6 +242,14 @@ module Google
         # @!attribute [rw] verify
         #   @return [::Boolean]
         #     Whether to run verify tests after each percentage deployment.
+        # @!attribute [rw] predeploy
+        #   @return [::Google::Cloud::Deploy::V1::Predeploy]
+        #     Optional. Configuration for the predeploy job of the first phase. If this
+        #     is not configured, predeploy job will not be present.
+        # @!attribute [rw] postdeploy
+        #   @return [::Google::Cloud::Deploy::V1::Postdeploy]
+        #     Optional. Configuration for the postdeploy job of the last phase. If this
+        #     is not configured, postdeploy job will not be present.
         class CanaryDeployment
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -250,6 +285,14 @@ module Google
           # @!attribute [rw] verify
           #   @return [::Boolean]
           #     Whether to run verify tests after the deployment.
+          # @!attribute [rw] predeploy
+          #   @return [::Google::Cloud::Deploy::V1::Predeploy]
+          #     Optional. Configuration for the predeploy job of this phase. If this is
+          #     not configured, predeploy job will not be present for this phase.
+          # @!attribute [rw] postdeploy
+          #   @return [::Google::Cloud::Deploy::V1::Postdeploy]
+          #     Optional. Configuration for the postdeploy job of this phase. If this is
+          #     not configured, postdeploy job will not be present for this phase.
           class PhaseConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -570,7 +613,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # A `Target` resource in the Google Cloud Deploy API.
+        # A `Target` resource in the Cloud Deploy API.
         #
         # A `Target` defines a location to which a Skaffold configuration
         # can be deployed.
@@ -590,14 +633,13 @@ module Google
         # @!attribute [rw] annotations
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Optional. User annotations. These attributes can only be set and used by
-        #     the user, and not by Google Cloud Deploy. See
+        #     the user, and not by Cloud Deploy. See
         #     https://google.aip.dev/128#annotations for more details such as format and
         #     size limitations.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Optional. Labels are attributes that can be set and used by both the
-        #     user and by Google Cloud Deploy. Labels must meet the following
-        #     constraints:
+        #     user and by Cloud Deploy. Labels must meet the following constraints:
         #
         #     * Keys and values can contain only lowercase letters, numeric characters,
         #     underscores, and dashes.
@@ -726,6 +768,12 @@ module Google
 
             # Use for deployment verification.
             VERIFY = 3
+
+            # Use for predeploy job execution.
+            PREDEPLOY = 4
+
+            # Use for postdeploy job execution.
+            POSTDEPLOY = 5
           end
         end
 
@@ -987,7 +1035,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # A `Release` resource in the Google Cloud Deploy API.
+        # A `Release` resource in the Cloud Deploy API.
         #
         # A `Release` defines a specific Skaffold configuration instance
         # that can be deployed.
@@ -1005,14 +1053,12 @@ module Google
         # @!attribute [rw] annotations
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     User annotations. These attributes can only be set and used by the
-        #     user, and not by Google Cloud Deploy. See
-        #     https://google.aip.dev/128#annotations for more details such as format and
-        #     size limitations.
+        #     user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations
+        #     for more details such as format and size limitations.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Labels are attributes that can be set and used by both the
-        #     user and by Google Cloud Deploy. Labels must meet the following
-        #     constraints:
+        #     user and by Cloud Deploy. Labels must meet the following constraints:
         #
         #     * Keys and values can contain only lowercase letters, numeric characters,
         #     underscores, and dashes.
@@ -1061,8 +1107,8 @@ module Google
         # @!attribute [rw] skaffold_version
         #   @return [::String]
         #     The Skaffold version to use when operating on this release, such as
-        #     "1.20.0". Not all versions are valid; Google Cloud Deploy supports a
-        #     specific set of versions.
+        #     "1.20.0". Not all versions are valid; Cloud Deploy supports a specific set
+        #     of versions.
         #
         #     If unset, the most recent supported Skaffold version will be used.
         # @!attribute [r] target_artifacts
@@ -1128,17 +1174,22 @@ module Google
               FAILURE_CAUSE_UNSPECIFIED = 0
 
               # Cloud Build is not available, either because it is not enabled or
-              # because Google Cloud Deploy has insufficient permissions. See [required
-              # permission](/deploy/docs/cloud-deploy-service-account#required_permissions).
+              # because Cloud Deploy has insufficient permissions. See [required
+              # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
               CLOUD_BUILD_UNAVAILABLE = 1
 
               # The render operation did not complete successfully; check Cloud Build
               # logs.
               EXECUTION_FAILED = 2
 
-              # Cloud Build failed to fulfill Google Cloud Deploy's request. See
+              # Cloud Build failed to fulfill Cloud Deploy's request. See
               # failure_message for additional details.
               CLOUD_BUILD_REQUEST_FAILED = 3
+
+              # The render operation did not complete successfully because the custom
+              # action required for predeploy or postdeploy was not found in the
+              # skaffold configuration. See failure_message for additional details.
+              CUSTOM_ACTION_NOT_FOUND = 5
             end
           end
 
@@ -1439,7 +1490,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # A `Rollout` resource in the Google Cloud Deploy API.
+        # A `Rollout` resource in the Cloud Deploy API.
         #
         # A `Rollout` contains information around a specific deployment to a `Target`.
         # @!attribute [rw] name
@@ -1457,14 +1508,12 @@ module Google
         # @!attribute [rw] annotations
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     User annotations. These attributes can only be set and used by the
-        #     user, and not by Google Cloud Deploy. See
-        #     https://google.aip.dev/128#annotations for more details such as format and
-        #     size limitations.
+        #     user, and not by Cloud Deploy. See https://google.aip.dev/128#annotations
+        #     for more details such as format and size limitations.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Labels are attributes that can be set and used by both the
-        #     user and by Google Cloud Deploy. Labels must meet the following
-        #     constraints:
+        #     user and by Cloud Deploy. Labels must meet the following constraints:
         #
         #     * Keys and values can contain only lowercase letters, numeric characters,
         #     underscores, and dashes.
@@ -1611,7 +1660,7 @@ module Google
 
             # Cloud Build is not available, either because it is not enabled or because
             # Cloud Deploy has insufficient permissions. See [required
-            # permission](/deploy/docs/cloud-deploy-service-account#required_permissions).
+            # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
             CLOUD_BUILD_UNAVAILABLE = 1
 
             # The deploy operation did not complete successfully; check Cloud Build
@@ -1630,8 +1679,8 @@ module Google
             # No skaffold verify configuration was found.
             VERIFICATION_CONFIG_NOT_FOUND = 6
 
-            # Cloud Build failed to fulfill Google Cloud Deploy's request. See
-            # failure_message for additional details.
+            # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
+            # for additional details.
             CLOUD_BUILD_REQUEST_FAILED = 7
           end
         end
@@ -1729,6 +1778,14 @@ module Google
         # @!attribute [r] verify_job
         #   @return [::Google::Cloud::Deploy::V1::Job]
         #     Output only. The verify Job. Runs after a deploy if the deploy succeeds.
+        # @!attribute [r] predeploy_job
+        #   @return [::Google::Cloud::Deploy::V1::Job]
+        #     Output only. The predeploy Job. This is the predeploy job in the phase.
+        #     This is the first job of the phase.
+        # @!attribute [r] postdeploy_job
+        #   @return [::Google::Cloud::Deploy::V1::Job]
+        #     Output only. The postdeploy Job. This is the postdeploy job in the phase.
+        #     This is the last job of the phase.
         class DeploymentJobs
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1767,6 +1824,12 @@ module Google
         # @!attribute [r] verify_job
         #   @return [::Google::Cloud::Deploy::V1::VerifyJob]
         #     Output only. A verify Job.
+        # @!attribute [r] predeploy_job
+        #   @return [::Google::Cloud::Deploy::V1::PredeployJob]
+        #     Output only. A predeploy Job.
+        # @!attribute [r] postdeploy_job
+        #   @return [::Google::Cloud::Deploy::V1::PostdeployJob]
+        #     Output only. A postdeploy Job.
         # @!attribute [r] create_child_rollout_job
         #   @return [::Google::Cloud::Deploy::V1::CreateChildRolloutJob]
         #     Output only. A createChildRollout Job.
@@ -1820,6 +1883,24 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # A predeploy Job.
+        # @!attribute [r] actions
+        #   @return [::Array<::String>]
+        #     Output only. The custom actions that the predeploy Job executes.
+        class PredeployJob
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A postdeploy Job.
+        # @!attribute [r] actions
+        #   @return [::Array<::String>]
+        #     Output only. The custom actions that the postdeploy Job executes.
+        class PostdeployJob
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # A createChildRollout Job.
         class CreateChildRolloutJob
           include ::Google::Protobuf::MessageExts
@@ -2079,7 +2160,7 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # A `JobRun` resource in the Google Cloud Deploy API.
+        # A `JobRun` resource in the Cloud Deploy API.
         #
         # A `JobRun` contains information of a single `Rollout` job evaluation.
         # @!attribute [rw] name
@@ -2115,6 +2196,12 @@ module Google
         # @!attribute [r] verify_job_run
         #   @return [::Google::Cloud::Deploy::V1::VerifyJobRun]
         #     Output only. Information specific to a verify `JobRun`.
+        # @!attribute [r] predeploy_job_run
+        #   @return [::Google::Cloud::Deploy::V1::PredeployJobRun]
+        #     Output only. Information specific to a predeploy `JobRun`.
+        # @!attribute [r] postdeploy_job_run
+        #   @return [::Google::Cloud::Deploy::V1::PostdeployJobRun]
+        #     Output only. Information specific to a postdeploy `JobRun`.
         # @!attribute [r] create_child_rollout_job_run
         #   @return [::Google::Cloud::Deploy::V1::CreateChildRolloutJobRun]
         #     Output only. Information specific to a createChildRollout `JobRun`.
@@ -2181,8 +2268,8 @@ module Google
             FAILURE_CAUSE_UNSPECIFIED = 0
 
             # Cloud Build is not available, either because it is not enabled or because
-            # Google Cloud Deploy has insufficient permissions. See [Required
-            # permission](/deploy/docs/cloud-deploy-service-account#required_permissions).
+            # Cloud Deploy has insufficient permissions. See [Required
+            # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
             CLOUD_BUILD_UNAVAILABLE = 1
 
             # The deploy operation did not complete successfully; check Cloud Build
@@ -2196,8 +2283,8 @@ module Google
             # canary deployment. Check the Cloud Build logs for more information.
             MISSING_RESOURCES_FOR_CANARY = 4
 
-            # Cloud Build failed to fulfill Google Cloud Deploy's request. See
-            # failure_message for additional details.
+            # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
+            # for additional details.
             CLOUD_BUILD_REQUEST_FAILED = 5
           end
         end
@@ -2233,8 +2320,8 @@ module Google
             FAILURE_CAUSE_UNSPECIFIED = 0
 
             # Cloud Build is not available, either because it is not enabled or because
-            # Google Cloud Deploy has insufficient permissions. See [required
-            # permission](/deploy/docs/cloud-deploy-service-account#required_permissions).
+            # Cloud Deploy has insufficient permissions. See [required
+            # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
             CLOUD_BUILD_UNAVAILABLE = 1
 
             # The verify operation did not complete successfully; check Cloud Build
@@ -2247,12 +2334,94 @@ module Google
             # No Skaffold verify configuration was found.
             VERIFICATION_CONFIG_NOT_FOUND = 4
 
-            # Cloud Build failed to fulfill Google Cloud Deploy's request. See
-            # failure_message for additional details.
+            # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
+            # for additional details.
             CLOUD_BUILD_REQUEST_FAILED = 5
           end
         end
 
+        # PredeployJobRun contains information specific to a predeploy `JobRun`.
+        # @!attribute [r] build
+        #   @return [::String]
+        #     Output only. The resource name of the Cloud Build `Build` object that is
+        #     used to execute the custom actions associated with the predeploy Job.
+        #     Format is projects/\\{project}/locations/\\{location}/builds/\\{build}.
+        # @!attribute [r] failure_cause
+        #   @return [::Google::Cloud::Deploy::V1::PredeployJobRun::FailureCause]
+        #     Output only. The reason the predeploy failed. This will always be
+        #     unspecified while the predeploy is in progress or if it succeeded.
+        # @!attribute [r] failure_message
+        #   @return [::String]
+        #     Output only. Additional information about the predeploy failure, if
+        #     available.
+        class PredeployJobRun
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Well-known predeploy failures.
+          module FailureCause
+            # No reason for failure is specified.
+            FAILURE_CAUSE_UNSPECIFIED = 0
+
+            # Cloud Build is not available, either because it is not enabled or because
+            # Cloud Deploy has insufficient permissions. See [required
+            # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
+            CLOUD_BUILD_UNAVAILABLE = 1
+
+            # The predeploy operation did not complete successfully; check Cloud Build
+            # logs.
+            EXECUTION_FAILED = 2
+
+            # The predeploy build did not complete within the alloted time.
+            DEADLINE_EXCEEDED = 3
+
+            # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
+            # for additional details.
+            CLOUD_BUILD_REQUEST_FAILED = 4
+          end
+        end
+
+        # PostdeployJobRun contains information specific to a postdeploy `JobRun`.
+        # @!attribute [r] build
+        #   @return [::String]
+        #     Output only. The resource name of the Cloud Build `Build` object that is
+        #     used to execute the custom actions associated with the postdeploy Job.
+        #     Format is projects/\\{project}/locations/\\{location}/builds/\\{build}.
+        # @!attribute [r] failure_cause
+        #   @return [::Google::Cloud::Deploy::V1::PostdeployJobRun::FailureCause]
+        #     Output only. The reason the postdeploy failed. This will always be
+        #     unspecified while the postdeploy is in progress or if it succeeded.
+        # @!attribute [r] failure_message
+        #   @return [::String]
+        #     Output only. Additional information about the postdeploy failure, if
+        #     available.
+        class PostdeployJobRun
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Well-known postdeploy failures.
+          module FailureCause
+            # No reason for failure is specified.
+            FAILURE_CAUSE_UNSPECIFIED = 0
+
+            # Cloud Build is not available, either because it is not enabled or because
+            # Cloud Deploy has insufficient permissions. See [required
+            # permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).
+            CLOUD_BUILD_UNAVAILABLE = 1
+
+            # The postdeploy operation did not complete successfully; check Cloud Build
+            # logs.
+            EXECUTION_FAILED = 2
+
+            # The postdeploy build did not complete within the alloted time.
+            DEADLINE_EXCEEDED = 3
+
+            # Cloud Build failed to fulfill Cloud Deploy's request. See failure_message
+            # for additional details.
+            CLOUD_BUILD_REQUEST_FAILED = 4
+          end
+        end
+
         # CreateChildRolloutJobRun contains information specific to a
         # createChildRollout `JobRun`.
         # @!attribute [r] rollout

data/proto_docs/google/cloud/deploy/v1/log_enums.rb

@@ -35,6 +35,12 @@ module Google
           # A process aborted.
           TYPE_PROCESS_ABORTED = 4
 
+          # Restriction check failed.
+          TYPE_RESTRICTION_VIOLATED = 5
+
+          # Resource deleted.
+          TYPE_RESOURCE_DELETED = 6
+
           # Deprecated: This field is never used. Use release_render log type instead.
           TYPE_RENDER_STATUES_CHANGE = 2
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-deploy-v1
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.12.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-11 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -274,7 +274,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: API Client library for the Google Cloud Deploy V1 API