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

- old
+ new

@@ -139,17 +139,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 @snapshots_stub = ::Google::Cloud::Compute::V1::Snapshots::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end @@ -173,12 +182,10 @@ # @param request [::Google::Cloud::Compute::V1::DeleteSnapshotRequest, ::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(project: nil, request_id: nil, snapshot: 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). @@ -205,21 +212,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 @snapshots_stub.delete request, options do |result, response| result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation( operation: result, client: global_operations, @@ -229,16 +240,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 ## # Returns the specified Snapshot resource. Gets a list of available snapshots by making a list() request. # @@ -249,12 +256,10 @@ # @param request [::Google::Cloud::Compute::V1::GetSnapshotRequest, ::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(project: nil, snapshot: 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). @@ -279,32 +284,32 @@ 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 @snapshots_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 ## # Gets the access control policy for a resource. May be empty if no such policy or resource exists. # @@ -315,12 +320,10 @@ # @param request [::Google::Cloud::Compute::V1::GetIamPolicySnapshotRequest, ::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_iam_policy(options_requested_policy_version: nil, project: nil, resource: nil) # Pass arguments to `get_iam_policy` 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). @@ -347,32 +350,32 @@ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.get_iam_policy.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_iam_policy.timeout, - metadata: call_metadata + metadata: call_metadata, + retry_policy: @config.rpcs.get_iam_policy.retry_policy options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata + metadata: @config.metadata, + retry_policy: @config.retry_policy @snapshots_stub.get_iam_policy 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 snapshot in the specified project using the data included in the request. For regular snapshot creation, consider using this method instead of disks.createSnapshot, as this method supports more features, such as creating snapshots in a project different from the source disk project. # @@ -383,12 +386,10 @@ # @param request [::Google::Cloud::Compute::V1::InsertSnapshotRequest, ::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(project: nil, request_id: nil, snapshot_resource: 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). @@ -415,21 +416,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 @snapshots_stub.insert request, options do |result, response| result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation( operation: result, client: global_operations, @@ -439,16 +444,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 ## # Retrieves the list of Snapshot resources contained within the specified project. # @@ -459,12 +460,10 @@ # @param request [::Google::Cloud::Compute::V1::ListSnapshotsRequest, ::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). @@ -497,33 +496,33 @@ 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 @snapshots_stub.list request, options do |result, response| result = ::Gapic::Rest::PagedEnumerable.new @snapshots_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 ## # Sets the access control policy on the specified resource. Replaces any existing policy. # @@ -534,12 +533,10 @@ # @param request [::Google::Cloud::Compute::V1::SetIamPolicySnapshotRequest, ::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_iam_policy(global_set_policy_request_resource: nil, project: nil, resource: nil) # Pass arguments to `set_iam_policy` 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). @@ -566,32 +563,32 @@ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.set_iam_policy.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_iam_policy.timeout, - metadata: call_metadata + metadata: call_metadata, + retry_policy: @config.rpcs.set_iam_policy.retry_policy options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata + metadata: @config.metadata, + retry_policy: @config.retry_policy @snapshots_stub.set_iam_policy 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 ## # Sets the labels on a snapshot. To learn more about labels, read the Labeling Resources documentation. # @@ -602,12 +599,10 @@ # @param request [::Google::Cloud::Compute::V1::SetLabelsSnapshotRequest, ::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). @@ -634,21 +629,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 @snapshots_stub.set_labels request, options do |result, response| result = ::Google::Cloud::Compute::V1::GlobalOperations::Rest::NonstandardLro.create_operation( operation: result, client: global_operations, @@ -658,16 +657,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 ## # Returns permissions that a caller has on the specified resource. # @@ -678,12 +673,10 @@ # @param request [::Google::Cloud::Compute::V1::TestIamPermissionsSnapshotRequest, ::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 test_iam_permissions(project: nil, resource: nil, test_permissions_request_resource: nil) # Pass arguments to `test_iam_permissions` 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). @@ -710,57 +703,63 @@ options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h # Customize the options with defaults call_metadata = @config.rpcs.test_iam_permissions.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.test_iam_permissions.timeout, - metadata: call_metadata + metadata: call_metadata, + retry_policy: @config.rpcs.test_iam_permissions.retry_policy options.apply_defaults timeout: @config.timeout, - metadata: @config.metadata + metadata: @config.metadata, + retry_policy: @config.retry_policy @snapshots_stub.test_iam_permissions 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 ## # Configuration class for the Snapshots REST API. # # This class represents the configuration for Snapshots 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::Snapshots::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::Snapshots::Rest::Client.configure do |config| + # config.timeout = 10.0 + # config.rpcs.delete.timeout = 20.0 + # end # - # ::Google::Cloud::Compute::V1::Snapshots::Client.configure do |config| - # config.timeout = 10.0 - # end + # # Apply the above configuration only to a new client. + # client = ::Google::Cloud::Compute::V1::Snapshots::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::Snapshots::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 @@ -784,12 +783,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 @@ -800,10 +810,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? @@ -828,12 +840,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]