Class: Google::Cloud::Talent::V4beta1::JobService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/talent/v4beta1/job_service/client.rb

Overview

Client for the JobService service.

A service handles job management, including job CRUD, enumeration and search.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#company_path, #job_path, #project_path, #tenant_path

Constructor Details

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

Create a new JobService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Talent::V4beta1::JobService::Client.new

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

Yields:

  • (config) —

    Configure the JobService client.

Yield Parameters:



153
154
155
156
157
158
159
160
161
162
163
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
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 153

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/v4beta1/job_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.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

  @job_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Talent::V4beta1::JobService::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
  )
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::Talent::V4beta1::JobService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



205
206
207
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 205

def operations_client
  @operations_client
end

Class Method Details

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

Configure the JobService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 62

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Talent", "V4beta1"]
    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.create_job.timeout = 30.0

    default_config.rpcs.batch_create_jobs.timeout = 30.0

    default_config.rpcs.get_job.timeout = 30.0
    default_config.rpcs.get_job.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.update_job.timeout = 30.0

    default_config.rpcs.batch_update_jobs.timeout = 30.0

    default_config.rpcs.delete_job.timeout = 30.0
    default_config.rpcs.delete_job.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.batch_delete_jobs.timeout = 30.0

    default_config.rpcs.list_jobs.timeout = 30.0
    default_config.rpcs.list_jobs.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
    }

    default_config.rpcs.search_jobs.timeout = 30.0

    default_config.rpcs.search_jobs_for_alert.timeout = 30.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#batch_create_jobs(request, options = nil) ⇒ ::Gapic::Operation #batch_create_jobs(parent: nil, jobs: nil) ⇒ ::Gapic::Operation

Begins executing a batch create jobs operation.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

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

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

# Call the batch_create_jobs method.
result = client.batch_create_jobs 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

Overloads:

  • #batch_create_jobs(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to batch_create_jobs via a request object, either of type BatchCreateJobsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::BatchCreateJobsRequest, ::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.

  • #batch_create_jobs(parent: nil, jobs: nil) ⇒ ::Gapic::Operation

    Pass arguments to batch_create_jobs 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:

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

      Required. The resource name of the tenant under which the job is created.

      The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".

    • jobs (::Array<::Google::Cloud::Talent::V4beta1::Job, ::Hash>) (defaults to: nil) —

      Required. The jobs to be created.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 361

def batch_create_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::BatchCreateJobsRequest

  # 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_create_jobs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::V4beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  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_create_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_create_jobs.retry_policy

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

  @job_service_stub.call_rpc :batch_create_jobs, 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

#batch_delete_jobs(request, options = nil) ⇒ ::Google::Protobuf::Empty #batch_delete_jobs(parent: nil, filter: nil) ⇒ ::Google::Protobuf::Empty

Deletes a list of Jobs by filter.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

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

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

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #batch_delete_jobs(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to batch_delete_jobs via a request object, either of type BatchDeleteJobsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::BatchDeleteJobsRequest, ::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.

  • #batch_delete_jobs(parent: nil, filter: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to batch_delete_jobs 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:

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

      Required. The resource name of the tenant under which the job is created.

      The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".

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

      Required. The filter string specifies the jobs to be deleted.

      Supported operator: =, AND

      The fields eligible for filtering are:

      • companyName (Required)
      • requisitionId (Required)

      Sample Query: companyName = "projects/foo/companies/bar" AND requisitionId = "req-1"

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 873

def batch_delete_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::BatchDeleteJobsRequest

  # 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_jobs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::V4beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  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_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_delete_jobs.retry_policy

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

  @job_service_stub.call_rpc :batch_delete_jobs, 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

#batch_update_jobs(request, options = nil) ⇒ ::Gapic::Operation #batch_update_jobs(parent: nil, jobs: nil, update_mask: nil) ⇒ ::Gapic::Operation

Begins executing a batch update jobs operation.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

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

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

# Call the batch_update_jobs method.
result = client.batch_update_jobs 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

Overloads:

  • #batch_update_jobs(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to batch_update_jobs via a request object, either of type BatchUpdateJobsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::BatchUpdateJobsRequest, ::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.

  • #batch_update_jobs(parent: nil, jobs: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to batch_update_jobs 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:

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

      Required. The resource name of the tenant under which the job is created.

      The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".

    • jobs (::Array<::Google::Cloud::Talent::V4beta1::Job, ::Hash>) (defaults to: nil) —

      Required. The jobs to be updated.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Strongly recommended for the best service experience. Be aware that it will also increase latency when checking the status of a batch operation.

      If update_mask is provided, only the specified fields in Job are updated. Otherwise all the fields are updated.

      A field mask to restrict the fields that are updated. Only top level fields of Job are supported.

      If update_mask is provided, The Job inside JobResult will only contains fields that is updated, plus the Id of the Job. Otherwise, Job will include all fields, which can yield a very large response.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the RPC is aborted.



674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 674

def batch_update_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::BatchUpdateJobsRequest

  # 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_update_jobs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::V4beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  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_update_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_update_jobs.retry_policy

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

  @job_service_stub.call_rpc :batch_update_jobs, 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

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

Configure the JobService 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:



123
124
125
126
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 123

def configure
  yield @config if block_given?
  @config
end

#create_job(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Job #create_job(parent: nil, job: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Job

Creates a new job.

Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

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

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

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

# The returned object is of type Google::Cloud::Talent::V4beta1::Job.
p result

Overloads:

  • #create_job(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Job

    Pass arguments to create_job via a request object, either of type CreateJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::CreateJobRequest, ::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.

  • #create_job(parent: nil, job: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Job

    Pass arguments to create_job 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:

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

      Required. The resource name of the tenant under which the job is created.

      The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified a default tenant is created. For example, "projects/foo".

    • job (::Google::Cloud::Talent::V4beta1::Job, ::Hash) (defaults to: nil) —

      Required. The Job to be created.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



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
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 262

def create_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::CreateJobRequest

  # 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_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::V4beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  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_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_job.retry_policy

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

  @job_service_stub.call_rpc :create_job, 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_job(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_job(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes the specified job.

Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

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

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

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_job(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_job via a request object, either of type DeleteJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::DeleteJobRequest, ::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.

  • #delete_job(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_job 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:

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

      Required. The resource name of the job to be deleted.

      The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz".

      If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 771

def delete_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::DeleteJobRequest

  # 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_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::V4beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  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.delete_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_job.retry_policy

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

  @job_service_stub.call_rpc :delete_job, 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_job(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Job #get_job(name: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Job

Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

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

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

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

# The returned object is of type Google::Cloud::Talent::V4beta1::Job.
p result

Overloads:

  • #get_job(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Job

    Pass arguments to get_job via a request object, either of type GetJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::GetJobRequest, ::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.

  • #get_job(name: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Job

    Pass arguments to get_job 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:

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

      Required. The resource name of the job to retrieve.

      The format is "projects/{project_id}/tenants/{tenant_id}/jobs/{job_id}". For example, "projects/foo/tenants/bar/jobs/baz".

      If tenant id is unspecified, the default tenant is used. For example, "projects/foo/jobs/bar".

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 456

def get_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::GetJobRequest

  # 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_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::V4beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  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_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_job.retry_policy

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

  @job_service_stub.call_rpc :get_job, 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_jobs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Job> #list_jobs(parent: nil, filter: nil, page_token: nil, page_size: nil, job_view: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Job>

Lists jobs by filter.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

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

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

# Call the list_jobs method.
result = client.list_jobs 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::Talent::V4beta1::Job.
  p item
end

Overloads:

  • #list_jobs(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Job>

    Pass arguments to list_jobs via a request object, either of type ListJobsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::ListJobsRequest, ::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.

  • #list_jobs(parent: nil, filter: nil, page_token: nil, page_size: nil, job_view: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Talent::V4beta1::Job>

    Pass arguments to list_jobs 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:

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

      Required. The resource name of the tenant under which the job is created.

      The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".

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

      Required. The filter string specifies the jobs to be enumerated.

      Supported operator: =, AND

      The fields eligible for filtering are:

      • companyName
      • requisitionId
      • status Available values: OPEN, EXPIRED, ALL. Defaults to OPEN if no value is specified.

      At least one of companyName and requisitionId must present or an INVALID_ARGUMENT error is thrown.

      Sample Query:

      • companyName = "projects/foo/tenants/bar/companies/baz"
      • companyName = "projects/foo/tenants/bar/companies/baz" AND requisitionId = "req-1"
      • companyName = "projects/foo/tenants/bar/companies/baz" AND status = "EXPIRED"
      • requisitionId = "req-1"
      • requisitionId = "req-1" AND status = "EXPIRED"
    • page_token (::String) (defaults to: nil) —

      The starting point of a query result.

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

      The maximum number of jobs to be returned per page of results.

      If job_view is set to JobView.JOB_VIEW_ID_ONLY, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100.

      Default is 100 if empty or a number < 1 is specified.

    • job_view (::Google::Cloud::Talent::V4beta1::JobView) (defaults to: nil) —

      The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_FULL if no value is specified.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 1008

def list_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::ListJobsRequest

  # 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_jobs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::V4beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  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_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_jobs.retry_policy

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

  @job_service_stub.call_rpc :list_jobs, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @job_service_stub, :list_jobs, 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

#search_jobs(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::SearchJobsResponse #search_jobs(parent: nil, search_mode: nil, request_metadata: nil, job_query: nil, enable_broadening: nil, require_precise_result_size: nil, histogram_queries: nil, job_view: nil, offset: nil, page_size: nil, page_token: nil, order_by: nil, diversification_level: nil, custom_ranking_info: nil, disable_keyword_match: nil, keyword_match_mode: nil) ⇒ ::Google::Cloud::Talent::V4beta1::SearchJobsResponse

Searches for jobs using the provided SearchJobsRequest.

This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

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

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

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

# The returned object is of type Google::Cloud::Talent::V4beta1::SearchJobsResponse.
p result

Overloads:

  • #search_jobs(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::SearchJobsResponse

    Pass arguments to search_jobs via a request object, either of type SearchJobsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::SearchJobsRequest, ::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.

  • #search_jobs(parent: nil, search_mode: nil, request_metadata: nil, job_query: nil, enable_broadening: nil, require_precise_result_size: nil, histogram_queries: nil, job_view: nil, offset: nil, page_size: nil, page_token: nil, order_by: nil, diversification_level: nil, custom_ranking_info: nil, disable_keyword_match: nil, keyword_match_mode: nil) ⇒ ::Google::Cloud::Talent::V4beta1::SearchJobsResponse

    Pass arguments to search_jobs 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:

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

      Required. The resource name of the tenant to search within.

      The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".

    • search_mode (::Google::Cloud::Talent::V4beta1::SearchJobsRequest::SearchMode) (defaults to: nil) —

      Mode of a search.

      Defaults to SearchMode.JOB_SEARCH.

    • request_metadata (::Google::Cloud::Talent::V4beta1::RequestMetadata, ::Hash) (defaults to: nil) —

      Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers (such as user_id) are provided by users, and must be unique and consistent.

    • job_query (::Google::Cloud::Talent::V4beta1::JobQuery, ::Hash) (defaults to: nil) —

      Query used to search against jobs, such as keyword, location filters, etc.

    • enable_broadening (::Boolean) (defaults to: nil) —

      Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list.

      Defaults to false.

    • require_precise_result_size (::Boolean) (defaults to: nil) —

      This field is deprecated.

    • histogram_queries (::Array<::Google::Cloud::Talent::V4beta1::HistogramQuery, ::Hash>) (defaults to: nil) —

      An expression specifies a histogram request against matching jobs.

      Expression syntax is an aggregation function call with histogram facets and other options.

      Available aggregation function calls are:

      • count(string_histogram_facet): Count the number of matching entities, for each distinct attribute value.
      • count(numeric_histogram_facet, list of buckets): Count the number of matching entities within each bucket.

      A maximum of 200 histogram buckets are supported.

      Data types:

      • Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+.
      • String: string like "any string with backslash escape for quote(\")."
      • Number: whole number and floating point number like 10, -1 and -0.01.
      • List: list of elements with comma(,) separator surrounded by square brackets, for example, [1, 2, 3] and ["one", "two", "three"].

      Built-in constants:

      • MIN (minimum number similar to java Double.MIN_VALUE)
      • MAX (maximum number similar to java Double.MAX_VALUE)

      Built-in functions:

      • bucket(start, end[, label]): bucket built-in function creates a bucket with range of [start, end). Note that the end is exclusive, for example, bucket(1, MAX, "positive number") or bucket(1, 10).

      Job histogram facets:

      • company_display_name: histogram by Job.company_display_name.
      • employment_type: histogram by Job.employment_types, for example, "FULL_TIME", "PART_TIME".
      • company_size (DEPRECATED): histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG".
      • publish_time_in_day: histogram by the Job.posting_publish_time in days. Must specify list of numeric buckets in spec.
      • publish_time_in_month: histogram by the Job.posting_publish_time in months. Must specify list of numeric buckets in spec.
      • publish_time_in_year: histogram by the Job.posting_publish_time in years. Must specify list of numeric buckets in spec.
      • degree_types: histogram by the Job.degree_types, for example, "Bachelors", "Masters".
      • job_level: histogram by the Job.job_level, for example, "Entry Level".
      • country: histogram by the country code of jobs, for example, "US", "FR".
      • admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, "CA", "IL".
      • city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY".
      • admin1_country: histogram by a combination of the "admin1 code, country", for example, "CA, US", "IL, US".
      • city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically.
      • locale: histogram by the Job.language_code, for example, "en-US", "fr-FR".
      • language: histogram by the language subtag of the Job.language_code, for example, "en", "fr".
      • category: histogram by the JobCategory, for example, "COMPUTER_AND_IT", "HEALTHCARE".
      • base_compensation_unit: histogram by the CompensationInfo.CompensationUnit of base salary, for example, "WEEKLY", "MONTHLY".
      • base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by.
      • annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by.
      • annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by.
      • string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"].
      • numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by.

      Example expressions:

      • count(admin1)
      • count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)])
      • count(string_custom_attribute["some-string-custom-attribute"])
      • count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
    • job_view (::Google::Cloud::Talent::V4beta1::JobView) (defaults to: nil) —

      The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_SMALL if no value is specified.

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

      An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

      The maximum allowed value is 5000. Otherwise an error is thrown.

      For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page).

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

      A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100.

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

      The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results.

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

      The criteria determining how search results are sorted. Default is "relevance desc".

      Supported options are:

      • "relevance desc": By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering.
      • "posting_publish_time desc": By Job.posting_publish_time descending.
      • "posting_update_time desc": By Job.posting_update_time descending.
      • "title": By Job.title ascending.
      • "title desc": By Job.title descending.
      • "annualized_base_compensation": By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results.
      • "annualized_base_compensation desc": By job's CompensationInfo.annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results.
      • "annualized_total_compensation": By job's CompensationInfo.annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results.
      • "annualized_total_compensation desc": By job's CompensationInfo.annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results.
      • "custom_ranking desc": By the relevance score adjusted to the SearchJobsRequest.CustomRankingInfo.ranking_expression with weight factor assigned by SearchJobsRequest.CustomRankingInfo.importance_level in descending order.
      • Location sorting: Use the special syntax to order jobs by distance:
        "distance_from('Hawaii')": Order by distance from Hawaii.
        "distance_from(19.89, 155.5)": Order by distance from a coordinate.
        "distance_from('Hawaii'), distance_from('Puerto Rico')": Order by multiple locations. See details below.
        "distance_from('Hawaii'), distance_from(19.89, 155.5)": Order by multiple locations. See details below.
        The string can have a maximum of 256 characters. When multiple distance centers are provided, a job that is close to any of the distance centers would have a high rank. When a job has multiple locations, the job location closest to one of the distance centers will be used. Jobs that don't have locations will be ranked at the bottom. Distance is calculated with a precision of 11.3 meters (37.4 feet). Diversification strategy is still applied unless explicitly disabled in diversification_level.
    • diversification_level (::Google::Cloud::Talent::V4beta1::SearchJobsRequest::DiversificationLevel) (defaults to: nil) —

      Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results.

      Defaults to DiversificationLevel.SIMPLE if no value is specified.

    • custom_ranking_info (::Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo, ::Hash) (defaults to: nil) —

      Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm).

    • disable_keyword_match (::Boolean) (defaults to: nil) —

      This field is deprecated. Please use SearchJobsRequest.keyword_match_mode going forward.

      To migrate, disable_keyword_match set to false maps to KeywordMatchMode.KEYWORD_MATCH_ALL, and disable_keyword_match set to true maps to KeywordMatchMode.KEYWORD_MATCH_DISABLED. If SearchJobsRequest.keyword_match_mode is set, this field is ignored.

      Controls whether to disable exact keyword match on Job.title, Job.description, Job.company_display_name, Job.addresses, Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, for the query "program manager," a result is returned even if the job posting has the title "software developer," which doesn't fall into "program manager" ontology, but does have "program manager" appearing in its description.

      For queries like "cloud" that don't contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value.

      Use Company.keyword_searchable_job_custom_attributes if company-specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests.

      Defaults to false.

    • keyword_match_mode (::Google::Cloud::Talent::V4beta1::SearchJobsRequest::KeywordMatchMode) (defaults to: nil) —

      Controls what keyword match options to use.

      Defaults to KeywordMatchMode.KEYWORD_MATCH_ALL if no value is specified.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 1377

def search_jobs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::SearchJobsRequest

  # 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.search_jobs.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::V4beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  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.search_jobs.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_jobs.retry_policy

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

  @job_service_stub.call_rpc :search_jobs, 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

#search_jobs_for_alert(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::SearchJobsResponse #search_jobs_for_alert(parent: nil, search_mode: nil, request_metadata: nil, job_query: nil, enable_broadening: nil, require_precise_result_size: nil, histogram_queries: nil, job_view: nil, offset: nil, page_size: nil, page_token: nil, order_by: nil, diversification_level: nil, custom_ranking_info: nil, disable_keyword_match: nil, keyword_match_mode: nil) ⇒ ::Google::Cloud::Talent::V4beta1::SearchJobsResponse

Searches for jobs using the provided SearchJobsRequest.

This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers.

This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

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

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

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

# The returned object is of type Google::Cloud::Talent::V4beta1::SearchJobsResponse.
p result

Overloads:

  • #search_jobs_for_alert(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::SearchJobsResponse

    Pass arguments to search_jobs_for_alert via a request object, either of type SearchJobsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::SearchJobsRequest, ::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.

  • #search_jobs_for_alert(parent: nil, search_mode: nil, request_metadata: nil, job_query: nil, enable_broadening: nil, require_precise_result_size: nil, histogram_queries: nil, job_view: nil, offset: nil, page_size: nil, page_token: nil, order_by: nil, diversification_level: nil, custom_ranking_info: nil, disable_keyword_match: nil, keyword_match_mode: nil) ⇒ ::Google::Cloud::Talent::V4beta1::SearchJobsResponse

    Pass arguments to search_jobs_for_alert 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:

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

      Required. The resource name of the tenant to search within.

      The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created. For example, "projects/foo".

    • search_mode (::Google::Cloud::Talent::V4beta1::SearchJobsRequest::SearchMode) (defaults to: nil) —

      Mode of a search.

      Defaults to SearchMode.JOB_SEARCH.

    • request_metadata (::Google::Cloud::Talent::V4beta1::RequestMetadata, ::Hash) (defaults to: nil) —

      Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers (such as user_id) are provided by users, and must be unique and consistent.

    • job_query (::Google::Cloud::Talent::V4beta1::JobQuery, ::Hash) (defaults to: nil) —

      Query used to search against jobs, such as keyword, location filters, etc.

    • enable_broadening (::Boolean) (defaults to: nil) —

      Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list.

      Defaults to false.

    • require_precise_result_size (::Boolean) (defaults to: nil) —

      This field is deprecated.

    • histogram_queries (::Array<::Google::Cloud::Talent::V4beta1::HistogramQuery, ::Hash>) (defaults to: nil) —

      An expression specifies a histogram request against matching jobs.

      Expression syntax is an aggregation function call with histogram facets and other options.

      Available aggregation function calls are:

      • count(string_histogram_facet): Count the number of matching entities, for each distinct attribute value.
      • count(numeric_histogram_facet, list of buckets): Count the number of matching entities within each bucket.

      A maximum of 200 histogram buckets are supported.

      Data types:

      • Histogram facet: facet names with format [a-zA-Z][a-zA-Z0-9_]+.
      • String: string like "any string with backslash escape for quote(\")."
      • Number: whole number and floating point number like 10, -1 and -0.01.
      • List: list of elements with comma(,) separator surrounded by square brackets, for example, [1, 2, 3] and ["one", "two", "three"].

      Built-in constants:

      • MIN (minimum number similar to java Double.MIN_VALUE)
      • MAX (maximum number similar to java Double.MAX_VALUE)

      Built-in functions:

      • bucket(start, end[, label]): bucket built-in function creates a bucket with range of [start, end). Note that the end is exclusive, for example, bucket(1, MAX, "positive number") or bucket(1, 10).

      Job histogram facets:

      • company_display_name: histogram by Job.company_display_name.
      • employment_type: histogram by Job.employment_types, for example, "FULL_TIME", "PART_TIME".
      • company_size (DEPRECATED): histogram by CompanySize, for example, "SMALL", "MEDIUM", "BIG".
      • publish_time_in_day: histogram by the Job.posting_publish_time in days. Must specify list of numeric buckets in spec.
      • publish_time_in_month: histogram by the Job.posting_publish_time in months. Must specify list of numeric buckets in spec.
      • publish_time_in_year: histogram by the Job.posting_publish_time in years. Must specify list of numeric buckets in spec.
      • degree_types: histogram by the Job.degree_types, for example, "Bachelors", "Masters".
      • job_level: histogram by the Job.job_level, for example, "Entry Level".
      • country: histogram by the country code of jobs, for example, "US", "FR".
      • admin1: histogram by the admin1 code of jobs, which is a global placeholder referring to the state, province, or the particular term a country uses to define the geographic structure below the country level, for example, "CA", "IL".
      • city: histogram by a combination of the "city name, admin1 code". For example, "Mountain View, CA", "New York, NY".
      • admin1_country: histogram by a combination of the "admin1 code, country", for example, "CA, US", "IL, US".
      • city_coordinate: histogram by the city center's GPS coordinates (latitude and longitude), for example, 37.4038522,-122.0987765. Since the coordinates of a city center can change, customers may need to refresh them periodically.
      • locale: histogram by the Job.language_code, for example, "en-US", "fr-FR".
      • language: histogram by the language subtag of the Job.language_code, for example, "en", "fr".
      • category: histogram by the JobCategory, for example, "COMPUTER_AND_IT", "HEALTHCARE".
      • base_compensation_unit: histogram by the CompensationInfo.CompensationUnit of base salary, for example, "WEEKLY", "MONTHLY".
      • base_compensation: histogram by the base salary. Must specify list of numeric buckets to group results by.
      • annualized_base_compensation: histogram by the base annualized salary. Must specify list of numeric buckets to group results by.
      • annualized_total_compensation: histogram by the total annualized salary. Must specify list of numeric buckets to group results by.
      • string_custom_attribute: histogram by string Job.custom_attributes. Values can be accessed via square bracket notations like string_custom_attribute["key1"].
      • numeric_custom_attribute: histogram by numeric Job.custom_attributes. Values can be accessed via square bracket notations like numeric_custom_attribute["key1"]. Must specify list of numeric buckets to group results by.

      Example expressions:

      • count(admin1)
      • count(base_compensation, [bucket(1000, 10000), bucket(10000, 100000), bucket(100000, MAX)])
      • count(string_custom_attribute["some-string-custom-attribute"])
      • count(numeric_custom_attribute["some-numeric-custom-attribute"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
    • job_view (::Google::Cloud::Talent::V4beta1::JobView) (defaults to: nil) —

      The desired job attributes returned for jobs in the search response. Defaults to JobView.JOB_VIEW_SMALL if no value is specified.

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

      An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset.

      The maximum allowed value is 5000. Otherwise an error is thrown.

      For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page).

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

      A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100.

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

      The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results.

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

      The criteria determining how search results are sorted. Default is "relevance desc".

      Supported options are:

      • "relevance desc": By relevance descending, as determined by the API algorithms. Relevance thresholding of query results is only available with this ordering.
      • "posting_publish_time desc": By Job.posting_publish_time descending.
      • "posting_update_time desc": By Job.posting_update_time descending.
      • "title": By Job.title ascending.
      • "title desc": By Job.title descending.
      • "annualized_base_compensation": By job's CompensationInfo.annualized_base_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results.
      • "annualized_base_compensation desc": By job's CompensationInfo.annualized_base_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results.
      • "annualized_total_compensation": By job's CompensationInfo.annualized_total_compensation_range ascending. Jobs whose annualized base compensation is unspecified are put at the end of search results.
      • "annualized_total_compensation desc": By job's CompensationInfo.annualized_total_compensation_range descending. Jobs whose annualized base compensation is unspecified are put at the end of search results.
      • "custom_ranking desc": By the relevance score adjusted to the SearchJobsRequest.CustomRankingInfo.ranking_expression with weight factor assigned by SearchJobsRequest.CustomRankingInfo.importance_level in descending order.
      • Location sorting: Use the special syntax to order jobs by distance:
        "distance_from('Hawaii')": Order by distance from Hawaii.
        "distance_from(19.89, 155.5)": Order by distance from a coordinate.
        "distance_from('Hawaii'), distance_from('Puerto Rico')": Order by multiple locations. See details below.
        "distance_from('Hawaii'), distance_from(19.89, 155.5)": Order by multiple locations. See details below.
        The string can have a maximum of 256 characters. When multiple distance centers are provided, a job that is close to any of the distance centers would have a high rank. When a job has multiple locations, the job location closest to one of the distance centers will be used. Jobs that don't have locations will be ranked at the bottom. Distance is calculated with a precision of 11.3 meters (37.4 feet). Diversification strategy is still applied unless explicitly disabled in diversification_level.
    • diversification_level (::Google::Cloud::Talent::V4beta1::SearchJobsRequest::DiversificationLevel) (defaults to: nil) —

      Controls whether highly similar jobs are returned next to each other in the search results. Jobs are identified as highly similar based on their titles, job categories, and locations. Highly similar results are clustered so that only one representative job of the cluster is displayed to the job seeker higher up in the results, with the other jobs being displayed lower down in the results.

      Defaults to DiversificationLevel.SIMPLE if no value is specified.

    • custom_ranking_info (::Google::Cloud::Talent::V4beta1::SearchJobsRequest::CustomRankingInfo, ::Hash) (defaults to: nil) —

      Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm).

    • disable_keyword_match (::Boolean) (defaults to: nil) —

      This field is deprecated. Please use SearchJobsRequest.keyword_match_mode going forward.

      To migrate, disable_keyword_match set to false maps to KeywordMatchMode.KEYWORD_MATCH_ALL, and disable_keyword_match set to true maps to KeywordMatchMode.KEYWORD_MATCH_DISABLED. If SearchJobsRequest.keyword_match_mode is set, this field is ignored.

      Controls whether to disable exact keyword match on Job.title, Job.description, Job.company_display_name, Job.addresses, Job.qualifications. When disable keyword match is turned off, a keyword match returns jobs that do not match given category filters when there are matching keywords. For example, for the query "program manager," a result is returned even if the job posting has the title "software developer," which doesn't fall into "program manager" ontology, but does have "program manager" appearing in its description.

      For queries like "cloud" that don't contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this flag's value.

      Use Company.keyword_searchable_job_custom_attributes if company-specific globally matched custom field/attribute string values are needed. Enabling keyword match improves recall of subsequent search requests.

      Defaults to false.

    • keyword_match_mode (::Google::Cloud::Talent::V4beta1::SearchJobsRequest::KeywordMatchMode) (defaults to: nil) —

      Controls what keyword match options to use.

      Defaults to KeywordMatchMode.KEYWORD_MATCH_ALL if no value is specified.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 1750

def search_jobs_for_alert request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::SearchJobsRequest

  # 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.search_jobs_for_alert.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::V4beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  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.search_jobs_for_alert.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.search_jobs_for_alert.retry_policy

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

  @job_service_stub.call_rpc :search_jobs_for_alert, 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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


133
134
135
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 133

def universe_domain
  @job_service_stub.universe_domain
end

#update_job(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Job #update_job(job: nil, update_mask: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Job

Updates specified job.

Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.

Examples:

Basic example

require "google/cloud/talent/v4beta1"

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

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

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

# The returned object is of type Google::Cloud::Talent::V4beta1::Job.
p result

Overloads:

  • #update_job(request, options = nil) ⇒ ::Google::Cloud::Talent::V4beta1::Job

    Pass arguments to update_job via a request object, either of type UpdateJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Talent::V4beta1::UpdateJobRequest, ::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.

  • #update_job(job: nil, update_mask: nil) ⇒ ::Google::Cloud::Talent::V4beta1::Job

    Pass arguments to update_job 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:

    • job (::Google::Cloud::Talent::V4beta1::Job, ::Hash) (defaults to: nil) —

      Required. The Job to be updated.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Strongly recommended for the best service experience.

      If update_mask is provided, only the specified fields in job are updated. Otherwise all the fields are updated.

      A field mask to restrict the fields that are updated. Only top level fields of Job are supported.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
 
# File 'lib/google/cloud/talent/v4beta1/job_service/client.rb', line 555

def update_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Talent::V4beta1::UpdateJobRequest

  # 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_job.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version 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::V4beta1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.job&.name
    header_params["job.name"] = request.job.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_job.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_job.retry_policy

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

  @job_service_stub.call_rpc :update_job, 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