google-cloud-dialogflow-cx-v3 1.1.1 → 1.3.0

data/lib/google/cloud/dialogflow/cx/v3/test_cases/rest/client.rb

@@ -165,15 +165,27 @@ module Google
                     endpoint: @config.endpoint,
                     endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                     universe_domain: @config.universe_domain,
-                    credentials: credentials
+                    credentials: credentials,
+                    logger: @config.logger
                   )
 
+                  @test_cases_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 = @test_cases_stub.endpoint
                     config.universe_domain = @test_cases_stub.universe_domain
                     config.bindings_override = @config.bindings_override
+                    config.logger = @test_cases_stub.logger if config.respond_to? :logger=
                   end
                 end
 
@@ -191,6 +203,15 @@ module Google
                 #
                 attr_reader :location_client
 
+                ##
+                # The logger used for request/response debug logging.
+                #
+                # @return [Logger]
+                #
+                def logger
+                  @test_cases_stub.logger
+                end
+
                 # Service calls
 
                 ##
@@ -213,7 +234,7 @@ module Google
                 #
                 #   @param parent [::String]
                 #     Required. The agent to list all pages for.
-                #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+                #     Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
                 #   @param page_size [::Integer]
                 #     The maximum number of items to return in a single page. By default 20.
                 #     Note that when TestCaseView = FULL, the maximum page size allowed is 20.
@@ -280,7 +301,7 @@ module Google
                   @test_cases_stub.list_test_cases request, options do |result, operation|
                     result = ::Gapic::Rest::PagedEnumerable.new @test_cases_stub, :list_test_cases, "test_cases", 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)
@@ -306,10 +327,10 @@ module Google
                 #
                 #   @param parent [::String]
                 #     Required. The agent to delete test cases from.
-                #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+                #     Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
                 #   @param names [::Array<::String>]
-                #     Required. Format of test case names: `projects/<Project ID>/locations/
-                #     <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`.
+                #     Required. Format of test case names:
+                #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`.
                 # @yield [result, operation] Access the result along with the TransportOperation object
                 # @yieldparam result [::Google::Protobuf::Empty]
                 # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -363,7 +384,6 @@ module Google
 
                   @test_cases_stub.batch_delete_test_cases 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)
@@ -389,8 +409,8 @@ module Google
                 #
                 #   @param name [::String]
                 #     Required. The name of the testcase.
-                #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
-                #     ID>/testCases/<TestCase ID>`.
+                #     Format:
+                #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`.
                 # @yield [result, operation] Access the result along with the TransportOperation object
                 # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::TestCase]
                 # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -444,7 +464,6 @@ module Google
 
                   @test_cases_stub.get_test_case 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)
@@ -470,7 +489,7 @@ module Google
                 #
                 #   @param parent [::String]
                 #     Required. The agent to create the test case for.
-                #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+                #     Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
                 #   @param test_case [::Google::Cloud::Dialogflow::CX::V3::TestCase, ::Hash]
                 #     Required. The test case to create.
                 # @yield [result, operation] Access the result along with the TransportOperation object
@@ -526,7 +545,6 @@ module Google
 
                   @test_cases_stub.create_test_case 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)
@@ -610,7 +628,6 @@ module Google
 
                   @test_cases_stub.update_test_case 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)
@@ -644,12 +661,12 @@ module Google
                 #   the default parameter values, pass an empty Hash as a request object (see above).
                 #
                 #   @param name [::String]
-                #     Required. Format of test case name to run: `projects/<Project
-                #     ID>/locations/ <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`.
+                #     Required. Format of test case name to run:
+                #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`.
                 #   @param environment [::String]
                 #     Optional. Environment name. If not set, draft environment is assumed.
-                #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
-                #     ID>/environments/<Environment ID>`.
+                #     Format:
+                #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
                 # @yield [result, operation] Access the result along with the TransportOperation object
                 # @yieldparam result [::Gapic::Operation]
                 # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -711,7 +728,7 @@ module Google
                   @test_cases_stub.run_test_case 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)
@@ -745,15 +762,14 @@ module Google
                 #   the default parameter values, pass an empty Hash as a request object (see above).
                 #
                 #   @param parent [::String]
-                #     Required. Agent name. Format: `projects/<Project ID>/locations/<Location
-                #     ID>/agents/ <AgentID>`.
+                #     Required. Agent name. Format:
+                #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
                 #   @param environment [::String]
                 #     Optional. If not set, draft environment is assumed. Format:
-                #     `projects/<Project ID>/locations/<Location ID>/agents/<Agent
-                #     ID>/environments/<Environment ID>`.
+                #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>`.
                 #   @param test_cases [::Array<::String>]
-                #     Required. Format: `projects/<Project ID>/locations/<Location
-                #     ID>/agents/<Agent ID>/testCases/<TestCase ID>`.
+                #     Required. Format:
+                #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`.
                 # @yield [result, operation] Access the result along with the TransportOperation object
                 # @yieldparam result [::Gapic::Operation]
                 # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -815,7 +831,7 @@ module Google
                   @test_cases_stub.batch_run_test_cases 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)
@@ -841,7 +857,7 @@ module Google
                 #
                 #   @param agent [::String]
                 #     Required. The agent to calculate coverage for.
-                #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+                #     Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
                 #   @param type [::Google::Cloud::Dialogflow::CX::V3::CalculateCoverageRequest::CoverageType]
                 #     Required. The type of coverage requested.
                 # @yield [result, operation] Access the result along with the TransportOperation object
@@ -897,7 +913,6 @@ module Google
 
                   @test_cases_stub.calculate_coverage 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)
@@ -934,7 +949,7 @@ module Google
                 #
                 #   @param parent [::String]
                 #     Required. The agent to import test cases to.
-                #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+                #     Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
                 #   @param gcs_uri [::String]
                 #     The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI
                 #     to import test cases from. The format of this URI must be
@@ -1008,7 +1023,7 @@ module Google
                   @test_cases_stub.import_test_cases 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)
@@ -1044,7 +1059,7 @@ module Google
                 #
                 #   @param parent [::String]
                 #     Required. The agent where to export test cases from.
-                #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
+                #     Format: `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>`.
                 #   @param gcs_uri [::String]
                 #     The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to
                 #     export the test cases to. The format of this URI must be
@@ -1131,7 +1146,7 @@ module Google
                   @test_cases_stub.export_test_cases 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)
@@ -1158,9 +1173,10 @@ module Google
                 #
                 #   @param parent [::String]
                 #     Required. The test case to list results for.
-                #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/
-                #     testCases/<TestCase ID>`. Specify a `-` as a wildcard for TestCase ID to
-                #     list results across multiple test cases.
+                #     Format:
+                #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>`.
+                #     Specify a `-` as a wildcard for TestCase ID to
+                #      list results across multiple test cases.
                 #   @param page_size [::Integer]
                 #     The maximum number of items to return in a single page. By default 100 and
                 #     at most 1000.
@@ -1249,7 +1265,7 @@ module Google
                   @test_cases_stub.list_test_case_results request, options do |result, operation|
                     result = ::Gapic::Rest::PagedEnumerable.new @test_cases_stub, :list_test_case_results, "test_case_results", 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)
@@ -1275,8 +1291,8 @@ module Google
                 #
                 #   @param name [::String]
                 #     Required. The name of the testcase.
-                #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
-                #     ID>/testCases/<TestCase ID>/results/<TestCaseResult ID>`.
+                #     Format:
+                #     `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/testCases/<TestCaseID>/results/<TestCaseResultID>`.
                 # @yield [result, operation] Access the result along with the TransportOperation object
                 # @yieldparam result [::Google::Cloud::Dialogflow::CX::V3::TestCaseResult]
                 # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -1330,7 +1346,6 @@ module Google
 
                   @test_cases_stub.get_test_case_result 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)
@@ -1410,6 +1425,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
@@ -1438,6 +1458,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/dialogflow/cx/v3/test_cases/rest/operations.rb

@@ -116,14 +116,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.
@@ -205,7 +197,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)
@@ -294,7 +286,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)
@@ -376,7 +368,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)
@@ -391,8 +382,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
@@ -464,7 +456,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)
@@ -544,6 +535,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
@@ -565,6 +561,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
@@ -684,16 +681,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
 
                 ##
@@ -722,16 +721,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
 
                 ##
@@ -760,16 +761,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
 
                 ##
@@ -798,16 +801,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
 
                 ##