class Google::Cloud::Speech::V1p1beta1::Adaptation::Client

Client for the Adaptation service.

Service that implements Google Cloud Speech Adaptation API.

Attributes

adaptation_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the Adaptation Client class.

See {::Google::Cloud::Speech::V1p1beta1::Adaptation::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all Adaptation clients
::Google::Cloud::Speech::V1p1beta1::Adaptation::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/speech/v1p1beta1/adaptation/client.rb, line 56
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Speech", "V1p1beta1"]
    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
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new Adaptation client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Speech::V1p1beta1::Adaptation::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Speech::V1p1beta1::Adaptation::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Adaptation client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/speech/v1p1beta1/adaptation/client.rb, line 109
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/speech/v1p1beta1/cloud_speech_adaptation_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 == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @adaptation_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Speech::V1p1beta1::Adaptation::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

configure() { |config| ... } click to toggle source

Configure the Adaptation 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::Speech::V1p1beta1::Adaptation::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/speech/v1p1beta1/adaptation/client.rb, line 88
def configure
  yield @config if block_given?
  @config
end
create_custom_class(request, options = nil) { |response, operation| ... } click to toggle source

Create a custom class.

@overload create_custom_class(request, options = nil)

Pass arguments to `create_custom_class` via a request object, either of type
{::Google::Cloud::Speech::V1p1beta1::CreateCustomClassRequest} or an equivalent Hash.

@param request [::Google::Cloud::Speech::V1p1beta1::CreateCustomClassRequest, ::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_custom_class(parent: nil, custom_class_id: nil, custom_class: nil)

Pass arguments to `create_custom_class` 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 parent resource where this custom class will be created.
  Format:
  \\{api_version}/projects/\\{project}/locations/\\{location}/customClasses
@param custom_class_id [::String]
  Required. The ID to use for the custom class, which will become the final
  component of the custom class' resource name.

  This value should be 4-63 characters, and valid characters
  are /[a-z][0-9]-/.
@param custom_class [::Google::Cloud::Speech::V1p1beta1::CustomClass, ::Hash]
  Required. The custom class to create.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Speech::V1p1beta1::CustomClass] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Speech::V1p1beta1::CustomClass]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/speech/v1p1beta1/adaptation/client.rb, line 562
def create_custom_class request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::CreateCustomClassRequest

  # 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_custom_class.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::Speech::V1p1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  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_custom_class.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_custom_class.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @adaptation_stub.call_rpc :create_custom_class, 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
create_phrase_set(request, options = nil) { |response, operation| ... } click to toggle source

Create a set of phrase hints. Each item in the set can be a single word or a multi-word phrase. The items in the PhraseSet are favored by the recognition model when you send a call that includes the PhraseSet.

@overload create_phrase_set(request, options = nil)

Pass arguments to `create_phrase_set` via a request object, either of type
{::Google::Cloud::Speech::V1p1beta1::CreatePhraseSetRequest} or an equivalent Hash.

@param request [::Google::Cloud::Speech::V1p1beta1::CreatePhraseSetRequest, ::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_phrase_set(parent: nil, phrase_set_id: nil, phrase_set: nil)

Pass arguments to `create_phrase_set` 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 parent resource where this phrase set will be created.
  Format:
  \\{api_version}/projects/\\{project}/locations/\\{location}/phraseSets
@param phrase_set_id [::String]
  Required. The ID to use for the phrase set, which will become the final
  component of the phrase set's resource name.

  This value should be 4-63 characters, and valid characters
  are /[a-z][0-9]-/.
@param phrase_set [::Google::Cloud::Speech::V1p1beta1::PhraseSet, ::Hash]
  Required. The phrase set to create.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Speech::V1p1beta1::PhraseSet] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Speech::V1p1beta1::PhraseSet]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/speech/v1p1beta1/adaptation/client.rb, line 188
def create_phrase_set request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::CreatePhraseSetRequest

  # 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_phrase_set.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::Speech::V1p1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  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_phrase_set.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_phrase_set.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @adaptation_stub.call_rpc :create_phrase_set, 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
delete_custom_class(request, options = nil) { |response, operation| ... } click to toggle source

Delete a custom class.

@overload delete_custom_class(request, options = nil)

Pass arguments to `delete_custom_class` via a request object, either of type
{::Google::Cloud::Speech::V1p1beta1::DeleteCustomClassRequest} or an equivalent Hash.

@param request [::Google::Cloud::Speech::V1p1beta1::DeleteCustomClassRequest, ::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 delete_custom_class(name: nil)

Pass arguments to `delete_custom_class` 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 custom class to delete.
  Format:
  \\{api_version}/projects/\\{project}/locations/\\{location}/customClasses/\\{custom_class}

@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.

# File lib/google/cloud/speech/v1p1beta1/adaptation/client.rb, line 858
def delete_custom_class request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::DeleteCustomClassRequest

  # 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.delete_custom_class.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::Speech::V1p1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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.delete_custom_class.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_custom_class.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @adaptation_stub.call_rpc :delete_custom_class, 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
delete_phrase_set(request, options = nil) { |response, operation| ... } click to toggle source

Delete a phrase set.

@overload delete_phrase_set(request, options = nil)

Pass arguments to `delete_phrase_set` via a request object, either of type
{::Google::Cloud::Speech::V1p1beta1::DeletePhraseSetRequest} or an equivalent Hash.

@param request [::Google::Cloud::Speech::V1p1beta1::DeletePhraseSetRequest, ::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 delete_phrase_set(name: nil)

Pass arguments to `delete_phrase_set` 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 phrase set to delete.
  Format:
  \\{api_version}/projects/\\{project}/locations/\\{location}/phraseSets/\\{phrase_set}

@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.

# File lib/google/cloud/speech/v1p1beta1/adaptation/client.rb, line 484
def delete_phrase_set request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::DeletePhraseSetRequest

  # 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.delete_phrase_set.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::Speech::V1p1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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.delete_phrase_set.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_phrase_set.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @adaptation_stub.call_rpc :delete_phrase_set, 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
get_custom_class(request, options = nil) { |response, operation| ... } click to toggle source

Get a custom class.

@overload get_custom_class(request, options = nil)

Pass arguments to `get_custom_class` via a request object, either of type
{::Google::Cloud::Speech::V1p1beta1::GetCustomClassRequest} or an equivalent Hash.

@param request [::Google::Cloud::Speech::V1p1beta1::GetCustomClassRequest, ::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_custom_class(name: nil)

Pass arguments to `get_custom_class` 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 custom class to retrieve.
  Format:
  \\{api_version}/projects/\\{project}/locations/\\{location}/customClasses/\\{custom_class}

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Speech::V1p1beta1::CustomClass] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Speech::V1p1beta1::CustomClass]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/speech/v1p1beta1/adaptation/client.rb, line 632
def get_custom_class request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::GetCustomClassRequest

  # 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_custom_class.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::Speech::V1p1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_custom_class.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_custom_class.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @adaptation_stub.call_rpc :get_custom_class, 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
get_phrase_set(request, options = nil) { |response, operation| ... } click to toggle source

Get a phrase set.

@overload get_phrase_set(request, options = nil)

Pass arguments to `get_phrase_set` via a request object, either of type
{::Google::Cloud::Speech::V1p1beta1::GetPhraseSetRequest} or an equivalent Hash.

@param request [::Google::Cloud::Speech::V1p1beta1::GetPhraseSetRequest, ::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_phrase_set(name: nil)

Pass arguments to `get_phrase_set` 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 phrase set to retrieve.
  Format:
  \\{api_version}/projects/\\{project}/locations/\\{location}/phraseSets/\\{phrase_set}

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Speech::V1p1beta1::PhraseSet] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Speech::V1p1beta1::PhraseSet]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/speech/v1p1beta1/adaptation/client.rb, line 258
def get_phrase_set request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::GetPhraseSetRequest

  # 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_phrase_set.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::Speech::V1p1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  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_phrase_set.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_phrase_set.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @adaptation_stub.call_rpc :get_phrase_set, 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
list_custom_classes(request, options = nil) { |response, operation| ... } click to toggle source

List custom classes.

@overload list_custom_classes(request, options = nil)

Pass arguments to `list_custom_classes` via a request object, either of type
{::Google::Cloud::Speech::V1p1beta1::ListCustomClassesRequest} or an equivalent Hash.

@param request [::Google::Cloud::Speech::V1p1beta1::ListCustomClassesRequest, ::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_custom_classes(parent: nil, page_size: nil, page_token: nil)

Pass arguments to `list_custom_classes` 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 parent, which owns this collection of custom classes.
  Format:
  \\{api_version}/projects/\\{project}/locations/\\{location}/customClasses
@param page_size [::Integer]
  The maximum number of custom classes to return. The service may return
  fewer than this value. If unspecified, at most 50 custom classes will be
  returned. The maximum value is 1000; values above 1000 will be coerced to
  1000.
@param page_token [::String]
  A page token, received from a previous `ListCustomClass` call.
  Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to `ListCustomClass` must
  match the call that provided the page token.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Speech::V1p1beta1::CustomClass>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::Speech::V1p1beta1::CustomClass>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/speech/v1p1beta1/adaptation/client.rb, line 713
def list_custom_classes request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::ListCustomClassesRequest

  # 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_custom_classes.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::Speech::V1p1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  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_custom_classes.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_custom_classes.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @adaptation_stub.call_rpc :list_custom_classes, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @adaptation_stub, :list_custom_classes, 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
list_phrase_set(request, options = nil) { |response, operation| ... } click to toggle source

List phrase sets.

@overload list_phrase_set(request, options = nil)

Pass arguments to `list_phrase_set` via a request object, either of type
{::Google::Cloud::Speech::V1p1beta1::ListPhraseSetRequest} or an equivalent Hash.

@param request [::Google::Cloud::Speech::V1p1beta1::ListPhraseSetRequest, ::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_phrase_set(parent: nil, page_size: nil, page_token: nil)

Pass arguments to `list_phrase_set` 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 parent, which owns this collection of phrase set.
  Format:
  projects/\\{project}/locations/\\{location}
@param page_size [::Integer]
  The maximum number of phrase sets to return. The service may return
  fewer than this value. If unspecified, at most 50 phrase sets will be
  returned. The maximum value is 1000; values above 1000 will be coerced to
  1000.
@param page_token [::String]
  A page token, received from a previous `ListPhraseSet` call.
  Provide this to retrieve the subsequent page.

  When paginating, all other parameters provided to `ListPhraseSet` must
  match the call that provided the page token.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Speech::V1p1beta1::PhraseSet>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::Speech::V1p1beta1::PhraseSet>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/speech/v1p1beta1/adaptation/client.rb, line 339
def list_phrase_set request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::ListPhraseSetRequest

  # 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_phrase_set.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::Speech::V1p1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  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_phrase_set.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_phrase_set.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @adaptation_stub.call_rpc :list_phrase_set, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @adaptation_stub, :list_phrase_set, 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
update_custom_class(request, options = nil) { |response, operation| ... } click to toggle source

Update a custom class.

@overload update_custom_class(request, options = nil)

Pass arguments to `update_custom_class` via a request object, either of type
{::Google::Cloud::Speech::V1p1beta1::UpdateCustomClassRequest} or an equivalent Hash.

@param request [::Google::Cloud::Speech::V1p1beta1::UpdateCustomClassRequest, ::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_custom_class(custom_class: nil, update_mask: nil)

Pass arguments to `update_custom_class` 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 custom_class [::Google::Cloud::Speech::V1p1beta1::CustomClass, ::Hash]
  Required. The custom class to update.

  The custom class's `name` field is used to identify the custom class to be
  updated. Format:
  \\{api_version}/projects/\\{project}/locations/\\{location}/customClasses/\\{custom_class}
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  The list of fields to be updated.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Speech::V1p1beta1::CustomClass] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Speech::V1p1beta1::CustomClass]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/speech/v1p1beta1/adaptation/client.rb, line 788
def update_custom_class request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::UpdateCustomClassRequest

  # 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_custom_class.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::Speech::V1p1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "custom_class.name" => request.custom_class.name
  }
  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_custom_class.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_custom_class.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @adaptation_stub.call_rpc :update_custom_class, 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
update_phrase_set(request, options = nil) { |response, operation| ... } click to toggle source

Update a phrase set.

@overload update_phrase_set(request, options = nil)

Pass arguments to `update_phrase_set` via a request object, either of type
{::Google::Cloud::Speech::V1p1beta1::UpdatePhraseSetRequest} or an equivalent Hash.

@param request [::Google::Cloud::Speech::V1p1beta1::UpdatePhraseSetRequest, ::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_phrase_set(phrase_set: nil, update_mask: nil)

Pass arguments to `update_phrase_set` 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 phrase_set [::Google::Cloud::Speech::V1p1beta1::PhraseSet, ::Hash]
  Required. The phrase set to update.

  The phrase set's `name` field is used to identify the set to be
  updated. Format:
  \\{api_version}/projects/\\{project}/locations/\\{location}/phraseSets/\\{phrase_set}
@param update_mask [::Google::Protobuf::FieldMask, ::Hash]
  The list of fields to be updated.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Speech::V1p1beta1::PhraseSet] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Speech::V1p1beta1::PhraseSet]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/speech/v1p1beta1/adaptation/client.rb, line 414
def update_phrase_set request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Speech::V1p1beta1::UpdatePhraseSetRequest

  # 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_phrase_set.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::Speech::V1p1beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "phrase_set.name" => request.phrase_set.name
  }
  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_phrase_set.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_phrase_set.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @adaptation_stub.call_rpc :update_phrase_set, 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