google-cloud-parallelstore-v1beta 0.3.1 → 0.5.0

data/lib/google/cloud/parallelstore/v1beta/parallelstore/rest/client.rb

@@ -172,15 +172,27 @@ module Google
                   endpoint: @config.endpoint,
                   endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                   universe_domain: @config.universe_domain,
-                  credentials: credentials
+                  credentials: credentials,
+                  logger: @config.logger
                 )
 
+                @parallelstore_stub.logger(stub: true)&.info do |entry|
+                  entry.set_system_name
+                  entry.set_service
+                  entry.message = "Created client for #{entry.service}"
+                  entry.set_credentials_fields credentials
+                  entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                  entry.set "defaultTimeout", @config.timeout if @config.timeout
+                  entry.set "quotaProject", @quota_project_id if @quota_project_id
+                end
+
                 @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @parallelstore_stub.endpoint
                   config.universe_domain = @parallelstore_stub.universe_domain
                   config.bindings_override = @config.bindings_override
+                  config.logger = @parallelstore_stub.logger if config.respond_to? :logger=
                 end
               end
 
@@ -198,10 +210,19 @@ module Google
               #
               attr_reader :location_client
 
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger
+                @parallelstore_stub.logger
+              end
+
               # Service calls
 
               ##
-              # Lists Instances in a given project and location.
+              # Lists all instances in a given project and location.
               #
               # @overload list_instances(request, options = nil)
               #   Pass arguments to `list_instances` via a request object, either of type
@@ -221,19 +242,18 @@ module Google
               #   @param parent [::String]
               #     Required. The project and location for which to retrieve instance
               #     information, in the format `projects/{project_id}/locations/{location}`.
-              #     For Parallelstore locations map to Google Cloud zones, for example
-              #     **us-central1-a**.
-              #     To retrieve instance information for all locations, use "-" for the
-              #     `{location}` value.
+              #
+              #     To retrieve instance information for all locations, use "-" as the value of
+              #     `{location}`.
               #   @param page_size [::Integer]
               #     Optional. Requested page size. Server may return fewer items than
-              #     requested. If unspecified, server will pick an appropriate default.
+              #     requested. If unspecified, the server will pick an appropriate default.
               #   @param page_token [::String]
               #     Optional. A token identifying a page of results the server should return.
               #   @param filter [::String]
-              #     Optional. Filtering results
+              #     Optional. Filtering results.
               #   @param order_by [::String]
-              #     Optional. Hint for how to order the results
+              #     Optional. Hint for how to order the results.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::Parallelstore::V1beta::ListInstancesResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -291,14 +311,13 @@ module Google
 
                 @parallelstore_stub.list_instances request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # Gets details of a single Instance.
+              # Gets details of a single instance.
               #
               # @overload get_instance(request, options = nil)
               #   Pass arguments to `get_instance` via a request object, either of type
@@ -371,7 +390,6 @@ module Google
 
                 @parallelstore_stub.get_instance request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -398,10 +416,9 @@ module Google
               #   @param parent [::String]
               #     Required. The instance's project and location, in the format
               #     `projects/{project}/locations/{location}`.
-              #     Locations map to Google Cloud zones, for example **us-west1-b**.
+              #     Locations map to Google Cloud zones; for example, `us-west1-b`.
               #   @param instance_id [::String]
-              #     Required. The logical name of the Parallelstore instance in the user
-              #     project with the following restrictions:
+              #     Required. The name of the Parallelstore instance.
               #
               #     * Must contain only lowercase letters, numbers, and hyphens.
               #     * Must start with a letter.
@@ -485,14 +502,14 @@ module Google
                 @parallelstore_stub.create_instance request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # Updates the parameters of a single Instance.
+              # Updates the parameters of a single instance.
               #
               # @overload update_instance(request, options = nil)
               #   Pass arguments to `update_instance` via a request object, either of type
@@ -510,12 +527,12 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
-              #     Required. Mask of fields to update .Field mask is used to specify the
+              #     Required. Mask of fields to update. Field mask is used to specify the
               #     fields to be overwritten in the Instance resource by the update. At least
               #     one path must be supplied in this field. The fields specified in the
               #     update_mask are relative to the resource, not the full request.
               #   @param instance [::Google::Cloud::Parallelstore::V1beta::Instance, ::Hash]
-              #     Required. The instance to update
+              #     Required. The instance to update.
               #   @param request_id [::String]
               #     Optional. An optional request ID to identify requests. Specify a unique
               #     request ID so that if you must retry your request, the server will know to
@@ -591,14 +608,14 @@ module Google
                 @parallelstore_stub.update_instance request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # Deletes a single Instance.
+              # Deletes a single instance.
               #
               # @overload delete_instance(request, options = nil)
               #   Pass arguments to `delete_instance` via a request object, either of type
@@ -692,14 +709,14 @@ module Google
                 @parallelstore_stub.delete_instance request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # ImportData copies data from Cloud Storage to Parallelstore.
+              # Copies data from Cloud Storage to Parallelstore.
               #
               # @overload import_data(request, options = nil)
               #   Pass arguments to `import_data` via a request object, either of type
@@ -717,7 +734,7 @@ module Google
               #   the default parameter values, pass an empty Hash as a request object (see above).
               #
               #   @param source_gcs_bucket [::Google::Cloud::Parallelstore::V1beta::SourceGcsBucket, ::Hash]
-              #     Cloud Storage source.
+              #     The Cloud Storage source bucket and, optionally, path inside the bucket.
               #   @param destination_parallelstore [::Google::Cloud::Parallelstore::V1beta::DestinationParallelstore, ::Hash]
               #     Parallelstore destination.
               #   @param name [::String]
@@ -737,11 +754,17 @@ module Google
               #     The request ID must be a valid UUID with the exception that zero UUID is
               #     not supported (00000000-0000-0000-0000-000000000000).
               #   @param service_account [::String]
-              #     Optional. User-specified Service Account (SA) credentials to be used when
+              #     Optional. User-specified service account credentials to be used when
               #     performing the transfer.
-              #     Format: `projects/{project_id}/serviceAccounts/{service_account}`
+              #
+              #     Use one of the following formats:
+              #
+              #     * `{EMAIL_ADDRESS_OR_UNIQUE_ID}`
+              #     * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}`
+              #     * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}`
+              #
               #     If unspecified, the Parallelstore service agent is used:
-              #     service-<PROJECT_NUMBER>@gcp-sa-parallelstore.iam.gserviceaccount.com)
+              #     `service-<PROJECT_NUMBER>@gcp-sa-parallelstore.iam.gserviceaccount.com`
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Operation]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -803,14 +826,14 @@ module Google
                 @parallelstore_stub.import_data request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
               ##
-              # ExportData copies data from Parallelstore to Cloud Storage
+              # Copies data from Parallelstore to Cloud Storage.
               #
               # @overload export_data(request, options = nil)
               #   Pass arguments to `export_data` via a request object, either of type
@@ -850,9 +873,14 @@ module Google
               #   @param service_account [::String]
               #     Optional. User-specified Service Account (SA) credentials to be used when
               #     performing the transfer.
-              #     Format: `projects/{project_id}/serviceAccounts/{service_account}`
+              #     Use one of the following formats:
+              #
+              #     * `{EMAIL_ADDRESS_OR_UNIQUE_ID}`
+              #     * `projects/{PROJECT_ID_OR_NUMBER}/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}`
+              #     * `projects/-/serviceAccounts/{EMAIL_ADDRESS_OR_UNIQUE_ID}`
+              #
               #     If unspecified, the Parallelstore service agent is used:
-              #     service-<PROJECT_NUMBER>@gcp-sa-parallelstore.iam.gserviceaccount.com)
+              #     `service-<PROJECT_NUMBER>@gcp-sa-parallelstore.iam.gserviceaccount.com`
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Gapic::Operation]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -914,7 +942,7 @@ module Google
                 @parallelstore_stub.export_data request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -994,6 +1022,11 @@ module Google
               #   default endpoint URL. The default value of nil uses the environment
               #   universe (usually the default "googleapis.com" universe).
               #   @return [::String,nil]
+              # @!attribute [rw] logger
+              #   A custom logger to use for request/response debug logging, or the value
+              #   `:default` (the default) to construct a default logger, or `nil` to
+              #   explicitly disable logging.
+              #   @return [::Logger,:default,nil]
               #
               class Configuration
                 extend ::Gapic::Config
@@ -1022,6 +1055,7 @@ module Google
                 # by the host service.
                 # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
                 config_attr :bindings_override, {}, ::Hash, nil
+                config_attr :logger, :default, ::Logger, nil, :default
 
                 # @private
                 def initialize parent_config = nil

data/lib/google/cloud/parallelstore/v1beta/parallelstore/rest/operations.rb

@@ -115,14 +115,6 @@ module Google
               # Lists operations that match the specified filter in the request. If the
               # server doesn't support this method, it returns `UNIMPLEMENTED`.
               #
-              # NOTE: the `name` binding allows API services to override the binding
-              # to use different resource name schemes, such as `users/*/operations`. To
-              # override the binding, API services can add a binding such as
-              # `"/v1/{name=users/*}/operations"` to their service configuration.
-              # For backwards compatibility, the default name includes the operations
-              # collection id, however overriding users must ensure the name binding
-              # is the parent resource, without the operations collection id.
-              #
               # @overload list_operations(request, options = nil)
               #   Pass arguments to `list_operations` via a request object, either of type
               #   {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
@@ -204,7 +196,7 @@ module Google
                 @operations_stub.list_operations request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", request, result, options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -293,7 +285,7 @@ module Google
                 @operations_stub.get_operation request, options do |result, operation|
                   result = ::Gapic::Operation.new result, @operations_client, options: options
                   yield result, operation if block_given?
-                  return result
+                  throw :response, result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -375,7 +367,6 @@ module Google
 
                 @operations_stub.delete_operation request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -390,8 +381,9 @@ module Google
               # other methods to check whether the cancellation succeeded or whether the
               # operation completed despite cancellation. On successful cancellation,
               # the operation is not deleted; instead, it becomes an operation with
-              # an {::Google::Longrunning::Operation#error Operation.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
-              # corresponding to `Code.CANCELLED`.
+              # an {::Google::Longrunning::Operation#error Operation.error} value with a
+              # {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
+              # `Code.CANCELLED`.
               #
               # @overload cancel_operation(request, options = nil)
               #   Pass arguments to `cancel_operation` via a request object, either of type
@@ -463,7 +455,6 @@ module Google
 
                 @operations_stub.cancel_operation request, options do |result, operation|
                   yield result, operation if block_given?
-                  return result
                 end
               rescue ::Gapic::Rest::Error => e
                 raise ::Google::Cloud::Error.from_error(e)
@@ -543,6 +534,11 @@ module Google
               #   default endpoint URL. The default value of nil uses the environment
               #   universe (usually the default "googleapis.com" universe).
               #   @return [::String,nil]
+              # @!attribute [rw] logger
+              #   A custom logger to use for request/response debug logging, or the value
+              #   `:default` (the default) to construct a default logger, or `nil` to
+              #   explicitly disable logging.
+              #   @return [::Logger,:default,nil]
               #
               class Configuration
                 extend ::Gapic::Config
@@ -564,6 +560,7 @@ module Google
                 config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
                 config_attr :quota_project, nil, ::String, nil
                 config_attr :universe_domain, nil, ::String, nil
+                config_attr :logger, :default, ::Logger, nil, :default
 
                 # @private
                 def initialize parent_config = nil
@@ -683,16 +680,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_operations",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -721,16 +720,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_operation",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -759,16 +760,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "delete_operation",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -797,16 +800,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "cancel_operation",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -886,7 +891,6 @@ module Google
                                                         .with_bindings(
                                                           uri_method: :post,
                                                           uri_template: "/v1beta/{name}:cancel",
-                                                          body: "*",
                                                           matches: [
                                                             ["name", %r{^projects/[^/]+/locations/[^/]+/operations/[^/]+/?$}, false]
                                                           ]

data/lib/google/cloud/parallelstore/v1beta/parallelstore/rest/service_stub.rb

@@ -30,7 +30,8 @@ module Google
             # including transcoding, making the REST call, and deserialing the response.
             #
             class ServiceStub
-              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
+              # @private
+              def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
                 # These require statements are intentionally placed here to initialize
                 # the REST modules only when it's required.
                 require "gapic/rest"
@@ -40,7 +41,9 @@ module Google
                                                              universe_domain: universe_domain,
                                                              credentials: credentials,
                                                              numeric_enums: true,
-                                                             raise_faraday_errors: false
+                                                             service_name: self.class,
+                                                             raise_faraday_errors: false,
+                                                             logger: logger
               end
 
               ##
@@ -61,6 +64,15 @@ module Google
                 @client_stub.endpoint
               end
 
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger stub: false
+                stub ? @client_stub.stub_logger : @client_stub.logger
+              end
+
               ##
               # Baseline implementation for the list_instances REST call
               #
@@ -87,16 +99,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "list_instances",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::Parallelstore::V1beta::ListInstancesResponse.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -125,16 +139,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "get_instance",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Cloud::Parallelstore::V1beta::Instance.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -163,16 +179,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "create_instance",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -201,16 +219,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "update_instance",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -239,16 +259,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "delete_instance",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -277,16 +299,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "import_data",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##
@@ -315,16 +339,18 @@ module Google
 
                 response = @client_stub.make_http_request(
                   verb,
-                  uri:     uri,
-                  body:    body || "",
-                  params:  query_string_params,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "export_data",
                   options: options
                 )
                 operation = ::Gapic::Rest::TransportOperation.new response
                 result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-                yield result, operation if block_given?
-                result
+                catch :response do
+                  yield result, operation if block_given?
+                  result
+                end
               end
 
               ##