Class: Google::Cloud::Talent::V4::Completion::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/talent/v4/completion/rest/client.rb

Overview

REST client for the Completion service.

A service handles auto completion.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#company_path, #tenant_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Completion REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Talent::V4::Completion::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Talent::V4::Completion::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Completion client.

Yield Parameters:



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/google/cloud/talent/v4/completion/rest/client.rb', line 131

def initialize
  # 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

  @completion_stub = ::Google::Cloud::Talent::V4::Completion::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @completion_stub.logger(stub: true)&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Completion Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all Completion clients
::Google::Cloud::Talent::V4::Completion::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/google/cloud/talent/v4/completion/rest/client.rb', line 64

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

Instance Method Details

#complete_query(request, options = nil) ⇒ ::Google::Cloud::Talent::V4::CompleteQueryResponse #complete_query(tenant: nil, query: nil, language_codes: nil, page_size: nil, company: nil, scope: nil, type: nil) ⇒ ::Google::Cloud::Talent::V4::CompleteQueryResponse

Completes the specified prefix with keyword suggestions. Intended for use by a job search auto-complete search box.

Examples:

Basic example

require "google/cloud/talent/v4"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Talent::V4::Completion::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Talent::V4::CompleteQueryRequest.new

# Call the complete_query method.
result = client.complete_query request

# The returned object is of type Google::Cloud::Talent::V4::CompleteQueryResponse.
p result

Overloads:

  • #complete_query(request, options = nil) ⇒ ::Google::Cloud::Talent::V4::CompleteQueryResponse

    Pass arguments to complete_query via a request object, either of type Google::Cloud::Talent::V4::CompleteQueryRequest or an equivalent Hash.

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #complete_query(tenant: nil, query: nil, language_codes: nil, page_size: nil, company: nil, scope: nil, type: nil) ⇒ ::Google::Cloud::Talent::V4::CompleteQueryResponse

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

    Parameters:

    • tenant (::String) (defaults to: nil) —

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

    • query (::String) (defaults to: nil) —

      Required. The query used to generate suggestions.

      The maximum number of allowed characters is 255.

    • language_codes (::Array<::String>) (defaults to: nil) —

      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.

      The maximum number of allowed characters is 255.

    • page_size (::Integer) (defaults to: nil) —

      Required. Completion result count.

      The maximum allowed page size is 10.

    • company (::String) (defaults to: nil) —

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

    • scope (::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionScope) (defaults to: nil) —

      The scope of the completion. The defaults is CompletionScope.PUBLIC.

    • type (::Google::Cloud::Talent::V4::CompleteQueryRequest::CompletionType) (defaults to: nil) —

      The completion topic. The default is CompletionType.COMBINED.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/google/cloud/talent/v4/completion/rest/client.rb', line 258

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
  call_metadata = @config.rpcs.complete_query.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.complete_query.timeout,
                         metadata:     call_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.complete_query request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

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

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



101
102
103
104
 
# File 'lib/google/cloud/talent/v4/completion/rest/client.rb', line 101

def configure
  yield @config if block_given?
  @config
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


178
179
180
 
# File 'lib/google/cloud/talent/v4/completion/rest/client.rb', line 178

def logger
  @completion_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


111
112
113
 
# File 'lib/google/cloud/talent/v4/completion/rest/client.rb', line 111

def universe_domain
  @completion_stub.universe_domain
end