google-cloud-deploy-v1 0.15.0 → 0.17.0

data/lib/google/cloud/deploy/v1/cloud_deploy/operations.rb

@@ -26,6 +26,9 @@ module Google
         module CloudDeploy
           # Service that implements Longrunning Operations API.
           class Operations
+            # @private
+            DEFAULT_ENDPOINT_TEMPLATE = "clouddeploy.$UNIVERSE_DOMAIN$"
+
             # @private
             attr_reader :operations_stub
 
@@ -60,6 +63,15 @@ module Google
               @config
             end
 
+            ##
+            # The effective universe domain
+            #
+            # @return [String]
+            #
+            def universe_domain
+              @operations_stub.universe_domain
+            end
+
             ##
             # Create a new Operations client object.
             #
@@ -90,8 +102,10 @@ module Google
 
               @operations_stub = ::Gapic::ServiceStub.new(
                 ::Google::Longrunning::Operations::Stub,
-                credentials:  credentials,
-                endpoint:     @config.endpoint,
+                credentials: credentials,
+                endpoint: @config.endpoint,
+                endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                universe_domain: @config.universe_domain,
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors,
                 channel_pool_config: @config.channel_pool
@@ -613,9 +627,9 @@ module Google
             #   end
             #
             # @!attribute [rw] endpoint
-            #   The hostname or hostname:port of the service endpoint.
-            #   Defaults to `"clouddeploy.googleapis.com"`.
-            #   @return [::String]
+            #   A custom service endpoint, as a hostname or hostname:port. The default is
+            #   nil, indicating to use the default endpoint in the current universe domain.
+            #   @return [::String,nil]
             # @!attribute [rw] credentials
             #   Credentials to send with calls. You may provide any of the following types:
             #    *  (`String`) The path to a service account key file in JSON format
@@ -661,13 +675,20 @@ module Google
             # @!attribute [rw] quota_project
             #   A separate project against which to charge quota.
             #   @return [::String]
+            # @!attribute [rw] universe_domain
+            #   The universe domain within which to make requests. This determines the
+            #   default endpoint URL. The default value of nil uses the environment
+            #   universe (usually the default "googleapis.com" universe).
+            #   @return [::String,nil]
             #
             class Configuration
               extend ::Gapic::Config
 
+              # @private
+              # The endpoint specific to the default "googleapis.com" universe. Deprecated.
               DEFAULT_ENDPOINT = "clouddeploy.googleapis.com"
 
-              config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
+              config_attr :endpoint,      nil, ::String, nil
               config_attr :credentials,   nil do |value|
                 allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                 allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
@@ -682,6 +703,7 @@ module Google
               config_attr :metadata,      nil, ::Hash, nil
               config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
               config_attr :quota_project, nil, ::String, nil
+              config_attr :universe_domain, nil, ::String, nil
 
               # @private
               def initialize parent_config = nil

data/lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb

@@ -35,6 +35,9 @@ module Google
             # on Google Cloud Platform via Skaffold (https://skaffold.dev).
             #
             class Client
+              # @private
+              DEFAULT_ENDPOINT_TEMPLATE = "clouddeploy.$UNIVERSE_DOMAIN$"
+
               include Paths
 
               # @private
@@ -224,6 +227,15 @@ module Google
                 @config
               end
 
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @cloud_deploy_stub.universe_domain
+              end
+
               ##
               # Create a new CloudDeploy REST client object.
               #
@@ -251,8 +263,9 @@ module Google
                 credentials = @config.credentials
                 # Use self-signed JWT if the endpoint is unchanged from default,
                 # but only if the default endpoint does not have a region prefix.
-                enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
-                                         !@config.endpoint.split(".").first.include?("-")
+                enable_self_signed_jwt = @config.endpoint.nil? ||
+                                         (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
+                                         !@config.endpoint.split(".").first.include?("-"))
                 credentials ||= Credentials.default scope: @config.scope,
                                                     enable_self_signed_jwt: enable_self_signed_jwt
                 if credentials.is_a?(::String) || credentials.is_a?(::Hash)
@@ -266,12 +279,14 @@ module Google
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @config.endpoint
+                  config.universe_domain = @config.universe_domain
                 end
 
                 @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @config.endpoint
+                  config.universe_domain = @config.universe_domain
                   config.bindings_override = @config.bindings_override
                 end
 
@@ -279,10 +294,16 @@ module Google
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @config.endpoint
+                  config.universe_domain = @config.universe_domain
                   config.bindings_override = @config.bindings_override
                 end
 
-                @cloud_deploy_stub = ::Google::Cloud::Deploy::V1::CloudDeploy::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
+                @cloud_deploy_stub = ::Google::Cloud::Deploy::V1::CloudDeploy::Rest::ServiceStub.new(
+                  endpoint: @config.endpoint,
+                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                  universe_domain: @config.universe_domain,
+                  credentials: credentials
+                )
               end
 
               ##
@@ -514,9 +535,9 @@ module Google
               #     Required. The `DeliveryPipeline` to create.
               #   @param request_id [::String]
               #     Optional. A request ID to identify requests. Specify a unique request ID
-              #     so that if you must retry your request, the server will know to ignore
-              #     the request if it has already been completed. The server will guarantee
-              #     that for at least 60 minutes since the first request.
+              #     so that if you must retry your request, the server knows to ignore the
+              #     request if it has already been completed. The server guarantees that for
+              #     at least 60 minutes after the first request.
               #
               #     For example, consider a situation where you make an initial request and the
               #     request times out. If you make the request again with the same request ID,
@@ -617,15 +638,15 @@ module Google
               #     Required. Field mask is used to specify the fields to be overwritten in the
               #     `DeliveryPipeline` resource by the update.
               #     The fields specified in the update_mask are relative to the resource, not
-              #     the full request. A field will be overwritten if it is in the mask. If the
-              #     user does not provide a mask then all fields will be overwritten.
+              #     the full request. A field will be overwritten if it's in the mask. If the
+              #     user doesn't provide a mask then all fields are overwritten.
               #   @param delivery_pipeline [::Google::Cloud::Deploy::V1::DeliveryPipeline, ::Hash]
               #     Required. The `DeliveryPipeline` to update.
               #   @param request_id [::String]
               #     Optional. A request ID to identify requests. Specify a unique request ID
-              #     so that if you must retry your request, the server will know to ignore
-              #     the request if it has already been completed. The server will guarantee
-              #     that for at least 60 minutes since the first request.
+              #     so that if you must retry your request, the server knows to ignore the
+              #     request if it has already been completed. The server guarantees that for
+              #     at least 60 minutes after the first request.
               #
               #     For example, consider a situation where you make an initial request and the
               #     request times out. If you make the request again with the same request ID,
@@ -730,9 +751,9 @@ module Google
               #     `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}`.
               #   @param request_id [::String]
               #     Optional. A request ID to identify requests. Specify a unique request ID
-              #     so that if you must retry your request, the server will know to ignore
-              #     the request if it has already been completed. The server will guarantee
-              #     that for at least 60 minutes after the first request.
+              #     so that if you must retry your request, the server knows to ignore the
+              #     request if it has already been completed. The server guarantees that for
+              #     at least 60 minutes after the first request.
               #
               #     For example, consider a situation where you make an initial request and the
               #     request times out. If you make the request again with the same request ID,
@@ -1125,9 +1146,9 @@ module Google
               #     Required. The `Target` to create.
               #   @param request_id [::String]
               #     Optional. A request ID to identify requests. Specify a unique request ID
-              #     so that if you must retry your request, the server will know to ignore
-              #     the request if it has already been completed. The server will guarantee
-              #     that for at least 60 minutes since the first request.
+              #     so that if you must retry your request, the server knows to ignore the
+              #     request if it has already been completed. The server guarantees that for
+              #     at least 60 minutes after the first request.
               #
               #     For example, consider a situation where you make an initial request and the
               #     request times out. If you make the request again with the same request ID,
@@ -1228,15 +1249,15 @@ module Google
               #     Required. Field mask is used to specify the fields to be overwritten in the
               #     Target resource by the update.
               #     The fields specified in the update_mask are relative to the resource, not
-              #     the full request. A field will be overwritten if it is in the mask. If the
-              #     user does not provide a mask then all fields will be overwritten.
+              #     the full request. A field will be overwritten if it's in the mask. If the
+              #     user doesn't provide a mask then all fields are overwritten.
               #   @param target [::Google::Cloud::Deploy::V1::Target, ::Hash]
               #     Required. The `Target` to update.
               #   @param request_id [::String]
               #     Optional. A request ID to identify requests. Specify a unique request ID
-              #     so that if you must retry your request, the server will know to ignore
-              #     the request if it has already been completed. The server will guarantee
-              #     that for at least 60 minutes since the first request.
+              #     so that if you must retry your request, the server knows to ignore the
+              #     request if it has already been completed. The server guarantees that for
+              #     at least 60 minutes after the first request.
               #
               #     For example, consider a situation where you make an initial request and the
               #     request times out. If you make the request again with the same request ID,
@@ -1341,9 +1362,9 @@ module Google
               #     `projects/{project_id}/locations/{location_name}/targets/{target_name}`.
               #   @param request_id [::String]
               #     Optional. A request ID to identify requests. Specify a unique request ID
-              #     so that if you must retry your request, the server will know to ignore
-              #     the request if it has already been completed. The server will guarantee
-              #     that for at least 60 minutes after the first request.
+              #     so that if you must retry your request, the server knows to ignore the
+              #     request if it has already been completed. The server guarantees that for
+              #     at least 60 minutes after the first request.
               #
               #     For example, consider a situation where you make an initial request and the
               #     request times out. If you make the request again with the same request ID,
@@ -1628,7 +1649,7 @@ module Google
               #
               #   @param parent [::String]
               #     Required. The parent collection in which the `CustomTargetType` should be
-              #     created in. Format should be
+              #     created. Format should be
               #     `projects/{project_id}/locations/{location_name}`.
               #   @param custom_target_type_id [::String]
               #     Required. ID of the `CustomTargetType`.
@@ -1636,9 +1657,9 @@ module Google
               #     Required. The `CustomTargetType` to create.
               #   @param request_id [::String]
               #     Optional. A request ID to identify requests. Specify a unique request ID
-              #     so that if you must retry your request, the server will know to ignore
-              #     the request if it has already been completed. The server will guarantee
-              #     that for at least 60 minutes since the first request.
+              #     so that if you must retry your request, the server knows to ignore the
+              #     request if it has already been completed. The server guarantees that for
+              #     at least 60 minutes after the first request.
               #
               #     For example, consider a situation where you make an initial request and the
               #     request times out. If you make the request again with the same request ID,
@@ -1739,15 +1760,15 @@ module Google
               #     Required. Field mask is used to specify the fields to be overwritten in the
               #     `CustomTargetType` resource by the update.
               #     The fields specified in the update_mask are relative to the resource, not
-              #     the full request. A field will be overwritten if it is in the mask. If the
-              #     user does not provide a mask then all fields will be overwritten.
+              #     the full request. A field will be overwritten if it's in the mask. If the
+              #     user doesn't provide a mask then all fields are overwritten.
               #   @param custom_target_type [::Google::Cloud::Deploy::V1::CustomTargetType, ::Hash]
               #     Required. The `CustomTargetType` to update.
               #   @param request_id [::String]
               #     Optional. A request ID to identify requests. Specify a unique request ID
-              #     so that if you must retry your request, the server will know to ignore
-              #     the request if it has already been completed. The server will guarantee
-              #     that for at least 60 minutes since the first request.
+              #     so that if you must retry your request, the server knows to ignore the
+              #     request if it has already been completed. The server guarantees that for
+              #     at least 60 minutes after the first request.
               #
               #     For example, consider a situation where you make an initial request and the
               #     request times out. If you make the request again with the same request ID,
@@ -1852,9 +1873,9 @@ module Google
               #     `projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}`.
               #   @param request_id [::String]
               #     Optional. A request ID to identify requests. Specify a unique request ID
-              #     so that if you must retry your request, the server will know to ignore
-              #     the request if it has already been completed. The server will guarantee
-              #     that for at least 60 minutes after the first request.
+              #     so that if you must retry your request, the server knows to ignore the
+              #     request if it has already been completed. The server guarantees that for
+              #     at least 60 minutes after the first request.
               #
               #     For example, consider a situation where you make an initial request and the
               #     request times out. If you make the request again with the same request ID,
@@ -2147,9 +2168,9 @@ module Google
               #     Required. The `Release` to create.
               #   @param request_id [::String]
               #     Optional. A request ID to identify requests. Specify a unique request ID
-              #     so that if you must retry your request, the server will know to ignore
-              #     the request if it has already been completed. The server will guarantee
-              #     that for at least 60 minutes since the first request.
+              #     so that if you must retry your request, the server knows to ignore the
+              #     request if it has already been completed. The server guarantees that for
+              #     at least 60 minutes after the first request.
               #
               #     For example, consider a situation where you make an initial request and the
               #     request times out. If you make the request again with the same request ID,
@@ -2754,9 +2775,9 @@ module Google
               #     Required. The `Rollout` to create.
               #   @param request_id [::String]
               #     Optional. A request ID to identify requests. Specify a unique request ID
-              #     so that if you must retry your request, the server will know to ignore
-              #     the request if it has already been completed. The server will guarantee
-              #     that for at least 60 minutes since the first request.
+              #     so that if you must retry your request, the server knows to ignore the
+              #     request if it has already been completed. The server guarantees that for
+              #     at least 60 minutes after the first request.
               #
               #     For example, consider a situation where you make an initial request and the
               #     request times out. If you make the request again with the same request ID,
@@ -3367,9 +3388,9 @@ module Google
               #     Required. The `Automation` to create.
               #   @param request_id [::String]
               #     Optional. A request ID to identify requests. Specify a unique request ID
-              #     so that if you must retry your request, the server will know to ignore
-              #     the request if it has already been completed. The server will guarantee
-              #     that for at least 60 minutes since the first request.
+              #     so that if you must retry your request, the server knows to ignore the
+              #     request if it has already been completed. The server guarantees that for
+              #     at least 60 minutes after the first request.
               #
               #     For example, consider a situation where you make an initial request and the
               #     request times out. If you make the request again with the same request ID,
@@ -3470,15 +3491,15 @@ module Google
               #     Required. Field mask is used to specify the fields to be overwritten in the
               #     `Automation` resource by the update.
               #     The fields specified in the update_mask are relative to the resource, not
-              #     the full request. A field will be overwritten if it is in the mask. If the
-              #     user does not provide a mask then all fields will be overwritten.
+              #     the full request. A field will be overwritten if it's in the mask. If the
+              #     user doesn't provide a mask then all fields are overwritten.
               #   @param automation [::Google::Cloud::Deploy::V1::Automation, ::Hash]
               #     Required. The `Automation` to update.
               #   @param request_id [::String]
               #     Optional. A request ID to identify requests. Specify a unique request ID
-              #     so that if you must retry your request, the server will know to ignore
-              #     the request if it has already been completed. The server will guarantee
-              #     that for at least 60 minutes since the first request.
+              #     so that if you must retry your request, the server knows to ignore the
+              #     request if it has already been completed. The server guarantees that for
+              #     at least 60 minutes after the first request.
               #
               #     For example, consider a situation where you make an initial request and the
               #     request times out. If you make the request again with the same request ID,
@@ -3583,9 +3604,9 @@ module Google
               #     `projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}`.
               #   @param request_id [::String]
               #     Optional. A request ID to identify requests. Specify a unique request ID
-              #     so that if you must retry your request, the server will know to ignore
-              #     the request if it has already been completed. The server will guarantee
-              #     that for at least 60 minutes after the first request.
+              #     so that if you must retry your request, the server knows to ignore the
+              #     request if it has already been completed. The server guarantees that for
+              #     at least 60 minutes after the first request.
               #
               #     For example, consider a situation where you make an initial request and the
               #     request times out. If you make the request again with the same request ID,
@@ -4142,9 +4163,9 @@ module Google
               #   end
               #
               # @!attribute [rw] endpoint
-              #   The hostname or hostname:port of the service endpoint.
-              #   Defaults to `"clouddeploy.googleapis.com"`.
-              #   @return [::String]
+              #   A custom service endpoint, as a hostname or hostname:port. The default is
+              #   nil, indicating to use the default endpoint in the current universe domain.
+              #   @return [::String,nil]
               # @!attribute [rw] credentials
               #   Credentials to send with calls. You may provide any of the following types:
               #    *  (`String`) The path to a service account key file in JSON format
@@ -4181,13 +4202,20 @@ module Google
               # @!attribute [rw] quota_project
               #   A separate project against which to charge quota.
               #   @return [::String]
+              # @!attribute [rw] universe_domain
+              #   The universe domain within which to make requests. This determines the
+              #   default endpoint URL. The default value of nil uses the environment
+              #   universe (usually the default "googleapis.com" universe).
+              #   @return [::String,nil]
               #
               class Configuration
                 extend ::Gapic::Config
 
+                # @private
+                # The endpoint specific to the default "googleapis.com" universe. Deprecated.
                 DEFAULT_ENDPOINT = "clouddeploy.googleapis.com"
 
-                config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
+                config_attr :endpoint,      nil, ::String, nil
                 config_attr :credentials,   nil do |value|
                   allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                   allowed.any? { |klass| klass === value }
@@ -4199,6 +4227,7 @@ module Google
                 config_attr :metadata,      nil, ::Hash, nil
                 config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                 config_attr :quota_project, nil, ::String, nil
+                config_attr :universe_domain, nil, ::String, nil
 
                 # @private
                 # Overrides for http bindings for the RPCs of this service

data/lib/google/cloud/deploy/v1/cloud_deploy/rest/operations.rb

@@ -26,6 +26,9 @@ module Google
           module Rest
             # Service that implements Longrunning Operations API.
             class Operations
+              # @private
+              DEFAULT_ENDPOINT_TEMPLATE = "clouddeploy.$UNIVERSE_DOMAIN$"
+
               # @private
               attr_reader :operations_stub
 
@@ -60,6 +63,15 @@ module Google
                 @config
               end
 
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @operations_stub.universe_domain
+              end
+
               ##
               # Create a new Operations client object.
               #
@@ -84,8 +96,10 @@ module Google
                 @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
 
                 @operations_stub = OperationsServiceStub.new(
-                  endpoint:     @config.endpoint,
-                  credentials:  credentials
+                  endpoint: @config.endpoint,
+                  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
+                  universe_domain: @config.universe_domain,
+                  credentials: credentials
                 )
 
                 # Used by an LRO wrapper for some methods of this service
@@ -478,9 +492,9 @@ module Google
               #   end
               #
               # @!attribute [rw] endpoint
-              #   The hostname or hostname:port of the service endpoint.
-              #   Defaults to `"clouddeploy.googleapis.com"`.
-              #   @return [::String]
+              #   A custom service endpoint, as a hostname or hostname:port. The default is
+              #   nil, indicating to use the default endpoint in the current universe domain.
+              #   @return [::String,nil]
               # @!attribute [rw] credentials
               #   Credentials to send with calls. You may provide any of the following types:
               #    *  (`String`) The path to a service account key file in JSON format
@@ -517,13 +531,20 @@ module Google
               # @!attribute [rw] quota_project
               #   A separate project against which to charge quota.
               #   @return [::String]
+              # @!attribute [rw] universe_domain
+              #   The universe domain within which to make requests. This determines the
+              #   default endpoint URL. The default value of nil uses the environment
+              #   universe (usually the default "googleapis.com" universe).
+              #   @return [::String,nil]
               #
               class Configuration
                 extend ::Gapic::Config
 
+                # @private
+                # The endpoint specific to the default "googleapis.com" universe. Deprecated.
                 DEFAULT_ENDPOINT = "clouddeploy.googleapis.com"
 
-                config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
+                config_attr :endpoint,      nil, ::String, nil
                 config_attr :credentials,   nil do |value|
                   allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
                   allowed.any? { |klass| klass === value }
@@ -535,6 +556,7 @@ module Google
                 config_attr :metadata,      nil, ::Hash, nil
                 config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                 config_attr :quota_project, nil, ::String, nil
+                config_attr :universe_domain, nil, ::String, nil
 
                 # @private
                 def initialize parent_config = nil
@@ -617,12 +639,15 @@ module Google
             # Service stub contains baseline method implementations
             # including transcoding, making the REST call, and deserialing the response.
             class OperationsServiceStub
-              def initialize endpoint:, credentials:
+              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
                 # These require statements are intentionally placed here to initialize
                 # the REST modules only when it's required.
                 require "gapic/rest"
 
-                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials
+                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
+                                                             endpoint_template: endpoint_template,
+                                                             universe_domain: universe_domain,
+                                                             credentials: credentials
               end
 
               ##

data/lib/google/cloud/deploy/v1/cloud_deploy/rest/service_stub.rb

@@ -30,16 +30,28 @@ module Google
             # including transcoding, making the REST call, and deserialing the response.
             #
             class ServiceStub
-              def initialize endpoint:, credentials:
+              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
                 # These require statements are intentionally placed here to initialize
                 # the REST modules only when it's required.
                 require "gapic/rest"
 
-                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint, credentials: credentials,
+                @client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
+                                                             endpoint_template: endpoint_template,
+                                                             universe_domain: universe_domain,
+                                                             credentials: credentials,
                                                              numeric_enums: true,
                                                              raise_faraday_errors: false
               end
 
+              ##
+              # The effective universe domain
+              #
+              # @return [String]
+              #
+              def universe_domain
+                @client_stub.universe_domain
+              end
+
               ##
               # Baseline implementation for the list_delivery_pipelines REST call
               #