lib/google/cloud/compute/v1/interconnects/rest/client.rb in google-cloud-compute-v1-1.8.0 vs lib/google/cloud/compute/v1/interconnects/rest/client.rb in google-cloud-compute-v1-1.9.0

- old
+ new

@@ -137,17 +137,26 @@ # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials - credentials ||= Credentials.default scope: @config.scope + # 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 == Client.configure.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) credentials = Credentials.new credentials, scope: @config.scope end + @quota_project_id = @config.quota_project + @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id + @global_operations = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::Client.new do |config| config.credentials = credentials + config.quota_project = @quota_project_id config.endpoint = @config.endpoint end @interconnects_stub = ::Google::Cloud::Compute::V1::Interconnects::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end @@ -160,23 +169,21 @@ attr_reader :global_operations # Service calls ## - # Deletes the specified interconnect. + # Deletes the specified Interconnect. # # @overload delete(request, options = nil) # Pass arguments to `delete` via a request object, either of type # {::Google::Cloud::Compute::V1::DeleteInterconnectRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Compute::V1::DeleteInterconnectRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # Note: currently retry functionality is not implemented. While it is possible - # to set it using ::Gapic::CallOptions, it will not be applied # # @overload delete(interconnect: nil, project: nil, request_id: nil) # Pass arguments to `delete` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). @@ -203,21 +210,25 @@ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.delete.metadata.to_h - # Set x-goog-api-client header + # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] + call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + options.apply_defaults timeout: @config.rpcs.delete.timeout, - metadata: call_metadata + metadata: call_metadata, + retry_policy: @config.rpcs.delete.retry_policy options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata + metadata: @config.metadata, + retry_policy: @config.retry_policy @interconnects_stub.delete request, options do |result, response| result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation( operation: result, client: global_operations, @@ -227,32 +238,26 @@ options: options ) yield result, response if block_given? return result end - rescue ::Faraday::Error => e - begin - raise ::Gapic::Rest::Error.wrap_faraday_error e - rescue ::Gapic::Rest::Error => gapic_error - raise ::Google::Cloud::Error.from_error gapic_error - end + rescue ::Gapic::Rest::Error => e + raise ::Google::Cloud::Error.from_error(e) end ## - # Returns the specified interconnect. Get a list of available interconnects by making a list() request. + # Returns the specified Interconnect. Get a list of available Interconnects by making a list() request. # # @overload get(request, options = nil) # Pass arguments to `get` via a request object, either of type # {::Google::Cloud::Compute::V1::GetInterconnectRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Compute::V1::GetInterconnectRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # Note: currently retry functionality is not implemented. While it is possible - # to set it using ::Gapic::CallOptions, it will not be applied # # @overload get(interconnect: nil, project: nil) # Pass arguments to `get` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). @@ -277,48 +282,46 @@ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get.metadata.to_h - # Set x-goog-api-client header + # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] + call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + options.apply_defaults timeout: @config.rpcs.get.timeout, - metadata: call_metadata + metadata: call_metadata, + retry_policy: @config.rpcs.get.retry_policy options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata + metadata: @config.metadata, + retry_policy: @config.retry_policy @interconnects_stub.get request, options do |result, response| yield result, response if block_given? return result end - rescue ::Faraday::Error => e - begin - raise ::Gapic::Rest::Error.wrap_faraday_error e - rescue ::Gapic::Rest::Error => gapic_error - raise ::Google::Cloud::Error.from_error gapic_error - end + rescue ::Gapic::Rest::Error => e + raise ::Google::Cloud::Error.from_error(e) end ## - # Returns the interconnectDiagnostics for the specified interconnect. + # Returns the interconnectDiagnostics for the specified Interconnect. # # @overload get_diagnostics(request, options = nil) # Pass arguments to `get_diagnostics` via a request object, either of type # {::Google::Cloud::Compute::V1::GetDiagnosticsInterconnectRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Compute::V1::GetDiagnosticsInterconnectRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # Note: currently retry functionality is not implemented. While it is possible - # to set it using ::Gapic::CallOptions, it will not be applied # # @overload get_diagnostics(interconnect: nil, project: nil) # Pass arguments to `get_diagnostics` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). @@ -343,48 +346,46 @@ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get_diagnostics.metadata.to_h - # Set x-goog-api-client header + # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] + call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + options.apply_defaults timeout: @config.rpcs.get_diagnostics.timeout, - metadata: call_metadata + metadata: call_metadata, + retry_policy: @config.rpcs.get_diagnostics.retry_policy options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata + metadata: @config.metadata, + retry_policy: @config.retry_policy @interconnects_stub.get_diagnostics request, options do |result, response| yield result, response if block_given? return result end - rescue ::Faraday::Error => e - begin - raise ::Gapic::Rest::Error.wrap_faraday_error e - rescue ::Gapic::Rest::Error => gapic_error - raise ::Google::Cloud::Error.from_error gapic_error - end + rescue ::Gapic::Rest::Error => e + raise ::Google::Cloud::Error.from_error(e) end ## - # Creates a Interconnect in the specified project using the data included in the request. + # Creates an Interconnect in the specified project using the data included in the request. # # @overload insert(request, options = nil) # Pass arguments to `insert` via a request object, either of type # {::Google::Cloud::Compute::V1::InsertInterconnectRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Compute::V1::InsertInterconnectRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # Note: currently retry functionality is not implemented. While it is possible - # to set it using ::Gapic::CallOptions, it will not be applied # # @overload insert(interconnect_resource: nil, project: nil, request_id: nil) # Pass arguments to `insert` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). @@ -411,21 +412,25 @@ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.insert.metadata.to_h - # Set x-goog-api-client header + # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] + call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + options.apply_defaults timeout: @config.rpcs.insert.timeout, - metadata: call_metadata + metadata: call_metadata, + retry_policy: @config.rpcs.insert.retry_policy options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata + metadata: @config.metadata, + retry_policy: @config.retry_policy @interconnects_stub.insert request, options do |result, response| result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation( operation: result, client: global_operations, @@ -435,32 +440,26 @@ options: options ) yield result, response if block_given? return result end - rescue ::Faraday::Error => e - begin - raise ::Gapic::Rest::Error.wrap_faraday_error e - rescue ::Gapic::Rest::Error => gapic_error - raise ::Google::Cloud::Error.from_error gapic_error - end + rescue ::Gapic::Rest::Error => e + raise ::Google::Cloud::Error.from_error(e) end ## - # Retrieves the list of interconnect available to the specified project. + # Retrieves the list of Interconnects available to the specified project. # # @overload list(request, options = nil) # Pass arguments to `list` via a request object, either of type # {::Google::Cloud::Compute::V1::ListInterconnectsRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Compute::V1::ListInterconnectsRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # Note: currently retry functionality is not implemented. While it is possible - # to set it using ::Gapic::CallOptions, it will not be applied # # @overload list(filter: nil, max_results: nil, order_by: nil, page_token: nil, project: nil, return_partial_success: nil) # Pass arguments to `list` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). @@ -493,49 +492,47 @@ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.list.metadata.to_h - # Set x-goog-api-client header + # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] + call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + options.apply_defaults timeout: @config.rpcs.list.timeout, - metadata: call_metadata + metadata: call_metadata, + retry_policy: @config.rpcs.list.retry_policy options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata + metadata: @config.metadata, + retry_policy: @config.retry_policy @interconnects_stub.list request, options do |result, response| result = ::Gapic::Rest::PagedEnumerable.new @interconnects_stub, :list, "items", request, result, options yield result, response if block_given? return result end - rescue ::Faraday::Error => e - begin - raise ::Gapic::Rest::Error.wrap_faraday_error e - rescue ::Gapic::Rest::Error => gapic_error - raise ::Google::Cloud::Error.from_error gapic_error - end + rescue ::Gapic::Rest::Error => e + raise ::Google::Cloud::Error.from_error(e) end ## - # Updates the specified interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. + # Updates the specified Interconnect with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. # # @overload patch(request, options = nil) # Pass arguments to `patch` via a request object, either of type # {::Google::Cloud::Compute::V1::PatchInterconnectRequest} or an equivalent Hash. # # @param request [::Google::Cloud::Compute::V1::PatchInterconnectRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # Note: currently retry functionality is not implemented. While it is possible - # to set it using ::Gapic::CallOptions, it will not be applied # # @overload patch(interconnect: nil, interconnect_resource: nil, project: nil, request_id: nil) # Pass arguments to `patch` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). @@ -564,21 +561,25 @@ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.patch.metadata.to_h - # Set x-goog-api-client header + # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] + call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + options.apply_defaults timeout: @config.rpcs.patch.timeout, - metadata: call_metadata + metadata: call_metadata, + retry_policy: @config.rpcs.patch.retry_policy options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata + metadata: @config.metadata, + retry_policy: @config.retry_policy @interconnects_stub.patch request, options do |result, response| result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation( operation: result, client: global_operations, @@ -588,16 +589,12 @@ options: options ) yield result, response if block_given? return result end - rescue ::Faraday::Error => e - begin - raise ::Gapic::Rest::Error.wrap_faraday_error e - rescue ::Gapic::Rest::Error => gapic_error - raise ::Google::Cloud::Error.from_error gapic_error - end + rescue ::Gapic::Rest::Error => e + raise ::Google::Cloud::Error.from_error(e) end ## # Sets the labels on an Interconnect. To learn more about labels, read the Labeling Resources documentation. # @@ -608,12 +605,10 @@ # @param request [::Google::Cloud::Compute::V1::SetLabelsInterconnectRequest, ::Hash] # A request object representing the call parameters. Required. To specify no # parameters, or to keep all the default parameter values, pass an empty Hash. # @param options [::Gapic::CallOptions, ::Hash] # Overrides the default settings for this call, e.g, timeout, retries etc. Optional. - # Note: currently retry functionality is not implemented. While it is possible - # to set it using ::Gapic::CallOptions, it will not be applied # # @overload set_labels(global_set_labels_request_resource: nil, project: nil, resource: nil) # Pass arguments to `set_labels` via keyword arguments. Note that at # least one keyword argument is required. To specify no parameters, or to keep all # the default parameter values, pass an empty Hash as a request object (see above). @@ -640,21 +635,25 @@ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.set_labels.metadata.to_h - # Set x-goog-api-client header + # Set x-goog-api-client and x-goog-user-project headers call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::Compute::V1::VERSION, transports_version_send: [:rest] + call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id + options.apply_defaults timeout: @config.rpcs.set_labels.timeout, - metadata: call_metadata + metadata: call_metadata, + retry_policy: @config.rpcs.set_labels.retry_policy options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata + metadata: @config.metadata, + retry_policy: @config.retry_policy @interconnects_stub.set_labels request, options do |result, response| result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation( operation: result, client: global_operations, @@ -664,41 +663,43 @@ options: options ) yield result, response if block_given? return result end - rescue ::Faraday::Error => e - begin - raise ::Gapic::Rest::Error.wrap_faraday_error e - rescue ::Gapic::Rest::Error => gapic_error - raise ::Google::Cloud::Error.from_error gapic_error - end + rescue ::Gapic::Rest::Error => e + raise ::Google::Cloud::Error.from_error(e) end ## # Configuration class for the Interconnects REST API. # # This class represents the configuration for Interconnects REST, - # providing control over credentials, timeouts, retry behavior, logging. + # providing control over timeouts, retry behavior, logging, transport + # parameters, and other low-level controls. Certain parameters can also be + # applied individually to specific RPCs. See + # {::Google::Cloud::Compute::V1::Interconnects::Rest::Client::Configuration::Rpcs} + # for a list of RPCs that can be configured independently. # # Configuration can be applied globally to all clients, or to a single client # on construction. # - # # Examples + # @example # - # To modify the global config, setting the timeout for all calls to 10 seconds: + # # Modify the global config, setting the timeout for + # # delete to 20 seconds, + # # and all remaining timeouts to 10 seconds. + # ::Google::Cloud::Compute::V1::Interconnects::Rest::Client.configure do |config| + # config.timeout = 10.0 + # config.rpcs.delete.timeout = 20.0 + # end # - # ::Google::Cloud::Compute::V1::Interconnects::Client.configure do |config| - # config.timeout = 10.0 - # end + # # Apply the above configuration only to a new client. + # client = ::Google::Cloud::Compute::V1::Interconnects::Rest::Client.new do |config| + # config.timeout = 10.0 + # config.rpcs.delete.timeout = 20.0 + # end # - # To apply the above configuration only to a new client: - # - # client = ::Google::Cloud::Compute::V1::Interconnects::Client.new do |config| - # config.timeout = 10.0 - # end - # # @!attribute [rw] endpoint # The hostname or hostname:port of the service endpoint. # Defaults to `"compute.googleapis.com"`. # @return [::String] # @!attribute [rw] credentials @@ -722,12 +723,23 @@ # @return [::String] # @!attribute [rw] timeout # The call timeout in seconds. # @return [::Numeric] # @!attribute [rw] metadata - # Additional REST headers to be sent with the call. + # Additional headers to be sent with the call. # @return [::Hash{::Symbol=>::String}] + # @!attribute [rw] retry_policy + # The retry policy. The value is a hash with the following keys: + # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. + # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. + # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. + # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should + # trigger a retry. + # @return [::Hash] + # @!attribute [rw] quota_project + # A separate project against which to charge quota. + # @return [::String] # class Configuration extend ::Gapic::Config config_attr :endpoint, "compute.googleapis.com", ::String @@ -738,10 +750,12 @@ config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil + config_attr :retry_policy, nil, ::Hash, ::Proc, nil + config_attr :quota_project, nil, ::String, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? @@ -766,12 +780,17 @@ # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds - # - # there is one other field (`retry_policy`) that can be set - # but is currently not supported for REST Gapic libraries. + # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional headers + # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields + # include the following keys: + # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. + # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. + # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. + # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should + # trigger a retry. # class Rpcs ## # RPC-specific configuration for `delete` # @return [::Gapic::Config::Method]