Class: Google::Cloud::Talent::V4beta1::CompletionClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/talent/v4beta1/completion_client.rb

Overview

A service handles auto completion.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"jobs.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform",
  "https://www.googleapis.com/auth/jobs"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, service_address: nil, service_port: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ CompletionClient

Returns a new instance of CompletionClient.

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) (defaults to: nil) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) (defaults to: ALL_SCOPES) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) (defaults to: {}) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) (defaults to: DEFAULT_TIMEOUT) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) (defaults to: nil) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

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

    Override for the service hostname, or nil to leave as the default.

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

    Override for the service port, or nil to leave as the default.

  • exception_transformer (Proc) (defaults to: nil) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/google/cloud/talent/v4beta1/completion_client.rb', line 164

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    service_address: nil,
    service_port: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # 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 "google/gax/grpc"
  require "google/cloud/talent/v4beta1/completion_service_services_pb"

  credentials ||= Google::Cloud::Talent::V4beta1::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Talent::V4beta1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Google::Cloud::Talent::VERSION

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "completion_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.talent.v4beta1.Completion",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = service_address || self.class::SERVICE_ADDRESS
  port = service_port || self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @completion_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Cloud::Talent::V4beta1::Completion::Stub.method(:new)
  )

  @complete_query = Google::Gax.create_api_call(
    @completion_stub.method(:complete_query),
    defaults["complete_query"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
end

Class Method Details

.company_path(project, tenant, company) ⇒ String

Returns a fully-qualified company resource name string.

Parameters:

  • project (String)
  • tenant (String)
  • company (String)

Returns:

  • (String) 


92
93
94
95
96
97
98
 
# File 'lib/google/cloud/talent/v4beta1/completion_client.rb', line 92

def self.company_path project, tenant, company
  COMPANY_PATH_TEMPLATE.render(
    :"project" => project,
    :"tenant" => tenant,
    :"company" => company
  )
end

.company_without_tenant_path(project, company) ⇒ String

Returns a fully-qualified company_without_tenant resource name string.

Parameters:

  • project (String)
  • company (String)

Returns:

  • (String) 


104
105
106
107
108
109
 
# File 'lib/google/cloud/talent/v4beta1/completion_client.rb', line 104

def self.company_without_tenant_path project, company
  COMPANY_WITHOUT_TENANT_PATH_TEMPLATE.render(
    :"project" => project,
    :"company" => company
  )
end

.project_path(project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • project (String)

Returns:

  • (String) 


114
115
116
117
118
 
# File 'lib/google/cloud/talent/v4beta1/completion_client.rb', line 114

def self.project_path project
  PROJECT_PATH_TEMPLATE.render(
    :"project" => project
  )
end

.tenant_path(project, tenant) ⇒ String

Returns a fully-qualified tenant resource name string.

Parameters:

  • project (String)
  • tenant (String)

Returns:

  • (String) 


124
125
126
127
128
129
 
# File 'lib/google/cloud/talent/v4beta1/completion_client.rb', line 124

def self.tenant_path project, tenant
  TENANT_PATH_TEMPLATE.render(
    :"project" => project,
    :"tenant" => tenant
  )
end

Instance Method Details

#complete_query(parent, query, page_size, language_codes: nil, company: nil, scope: nil, type: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Talent::V4beta1::CompleteQueryResponse

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

Examples:

require "google/cloud/talent"

completion_client = Google::Cloud::Talent::Completion.new(version: :v4beta1)
formatted_parent = Google::Cloud::Talent::V4beta1::CompletionClient.tenant_path("[PROJECT]", "[TENANT]")

# TODO: Initialize `query`:
query = ''

# TODO: Initialize `page_size`:
page_size = 0
response = completion_client.complete_query(formatted_parent, query, page_size)

Parameters:

  • parent (String) —

    Required. Resource name of tenant the completion is performed within.

    The format is "projects/project_id/tenants/tenant_id", for example, "projects/foo/tenant/bar".

    If tenant id is unspecified, the default tenant is used, for example, "projects/foo".

  • query (String) —

    Required. The query used to generate suggestions.

    The maximum number of allowed characters is 255.

  • page_size (Integer) —

    Required. Completion result count.

    The maximum allowed page size is 10.

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

    For CompletionType::JOB_TITLE type, only open jobs with the same language_codes are returned.

    For CompletionType::COMPANY_NAME type, only companies having open jobs with the same language_codes are returned.

    For CompletionType::COMBINED type, only open jobs with the same language_codes or companies having open jobs with the same language_codes are returned.

    The maximum number of allowed characters is 255.

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

    If tenant id is unspecified, the default tenant is used, for example, "projects/foo".

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

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

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

    The completion topic. The default is CompletionType::COMBINED.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/google/cloud/talent/v4beta1/completion_client.rb', line 333

def complete_query \
    parent,
    query,
    page_size,
    language_codes: nil,
    company: nil,
    scope: nil,
    type: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    query: query,
    page_size: page_size,
    language_codes: language_codes,
    company: company,
    scope: scope,
    type: type
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Talent::V4beta1::CompleteQueryRequest)
  @complete_query.call(req, options, &block)
end