google-cloud-parallelstore-v1beta 0.3.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47f1e94e2d9595e2d6049ff69b7457611ea68f9e223645879f3549b367a4d226
-  data.tar.gz: 82362691d7544ac13e41423257a4a0a78364002ff2d6dabebb36c48c93d67535
+  metadata.gz: e9c166e71d9b2e85fd7fda45696eaa8ebcbe718221ddecf86e053fb0b3dc3f26
+  data.tar.gz: a026b4d0530002938908385289d8a999978af66b299f8f69155539759ca319a9
 SHA512:
-  metadata.gz: abdedca29c4d4a37c98601bc95919e7b2e1d2da43bdb0b4e5b6cc9e044d6eb41af17b60e5c6ec37063569d288dcdcb93f6966b04e3d915c91a24a33cab822776
-  data.tar.gz: 391f9138550060507b6b6bfcb685bedbf0a5a1f5b71bd41891412ebf1ed1db741259d3731f99be1de9015dcc2ad565858833737f8a8c2ed9e5134eb98bce569a
+  metadata.gz: bf3ccb73fcc2fe42f20ac06c78a9e75725f75f33b26abc13a63a9ad1c79abdcefafbf42ddc83ba5438c0a5dcef23dbfe59e3348968e12078d6983b3096131a49
+  data.tar.gz: d6047fa52a47504ce002e284c21285eb511019a91bd7408563788b5d3b9b43709224c67291c2c3e38ad5c1cb9eb6b78e6fd31c3f09cc2e411046de627e56726c

data/README.md

@@ -43,33 +43,43 @@ for class and method documentation.
 See also the [Product Documentation](https://cloud.google.com/parallelstore?hl=en)
 for general usage information.
 
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
-that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-
-Configuring a Ruby stdlib logger:
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+You can customize logging by modifying the `logger` configuration when
+constructing a client object. For example:
 
 ```ruby
+require "google/cloud/parallelstore/v1beta"
 require "logger"
 
-module MyLogger
-  LOGGER = Logger.new $stderr, level: Logger::WARN
-  def logger
-    LOGGER
-  end
-end
-
-# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-module GRPC
-  extend MyLogger
+client = ::Google::Cloud::Parallelstore::V1beta::Parallelstore::Client.new do |config|
+  config.logger = Logger.new "my-app.log"
 end
 ```
 
-
 ## Google Cloud Samples
 
 To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).

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

@@ -179,14 +179,26 @@ module Google
                 universe_domain: @config.universe_domain,
                 channel_args: @config.channel_args,
                 interceptors: @config.interceptors,
-                channel_pool_config: @config.channel_pool
+                channel_pool_config: @config.channel_pool,
+                logger: @config.logger
               )
 
+              @parallelstore_stub.stub_logger&.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::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.logger = @parallelstore_stub.logger if config.respond_to? :logger=
               end
             end
 
@@ -204,10 +216,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
@@ -227,19 +248,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 [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Parallelstore::V1beta::Instance>]
@@ -305,14 +325,14 @@ module Google
               @parallelstore_stub.call_rpc :list_instances, request, options: options do |response, operation|
                 response = ::Gapic::PagedEnumerable.new @parallelstore_stub, :list_instances, request, response, operation, options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => 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
@@ -392,7 +412,6 @@ module Google
 
               @parallelstore_stub.call_rpc :get_instance, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -419,10 +438,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.
@@ -513,14 +531,14 @@ module Google
               @parallelstore_stub.call_rpc :create_instance, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => 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
@@ -538,12 +556,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
@@ -626,14 +644,14 @@ module Google
               @parallelstore_stub.call_rpc :update_instance, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => 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
@@ -734,14 +752,14 @@ module Google
               @parallelstore_stub.call_rpc :delete_instance, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => 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
@@ -759,7 +777,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]
@@ -779,11 +797,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 [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -852,14 +876,14 @@ module Google
               @parallelstore_stub.call_rpc :import_data, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => 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
@@ -899,9 +923,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 [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Gapic::Operation]
@@ -970,7 +999,7 @@ module Google
               @parallelstore_stub.call_rpc :export_data, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -1059,6 +1088,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
@@ -1083,6 +1117,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

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

@@ -124,14 +124,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.
@@ -221,7 +213,7 @@ module Google
                 wrap_lro_operation = ->(op_response) { ::Gapic::Operation.new op_response, @operations_client }
                 response = ::Gapic::PagedEnumerable.new @operations_stub, :list_operations, request, response, operation, options, format_resource: wrap_lro_operation
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -317,7 +309,7 @@ module Google
               @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -406,7 +398,6 @@ module Google
 
               @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -421,8 +412,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
@@ -501,7 +493,6 @@ module Google
 
               @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
                 yield response, operation if block_given?
-                return response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -599,7 +590,7 @@ module Google
               @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
                 response = ::Gapic::Operation.new response, @operations_client, options: options
                 yield response, operation if block_given?
-                return response
+                throw :response, response
               end
             rescue ::GRPC::BadStatus => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -688,6 +679,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
@@ -712,6 +708,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