# frozen_string_literal: true
# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
require "google/cloud/errors"
require "google/cloud/dialogflow/cx/v3/test_case_pb"
require "google/cloud/location"
module Google
module Cloud
module Dialogflow
module CX
module V3
module TestCases
##
# Client for the TestCases service.
#
# Service for managing {::Google::Cloud::Dialogflow::CX::V3::TestCase Test Cases} and
# {::Google::Cloud::Dialogflow::CX::V3::TestCaseResult Test Case Results}.
#
class Client
# @private
DEFAULT_ENDPOINT_TEMPLATE = "dialogflow.$UNIVERSE_DOMAIN$"
include Paths
# @private
attr_reader :test_cases_stub
##
# Configure the TestCases Client class.
#
# See {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client::Configuration}
# for a description of the configuration fields.
#
# @example
#
# # Modify the configuration for all TestCases clients
# ::Google::Cloud::Dialogflow::CX::V3::TestCases::Client.configure do |config|
# config.timeout = 10.0
# end
#
# @yield [config] Configure the Client client.
# @yieldparam config [Client::Configuration]
#
# @return [Client::Configuration]
#
def self.configure
@configure ||= begin
namespace = ["Google", "Cloud", "Dialogflow", "CX", "V3"]
parent_config = while namespace.any?
parent_name = namespace.join "::"
parent_const = const_get parent_name
break parent_const.configure if parent_const.respond_to? :configure
namespace.pop
end
default_config = Client::Configuration.new parent_config
default_config.timeout = 60.0
default_config.retry_policy = {
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
}
default_config
end
yield @configure if block_given?
@configure
end
##
# Configure the TestCases Client instance.
#
# The configuration is set to the derived mode, meaning that values can be changed,
# but structural changes (adding new fields, etc.) are not allowed. Structural changes
# should be made on {Client.configure}.
#
# See {::Google::Cloud::Dialogflow::CX::V3::TestCases::Client::Configuration}
# for a description of the configuration fields.
#
# @yield [config] Configure the Client client.
# @yieldparam config [Client::Configuration]
#
# @return [Client::Configuration]
#
def configure
yield @config if block_given?
@config
end
##
# The effective universe domain
#
# @return [String]
#
def universe_domain
@test_cases_stub.universe_domain
end
##
# Create a new TestCases client object.
#
# @example
#
# # Create a client using the default configuration
# client = ::Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new
#
# # Create a client using a custom configuration
# client = ::Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new do |config|
# config.timeout = 10.0
# end
#
# @yield [config] Configure the TestCases client.
# @yieldparam config [Client::Configuration]
#
def initialize
# These require statements are intentionally placed here to initialize
# the gRPC module only when it's required.
# See https://github.com/googleapis/toolkit/issues/446
require "gapic/grpc"
require "google/cloud/dialogflow/cx/v3/test_case_services_pb"
# Create the configuration object
@config = Configuration.new Client.configure
# Yield the configuration if needed
yield @config if block_given?
# Create credentials
credentials = @config.credentials
# 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.nil? ||
(@config.endpoint == Configuration::DEFAULT_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
@operations_client = Operations.new do |config|
config.credentials = credentials
config.quota_project = @quota_project_id
config.endpoint = @config.endpoint
config.universe_domain = @config.universe_domain
end
@test_cases_stub = ::Gapic::ServiceStub.new(
::Google::Cloud::Dialogflow::CX::V3::TestCases::Stub,
credentials: credentials,
endpoint: @config.endpoint,
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
universe_domain: @config.universe_domain,
channel_args: @config.channel_args,
interceptors: @config.interceptors,
channel_pool_config: @config.channel_pool
)
@location_client = Google::Cloud::Location::Locations::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
end
end
##
# Get the associated client for long-running operations.
#
# @return [::Google::Cloud::Dialogflow::CX::V3::TestCases::Operations]
#
attr_reader :operations_client
##
# Get the associated client for mix-in of the Locations.
#
# @return [Google::Cloud::Location::Locations::Client]
#
attr_reader :location_client
# Service calls
##
# Fetches a list of test cases for a given agent.
#
# @overload list_test_cases(request, options = nil)
# Pass arguments to `list_test_cases` via a request object, either of type
# {::Google::Cloud::Dialogflow::CX::V3::ListTestCasesRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::CX::V3::ListTestCasesRequest, ::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.
#
# @overload list_test_cases(parent: nil, page_size: nil, page_token: nil, view: nil)
# Pass arguments to `list_test_cases` 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).
#
# @param parent [::String]
# Required. The agent to list all pages for.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
# @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.
# When TestCaseView = BASIC, the maximum page size allowed is 500.
# @param page_token [::String]
# The next_page_token value returned from a previous list request.
# @param view [::Google::Cloud::Dialogflow::CX::V3::ListTestCasesRequest::TestCaseView]
# Specifies whether response should include all fields or just the metadata.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::TestCase>]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::TestCase>]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/cx/v3"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::CX::V3::ListTestCasesRequest.new
#
# # Call the list_test_cases method.
# result = client.list_test_cases request
#
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
# # over elements, and API calls will be issued to fetch pages as needed.
# result.each do |item|
# # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::TestCase.
# p item
# end
#
def list_test_cases request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ListTestCasesRequest
# Converts hash and nil to an options object
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.list_test_cases.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::Dialogflow::CX::V3::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.list_test_cases.timeout,
metadata: metadata,
retry_policy: @config.rpcs.list_test_cases.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@test_cases_stub.call_rpc :list_test_cases, request, options: options do |response, operation|
response = ::Gapic::PagedEnumerable.new @test_cases_stub, :list_test_cases, request, response, operation, options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Batch deletes test cases.
#
# @overload batch_delete_test_cases(request, options = nil)
# Pass arguments to `batch_delete_test_cases` via a request object, either of type
# {::Google::Cloud::Dialogflow::CX::V3::BatchDeleteTestCasesRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::CX::V3::BatchDeleteTestCasesRequest, ::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.
#
# @overload batch_delete_test_cases(parent: nil, names: nil)
# Pass arguments to `batch_delete_test_cases` 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).
#
# @param parent [::String]
# Required. The agent to delete test cases from.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
# @param names [::Array<::String>]
# Required. Format of test case names: `projects/<Project ID>/locations/
# <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Protobuf::Empty]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Protobuf::Empty]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/cx/v3"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::CX::V3::BatchDeleteTestCasesRequest.new
#
# # Call the batch_delete_test_cases method.
# result = client.batch_delete_test_cases request
#
# # The returned object is of type Google::Protobuf::Empty.
# p result
#
def batch_delete_test_cases request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::BatchDeleteTestCasesRequest
# Converts hash and nil to an options object
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.batch_delete_test_cases.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::Dialogflow::CX::V3::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.batch_delete_test_cases.timeout,
metadata: metadata,
retry_policy: @config.rpcs.batch_delete_test_cases.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@test_cases_stub.call_rpc :batch_delete_test_cases, 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)
end
##
# Gets a test case.
#
# @overload get_test_case(request, options = nil)
# Pass arguments to `get_test_case` via a request object, either of type
# {::Google::Cloud::Dialogflow::CX::V3::GetTestCaseRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::CX::V3::GetTestCaseRequest, ::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.
#
# @overload get_test_case(name: nil)
# Pass arguments to `get_test_case` 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).
#
# @param name [::String]
# Required. The name of the testcase.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
# ID>/testCases/<TestCase ID>`.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::TestCase]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::Dialogflow::CX::V3::TestCase]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/cx/v3"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::CX::V3::GetTestCaseRequest.new
#
# # Call the get_test_case method.
# result = client.get_test_case request
#
# # The returned object is of type Google::Cloud::Dialogflow::CX::V3::TestCase.
# p result
#
def get_test_case request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::GetTestCaseRequest
# Converts hash and nil to an options object
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.get_test_case.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::Dialogflow::CX::V3::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.get_test_case.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_test_case.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@test_cases_stub.call_rpc :get_test_case, 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)
end
##
# Creates a test case for the given agent.
#
# @overload create_test_case(request, options = nil)
# Pass arguments to `create_test_case` via a request object, either of type
# {::Google::Cloud::Dialogflow::CX::V3::CreateTestCaseRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::CX::V3::CreateTestCaseRequest, ::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.
#
# @overload create_test_case(parent: nil, test_case: nil)
# Pass arguments to `create_test_case` 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).
#
# @param parent [::String]
# Required. The agent to create the test case for.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
# @param test_case [::Google::Cloud::Dialogflow::CX::V3::TestCase, ::Hash]
# Required. The test case to create.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::TestCase]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::Dialogflow::CX::V3::TestCase]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/cx/v3"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::CX::V3::CreateTestCaseRequest.new
#
# # Call the create_test_case method.
# result = client.create_test_case request
#
# # The returned object is of type Google::Cloud::Dialogflow::CX::V3::TestCase.
# p result
#
def create_test_case request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::CreateTestCaseRequest
# Converts hash and nil to an options object
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.create_test_case.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::Dialogflow::CX::V3::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.create_test_case.timeout,
metadata: metadata,
retry_policy: @config.rpcs.create_test_case.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@test_cases_stub.call_rpc :create_test_case, 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)
end
##
# Updates the specified test case.
#
# @overload update_test_case(request, options = nil)
# Pass arguments to `update_test_case` via a request object, either of type
# {::Google::Cloud::Dialogflow::CX::V3::UpdateTestCaseRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::CX::V3::UpdateTestCaseRequest, ::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.
#
# @overload update_test_case(test_case: nil, update_mask: nil)
# Pass arguments to `update_test_case` 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).
#
# @param test_case [::Google::Cloud::Dialogflow::CX::V3::TestCase, ::Hash]
# Required. The test case to update.
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
# Required. The mask to specify which fields should be updated. The
# {::Google::Cloud::Dialogflow::CX::V3::TestCase#creation_time `creationTime`} and
# {::Google::Cloud::Dialogflow::CX::V3::TestCase#last_test_result `lastTestResult`}
# cannot be updated.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::TestCase]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::Dialogflow::CX::V3::TestCase]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/cx/v3"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::CX::V3::UpdateTestCaseRequest.new
#
# # Call the update_test_case method.
# result = client.update_test_case request
#
# # The returned object is of type Google::Cloud::Dialogflow::CX::V3::TestCase.
# p result
#
def update_test_case request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::UpdateTestCaseRequest
# Converts hash and nil to an options object
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.update_test_case.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::Dialogflow::CX::V3::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.test_case&.name
header_params["test_case.name"] = request.test_case.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.update_test_case.timeout,
metadata: metadata,
retry_policy: @config.rpcs.update_test_case.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@test_cases_stub.call_rpc :update_test_case, 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)
end
##
# Kicks off a test case run.
#
# This method is a [long-running
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
# The returned `Operation` type has the following method-specific fields:
#
# - `metadata`:
# {::Google::Cloud::Dialogflow::CX::V3::RunTestCaseMetadata RunTestCaseMetadata}
# - `response`:
# {::Google::Cloud::Dialogflow::CX::V3::RunTestCaseResponse RunTestCaseResponse}
#
# @overload run_test_case(request, options = nil)
# Pass arguments to `run_test_case` via a request object, either of type
# {::Google::Cloud::Dialogflow::CX::V3::RunTestCaseRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::CX::V3::RunTestCaseRequest, ::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.
#
# @overload run_test_case(name: nil, environment: nil)
# Pass arguments to `run_test_case` 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).
#
# @param name [::String]
# Required. Format of test case name to run: `projects/<Project
# ID>/locations/ <Location ID>/agents/<AgentID>/testCases/<TestCase ID>`.
# @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>`.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::Operation]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/cx/v3"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::CX::V3::RunTestCaseRequest.new
#
# # Call the run_test_case method.
# result = client.run_test_case request
#
# # The returned object is of type Gapic::Operation. You can use it to
# # check the status of an operation, cancel it, or wait for results.
# # Here is how to wait for a response.
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "No response received."
# end
#
def run_test_case request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::RunTestCaseRequest
# Converts hash and nil to an options object
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.run_test_case.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::Dialogflow::CX::V3::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.run_test_case.timeout,
metadata: metadata,
retry_policy: @config.rpcs.run_test_case.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@test_cases_stub.call_rpc :run_test_case, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Kicks off a batch run of test cases.
#
# This method is a [long-running
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
# The returned `Operation` type has the following method-specific fields:
#
# - `metadata`:
# {::Google::Cloud::Dialogflow::CX::V3::BatchRunTestCasesMetadata BatchRunTestCasesMetadata}
# - `response`:
# {::Google::Cloud::Dialogflow::CX::V3::BatchRunTestCasesResponse BatchRunTestCasesResponse}
#
# @overload batch_run_test_cases(request, options = nil)
# Pass arguments to `batch_run_test_cases` via a request object, either of type
# {::Google::Cloud::Dialogflow::CX::V3::BatchRunTestCasesRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::CX::V3::BatchRunTestCasesRequest, ::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.
#
# @overload batch_run_test_cases(parent: nil, environment: nil, test_cases: nil)
# Pass arguments to `batch_run_test_cases` 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).
#
# @param parent [::String]
# Required. Agent name. Format: `projects/<Project ID>/locations/<Location
# ID>/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>`.
# @param test_cases [::Array<::String>]
# Required. Format: `projects/<Project ID>/locations/<Location
# ID>/agents/<Agent ID>/testCases/<TestCase ID>`.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::Operation]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/cx/v3"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::CX::V3::BatchRunTestCasesRequest.new
#
# # Call the batch_run_test_cases method.
# result = client.batch_run_test_cases request
#
# # The returned object is of type Gapic::Operation. You can use it to
# # check the status of an operation, cancel it, or wait for results.
# # Here is how to wait for a response.
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "No response received."
# end
#
def batch_run_test_cases request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::BatchRunTestCasesRequest
# Converts hash and nil to an options object
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.batch_run_test_cases.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::Dialogflow::CX::V3::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.batch_run_test_cases.timeout,
metadata: metadata,
retry_policy: @config.rpcs.batch_run_test_cases.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@test_cases_stub.call_rpc :batch_run_test_cases, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Calculates the test coverage for an agent.
#
# @overload calculate_coverage(request, options = nil)
# Pass arguments to `calculate_coverage` via a request object, either of type
# {::Google::Cloud::Dialogflow::CX::V3::CalculateCoverageRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::CX::V3::CalculateCoverageRequest, ::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.
#
# @overload calculate_coverage(agent: nil, type: nil)
# Pass arguments to `calculate_coverage` 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).
#
# @param agent [::String]
# Required. The agent to calculate coverage for.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
# @param type [::Google::Cloud::Dialogflow::CX::V3::CalculateCoverageRequest::CoverageType]
# Required. The type of coverage requested.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::CalculateCoverageResponse]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::Dialogflow::CX::V3::CalculateCoverageResponse]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/cx/v3"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::CX::V3::CalculateCoverageRequest.new
#
# # Call the calculate_coverage method.
# result = client.calculate_coverage request
#
# # The returned object is of type Google::Cloud::Dialogflow::CX::V3::CalculateCoverageResponse.
# p result
#
def calculate_coverage request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::CalculateCoverageRequest
# Converts hash and nil to an options object
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.calculate_coverage.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::Dialogflow::CX::V3::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.agent
header_params["agent"] = request.agent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.calculate_coverage.timeout,
metadata: metadata,
retry_policy: @config.rpcs.calculate_coverage.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@test_cases_stub.call_rpc :calculate_coverage, 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)
end
##
# Imports the test cases from a Cloud Storage bucket or a local file. It
# always creates new test cases and won't overwrite any existing ones. The
# provided ID in the imported test case is neglected.
#
# This method is a [long-running
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
# The returned `Operation` type has the following method-specific fields:
#
# - `metadata`:
# {::Google::Cloud::Dialogflow::CX::V3::ImportTestCasesMetadata ImportTestCasesMetadata}
# - `response`:
# {::Google::Cloud::Dialogflow::CX::V3::ImportTestCasesResponse ImportTestCasesResponse}
#
# @overload import_test_cases(request, options = nil)
# Pass arguments to `import_test_cases` via a request object, either of type
# {::Google::Cloud::Dialogflow::CX::V3::ImportTestCasesRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::CX::V3::ImportTestCasesRequest, ::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.
#
# @overload import_test_cases(parent: nil, gcs_uri: nil, content: nil)
# Pass arguments to `import_test_cases` 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).
#
# @param parent [::String]
# Required. The agent to import test cases to.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
# @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
# `gs://<bucket-name>/<object-name>`.
#
# Dialogflow performs a read operation for the Cloud Storage object
# on the caller's behalf, so your request authentication must
# have read permissions for the object. For more information, see
# [Dialogflow access
# control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
# @param content [::String]
# Uncompressed raw byte content for test cases.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::Operation]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/cx/v3"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::CX::V3::ImportTestCasesRequest.new
#
# # Call the import_test_cases method.
# result = client.import_test_cases request
#
# # The returned object is of type Gapic::Operation. You can use it to
# # check the status of an operation, cancel it, or wait for results.
# # Here is how to wait for a response.
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "No response received."
# end
#
def import_test_cases request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ImportTestCasesRequest
# Converts hash and nil to an options object
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.import_test_cases.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::Dialogflow::CX::V3::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.import_test_cases.timeout,
metadata: metadata,
retry_policy: @config.rpcs.import_test_cases.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@test_cases_stub.call_rpc :import_test_cases, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Exports the test cases under the agent to a Cloud Storage bucket or a local
# file. Filter can be applied to export a subset of test cases.
#
# This method is a [long-running
# operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation).
# The returned `Operation` type has the following method-specific fields:
#
# - `metadata`:
# {::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesMetadata ExportTestCasesMetadata}
# - `response`:
# {::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesResponse ExportTestCasesResponse}
#
# @overload export_test_cases(request, options = nil)
# Pass arguments to `export_test_cases` via a request object, either of type
# {::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesRequest, ::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.
#
# @overload export_test_cases(parent: nil, gcs_uri: nil, data_format: nil, filter: nil)
# Pass arguments to `export_test_cases` 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).
#
# @param parent [::String]
# Required. The agent where to export test cases from.
# Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>`.
# @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
# `gs://<bucket-name>/<object-name>`. If unspecified, the serialized test
# cases is returned inline.
#
# Dialogflow performs a write operation for the Cloud Storage object
# on the caller's behalf, so your request authentication must
# have write permissions for the object. For more information, see
# [Dialogflow access
# control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).
# @param data_format [::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesRequest::DataFormat]
# The data format of the exported test cases. If not specified, `BLOB` is
# assumed.
# @param filter [::String]
# The filter expression used to filter exported test cases, see
# [API Filtering](https://aip.dev/160). The expression is case insensitive
# and supports the following syntax:
#
# name = <value> [OR name = <value>] ...
#
# For example:
#
# * "name = t1 OR name = t2" matches the test case with the exact resource
# name "t1" or "t2".
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::Operation]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::Operation]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/cx/v3"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::CX::V3::ExportTestCasesRequest.new
#
# # Call the export_test_cases method.
# result = client.export_test_cases request
#
# # The returned object is of type Gapic::Operation. You can use it to
# # check the status of an operation, cancel it, or wait for results.
# # Here is how to wait for a response.
# result.wait_until_done! timeout: 60
# if result.response?
# p result.response
# else
# puts "No response received."
# end
#
def export_test_cases request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ExportTestCasesRequest
# Converts hash and nil to an options object
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.export_test_cases.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::Dialogflow::CX::V3::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.export_test_cases.timeout,
metadata: metadata,
retry_policy: @config.rpcs.export_test_cases.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@test_cases_stub.call_rpc :export_test_cases, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Fetches the list of run results for the given test case. A maximum of 100
# results are kept for each test case.
#
# @overload list_test_case_results(request, options = nil)
# Pass arguments to `list_test_case_results` via a request object, either of type
# {::Google::Cloud::Dialogflow::CX::V3::ListTestCaseResultsRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::CX::V3::ListTestCaseResultsRequest, ::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.
#
# @overload list_test_case_results(parent: nil, page_size: nil, page_token: nil, filter: nil)
# Pass arguments to `list_test_case_results` 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).
#
# @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.
# @param page_size [::Integer]
# The maximum number of items to return in a single page. By default 100 and
# at most 1000.
# @param page_token [::String]
# The next_page_token value returned from a previous list request.
# @param filter [::String]
# The filter expression used to filter test case results. See
# [API Filtering](https://aip.dev/160).
#
# The expression is case insensitive. Only 'AND' is supported for logical
# operators. The supported syntax is listed below in detail:
#
# <field> <operator> <value> [AND <field> <operator> <value>] ...
# [AND latest]
#
# The supported fields and operators are:
# field operator
# `environment` `=`, `IN` (Use value `draft` for draft environment)
# `test_time` `>`, `<`
#
# `latest` only returns the latest test result in all results for each test
# case.
#
# Examples:
# * "environment=draft AND latest" matches the latest test result for each
# test case in the draft environment.
# * "environment IN (e1,e2)" matches any test case results with an
# environment resource name of either "e1" or "e2".
# * "test_time > 1602540713" matches any test case results with test time
# later than a unix timestamp in seconds 1602540713.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::TestCaseResult>]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Gapic::PagedEnumerable<::Google::Cloud::Dialogflow::CX::V3::TestCaseResult>]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/cx/v3"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::CX::V3::ListTestCaseResultsRequest.new
#
# # Call the list_test_case_results method.
# result = client.list_test_case_results request
#
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
# # over elements, and API calls will be issued to fetch pages as needed.
# result.each do |item|
# # Each element is of type ::Google::Cloud::Dialogflow::CX::V3::TestCaseResult.
# p item
# end
#
def list_test_case_results request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::ListTestCaseResultsRequest
# Converts hash and nil to an options object
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.list_test_case_results.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::Dialogflow::CX::V3::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.parent
header_params["parent"] = request.parent
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.list_test_case_results.timeout,
metadata: metadata,
retry_policy: @config.rpcs.list_test_case_results.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@test_cases_stub.call_rpc :list_test_case_results, request, options: options do |response, operation|
response = ::Gapic::PagedEnumerable.new @test_cases_stub, :list_test_case_results, request, response, operation, options
yield response, operation if block_given?
return response
end
rescue ::GRPC::BadStatus => e
raise ::Google::Cloud::Error.from_error(e)
end
##
# Gets a test case result.
#
# @overload get_test_case_result(request, options = nil)
# Pass arguments to `get_test_case_result` via a request object, either of type
# {::Google::Cloud::Dialogflow::CX::V3::GetTestCaseResultRequest} or an equivalent Hash.
#
# @param request [::Google::Cloud::Dialogflow::CX::V3::GetTestCaseResultRequest, ::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.
#
# @overload get_test_case_result(name: nil)
# Pass arguments to `get_test_case_result` 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).
#
# @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>`.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::Dialogflow::CX::V3::TestCaseResult]
# @yieldparam operation [::GRPC::ActiveCall::Operation]
#
# @return [::Google::Cloud::Dialogflow::CX::V3::TestCaseResult]
#
# @raise [::Google::Cloud::Error] if the RPC is aborted.
#
# @example Basic example
# require "google/cloud/dialogflow/cx/v3"
#
# # Create a client object. The client can be reused for multiple calls.
# client = Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new
#
# # Create a request. To set request fields, pass in keyword arguments.
# request = Google::Cloud::Dialogflow::CX::V3::GetTestCaseResultRequest.new
#
# # Call the get_test_case_result method.
# result = client.get_test_case_result request
#
# # The returned object is of type Google::Cloud::Dialogflow::CX::V3::TestCaseResult.
# p result
#
def get_test_case_result request, options = nil
raise ::ArgumentError, "request must be provided" if request.nil?
request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Dialogflow::CX::V3::GetTestCaseResultRequest
# Converts hash and nil to an options object
options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
# Customize the options with defaults
metadata = @config.rpcs.get_test_case_result.metadata.to_h
# Set x-goog-api-client and x-goog-user-project headers
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::Dialogflow::CX::V3::VERSION
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
header_params = {}
if request.name
header_params["name"] = request.name
end
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.get_test_case_result.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_test_case_result.retry_policy
options.apply_defaults timeout: @config.timeout,
metadata: @config.metadata,
retry_policy: @config.retry_policy
@test_cases_stub.call_rpc :get_test_case_result, 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)
end
##
# Configuration class for the TestCases API.
#
# This class represents the configuration for TestCases,
# 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::Dialogflow::CX::V3::TestCases::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.
#
# @example
#
# # Modify the global config, setting the timeout for
# # list_test_cases to 20 seconds,
# # and all remaining timeouts to 10 seconds.
# ::Google::Cloud::Dialogflow::CX::V3::TestCases::Client.configure do |config|
# config.timeout = 10.0
# config.rpcs.list_test_cases.timeout = 20.0
# end
#
# # Apply the above configuration only to a new client.
# client = ::Google::Cloud::Dialogflow::CX::V3::TestCases::Client.new do |config|
# config.timeout = 10.0
# config.rpcs.list_test_cases.timeout = 20.0
# end
#
# @!attribute [rw] endpoint
# A custom service endpoint, as a hostname or hostname:port. The default is
# nil, indicating to use the default endpoint in the current universe domain.
# @return [::String,nil]
# @!attribute [rw] credentials
# Credentials to send with calls. You may provide any of the following types:
# * (`String`) The path to a service account key file in JSON format
# * (`Hash`) A service account key as a Hash
# * (`Google::Auth::Credentials`) A googleauth credentials object
# (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
# * (`Signet::OAuth2::Client`) A signet oauth2 client object
# (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
# * (`GRPC::Core::Channel`) a gRPC channel with included credentials
# * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
# * (`nil`) indicating no credentials
# @return [::Object]
# @!attribute [rw] scope
# The OAuth scopes
# @return [::Array<::String>]
# @!attribute [rw] lib_name
# The library name as recorded in instrumentation and logging
# @return [::String]
# @!attribute [rw] lib_version
# The library version as recorded in instrumentation and logging
# @return [::String]
# @!attribute [rw] channel_args
# Extra parameters passed to the gRPC channel. Note: this is ignored if a
# `GRPC::Core::Channel` object is provided as the credential.
# @return [::Hash]
# @!attribute [rw] interceptors
# An array of interceptors that are run before calls are executed.
# @return [::Array<::GRPC::ClientInterceptor>]
# @!attribute [rw] timeout
# The call timeout in seconds.
# @return [::Numeric]
# @!attribute [rw] metadata
# Additional gRPC 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]
# @!attribute [rw] universe_domain
# The universe domain within which to make requests. This determines the
# default endpoint URL. The default value of nil uses the environment
# universe (usually the default "googleapis.com" universe).
# @return [::String,nil]
#
class Configuration
extend ::Gapic::Config
# @private
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
DEFAULT_ENDPOINT = "dialogflow.googleapis.com"
config_attr :endpoint, nil, ::String, nil
config_attr :credentials, nil do |value|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
allowed.any? { |klass| klass === value }
end
config_attr :scope, nil, ::String, ::Array, nil
config_attr :lib_name, nil, ::String, nil
config_attr :lib_version, nil, ::String, nil
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
config_attr :interceptors, nil, ::Array, 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
config_attr :universe_domain, nil, ::String, nil
# @private
def initialize parent_config = nil
@parent_config = parent_config unless parent_config.nil?
yield self if block_given?
end
##
# Configurations for individual RPCs
# @return [Rpcs]
#
def rpcs
@rpcs ||= begin
parent_rpcs = nil
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
Rpcs.new parent_rpcs
end
end
##
# Configuration for the channel pool
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
#
def channel_pool
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
end
##
# Configuration RPC class for the TestCases API.
#
# 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
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC 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 `list_test_cases`
# @return [::Gapic::Config::Method]
#
attr_reader :list_test_cases
##
# RPC-specific configuration for `batch_delete_test_cases`
# @return [::Gapic::Config::Method]
#
attr_reader :batch_delete_test_cases
##
# RPC-specific configuration for `get_test_case`
# @return [::Gapic::Config::Method]
#
attr_reader :get_test_case
##
# RPC-specific configuration for `create_test_case`
# @return [::Gapic::Config::Method]
#
attr_reader :create_test_case
##
# RPC-specific configuration for `update_test_case`
# @return [::Gapic::Config::Method]
#
attr_reader :update_test_case
##
# RPC-specific configuration for `run_test_case`
# @return [::Gapic::Config::Method]
#
attr_reader :run_test_case
##
# RPC-specific configuration for `batch_run_test_cases`
# @return [::Gapic::Config::Method]
#
attr_reader :batch_run_test_cases
##
# RPC-specific configuration for `calculate_coverage`
# @return [::Gapic::Config::Method]
#
attr_reader :calculate_coverage
##
# RPC-specific configuration for `import_test_cases`
# @return [::Gapic::Config::Method]
#
attr_reader :import_test_cases
##
# RPC-specific configuration for `export_test_cases`
# @return [::Gapic::Config::Method]
#
attr_reader :export_test_cases
##
# RPC-specific configuration for `list_test_case_results`
# @return [::Gapic::Config::Method]
#
attr_reader :list_test_case_results
##
# RPC-specific configuration for `get_test_case_result`
# @return [::Gapic::Config::Method]
#
attr_reader :get_test_case_result
# @private
def initialize parent_rpcs = nil
list_test_cases_config = parent_rpcs.list_test_cases if parent_rpcs.respond_to? :list_test_cases
@list_test_cases = ::Gapic::Config::Method.new list_test_cases_config
batch_delete_test_cases_config = parent_rpcs.batch_delete_test_cases if parent_rpcs.respond_to? :batch_delete_test_cases
@batch_delete_test_cases = ::Gapic::Config::Method.new batch_delete_test_cases_config
get_test_case_config = parent_rpcs.get_test_case if parent_rpcs.respond_to? :get_test_case
@get_test_case = ::Gapic::Config::Method.new get_test_case_config
create_test_case_config = parent_rpcs.create_test_case if parent_rpcs.respond_to? :create_test_case
@create_test_case = ::Gapic::Config::Method.new create_test_case_config
update_test_case_config = parent_rpcs.update_test_case if parent_rpcs.respond_to? :update_test_case
@update_test_case = ::Gapic::Config::Method.new update_test_case_config
run_test_case_config = parent_rpcs.run_test_case if parent_rpcs.respond_to? :run_test_case
@run_test_case = ::Gapic::Config::Method.new run_test_case_config
batch_run_test_cases_config = parent_rpcs.batch_run_test_cases if parent_rpcs.respond_to? :batch_run_test_cases
@batch_run_test_cases = ::Gapic::Config::Method.new batch_run_test_cases_config
calculate_coverage_config = parent_rpcs.calculate_coverage if parent_rpcs.respond_to? :calculate_coverage
@calculate_coverage = ::Gapic::Config::Method.new calculate_coverage_config
import_test_cases_config = parent_rpcs.import_test_cases if parent_rpcs.respond_to? :import_test_cases
@import_test_cases = ::Gapic::Config::Method.new import_test_cases_config
export_test_cases_config = parent_rpcs.export_test_cases if parent_rpcs.respond_to? :export_test_cases
@export_test_cases = ::Gapic::Config::Method.new export_test_cases_config
list_test_case_results_config = parent_rpcs.list_test_case_results if parent_rpcs.respond_to? :list_test_case_results
@list_test_case_results = ::Gapic::Config::Method.new list_test_case_results_config
get_test_case_result_config = parent_rpcs.get_test_case_result if parent_rpcs.respond_to? :get_test_case_result
@get_test_case_result = ::Gapic::Config::Method.new get_test_case_result_config
yield self if block_given?
end
end
end
end
end
end
end
end
end
end