class Google::Cloud::Talent::V4::Completion::Client
Client
for the Completion
service.
A service handles auto completion.
Attributes
@private
Public Class Methods
Configure the Completion
Client
class.
See {::Google::Cloud::Talent::V4::Completion::Client::Configuration} for a description of the configuration fields.
@example
# Modify the configuration for all Completion clients ::Google::Cloud::Talent::V4::Completion::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/talent/v4/completion/client.rb, line 56 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "Talent", "V4"] 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.rpcs.complete_query.timeout = 30.0 default_config.rpcs.complete_query.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14] } default_config end yield @configure if block_given? @configure end
Create a new Completion
client object.
@example
# Create a client using the default configuration client = ::Google::Cloud::Talent::V4::Completion::Client.new # Create a client using a custom configuration client = ::Google::Cloud::Talent::V4::Completion::Client.new do |config| config.timeout = 10.0 end
@yield [config] Configure the Completion
client. @yieldparam config [Client::Configuration]
# File lib/google/cloud/talent/v4/completion/client.rb, line 114 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/talent/v4/completion_service_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 @completion_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::Talent::V4::Completion::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end
Public Instance Methods
Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.
@overload complete_query
(request, options = nil)
Pass arguments to `complete_query` via a request object, either of type {::Google::Cloud::Talent::V4::CompleteQueryRequest} or an equivalent Hash. @param request [::Google::Cloud::Talent::V4::CompleteQueryRequest, ::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 complete_query
(tenant: nil, query: nil, language_codes: nil, page_size: nil, company: nil, scope: nil, type: nil)
Pass arguments to `complete_query` 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 tenant [::String] Required. Resource name of tenant the completion is performed within. The format is "projects/\\{project_id}/tenants/\\{tenant_id}", for example, "projects/foo/tenants/bar". @param query [::String] Required. The query used to generate suggestions. The maximum number of allowed characters is 255. @param language_codes [::Array<::String>] The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). The maximum number of allowed characters is 255. @param page_size [::Integer] Required. Completion result count. The maximum allowed page size is 10. @param company [::String] If provided, restricts completion to specified company. The format is "projects/\\{project_id}/tenants/\\{tenant_id}/companies/\\{company_id}", for example, "projects/foo/tenants/bar/companies/baz". @param scope [::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionScope] The scope of the completion. The defaults is {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionScope::PUBLIC CompletionScope.PUBLIC}. @param type [::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType] The completion topic. The default is {::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType::COMBINED CompletionType.COMBINED}.
@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Talent::V4::CompleteQueryResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]
@return [::Google::Cloud::Talent::V4::CompleteQueryResponse]
@raise [::Google::Cloud::Error] if the RPC is aborted.
# File lib/google/cloud/talent/v4/completion/client.rb, line 210 def complete_query request, options = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4::CompleteQueryRequest # 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.complete_query.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::Talent::V4::VERSION metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id header_params = { "tenant" => request.tenant } 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.complete_query.timeout, metadata: metadata, retry_policy: @config.rpcs.complete_query.retry_policy options.apply_defaults timeout: @config.timeout, metadata: @config.metadata, retry_policy: @config.retry_policy @completion_stub.call_rpc :complete_query, 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
Configure the Completion
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::Talent::V4::Completion::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/talent/v4/completion/client.rb, line 93 def configure yield @config if block_given? @config end