Module: Google::Cloud::Talent

Defined in:
lib/google/cloud/talent.rb,
lib/google/cloud/talent/version.rb

Constant Summary collapse

VERSION = 
"2.0.3"

Class Method Summary collapse

Class Method Details

.company_service(version: :v4, transport: :grpc, &block) ⇒ ::Object

Create a new client object for CompanyService.

By default, this returns an instance of Google::Cloud::Talent::V4::CompanyService::Client for a gRPC client for version V4 of the API. However, you can specify a different API version by passing it in the version parameter. If the CompanyService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the CompanyService service. You can determine whether the method will succeed by calling company_service_available?.

About CompanyService

A service that handles company management, including CRUD and enumeration.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v4) —

    The API version to connect to. Optional. Defaults to :v4.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/cloud/talent.rb', line 75

def self.company_service version: :v4, transport: :grpc, &block
  require "google/cloud/talent/#{version.to_s.downcase}"

  package_name = Google::Cloud::Talent
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Talent.const_get(package_name).const_get(:CompanyService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.company_service_available?(version: :v4, transport: :grpc) ⇒ boolean

Determines whether the CompanyService service is supported by the current client. If true, you can retrieve a client object by calling company_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the CompanyService service, or if the versioned client gem needs an update to support the CompanyService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v4) —

    The API version to connect to. Optional. Defaults to :v4.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/google/cloud/talent.rb', line 99

def self.company_service_available? version: :v4, transport: :grpc
  require "google/cloud/talent/#{version.to_s.downcase}"
  package_name = Google::Cloud::Talent
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::Talent.const_get package_name
  return false unless service_module.const_defined? :CompanyService
  service_module = service_module.const_get :CompanyService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.completion(version: :v4, transport: :grpc, &block) ⇒ ::Object

Create a new client object for Completion.

By default, this returns an instance of Google::Cloud::Talent::V4::Completion::Client for a gRPC client for version V4 of the API. However, you can specify a different API version by passing it in the version parameter. If the Completion service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Completion service. You can determine whether the method will succeed by calling completion_available?.

About Completion

A service handles auto completion.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v4) —

    The API version to connect to. Optional. Defaults to :v4.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/google/cloud/talent.rb', line 145

def self.completion version: :v4, transport: :grpc, &block
  require "google/cloud/talent/#{version.to_s.downcase}"

  package_name = Google::Cloud::Talent
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Talent.const_get(package_name).const_get(:Completion)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.completion_available?(version: :v4, transport: :grpc) ⇒ boolean

Determines whether the Completion service is supported by the current client. If true, you can retrieve a client object by calling completion. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Completion service, or if the versioned client gem needs an update to support the Completion service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v4) —

    The API version to connect to. Optional. Defaults to :v4.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/google/cloud/talent.rb', line 169

def self.completion_available? version: :v4, transport: :grpc
  require "google/cloud/talent/#{version.to_s.downcase}"
  package_name = Google::Cloud::Talent
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::Talent.const_get package_name
  return false unless service_module.const_defined? :Completion
  service_module = service_module.const_get :Completion
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.configure {|::Google::Cloud.configure.talent| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-talent library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



426
427
428
429
430
 
# File 'lib/google/cloud/talent.rb', line 426

def self.configure
  yield ::Google::Cloud.configure.talent if block_given?

  ::Google::Cloud.configure.talent
end

.event_service(version: :v4, transport: :grpc, &block) ⇒ ::Object

Create a new client object for EventService.

By default, this returns an instance of Google::Cloud::Talent::V4::EventService::Client for a gRPC client for version V4 of the API. However, you can specify a different API version by passing it in the version parameter. If the EventService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the EventService service. You can determine whether the method will succeed by calling event_service_available?.

About EventService

A service handles client event report.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v4) —

    The API version to connect to. Optional. Defaults to :v4.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/google/cloud/talent.rb', line 215

def self.event_service version: :v4, transport: :grpc, &block
  require "google/cloud/talent/#{version.to_s.downcase}"

  package_name = Google::Cloud::Talent
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Talent.const_get(package_name).const_get(:EventService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.event_service_available?(version: :v4, transport: :grpc) ⇒ boolean

Determines whether the EventService service is supported by the current client. If true, you can retrieve a client object by calling event_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the EventService service, or if the versioned client gem needs an update to support the EventService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v4) —

    The API version to connect to. Optional. Defaults to :v4.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/google/cloud/talent.rb', line 239

def self.event_service_available? version: :v4, transport: :grpc
  require "google/cloud/talent/#{version.to_s.downcase}"
  package_name = Google::Cloud::Talent
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::Talent.const_get package_name
  return false unless service_module.const_defined? :EventService
  service_module = service_module.const_get :EventService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.job_service(version: :v4, transport: :grpc, &block) ⇒ ::Object

Create a new client object for JobService.

By default, this returns an instance of Google::Cloud::Talent::V4::JobService::Client for a gRPC client for version V4 of the API. However, you can specify a different API version by passing it in the version parameter. If the JobService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the JobService service. You can determine whether the method will succeed by calling job_service_available?.

About JobService

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

Parameters:

  • version (::String, ::Symbol) (defaults to: :v4) —

    The API version to connect to. Optional. Defaults to :v4.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/google/cloud/talent.rb', line 285

def self.job_service version: :v4, transport: :grpc, &block
  require "google/cloud/talent/#{version.to_s.downcase}"

  package_name = Google::Cloud::Talent
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Talent.const_get(package_name).const_get(:JobService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.job_service_available?(version: :v4, transport: :grpc) ⇒ boolean

Determines whether the JobService service is supported by the current client. If true, you can retrieve a client object by calling job_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the JobService service, or if the versioned client gem needs an update to support the JobService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v4) —

    The API version to connect to. Optional. Defaults to :v4.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/google/cloud/talent.rb', line 309

def self.job_service_available? version: :v4, transport: :grpc
  require "google/cloud/talent/#{version.to_s.downcase}"
  package_name = Google::Cloud::Talent
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::Talent.const_get package_name
  return false unless service_module.const_defined? :JobService
  service_module = service_module.const_get :JobService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.tenant_service(version: :v4, transport: :grpc, &block) ⇒ ::Object

Create a new client object for TenantService.

By default, this returns an instance of Google::Cloud::Talent::V4::TenantService::Client for a gRPC client for version V4 of the API. However, you can specify a different API version by passing it in the version parameter. If the TenantService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the TenantService service. You can determine whether the method will succeed by calling tenant_service_available?.

About TenantService

A service that handles tenant management, including CRUD and enumeration.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v4) —

    The API version to connect to. Optional. Defaults to :v4.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/google/cloud/talent.rb', line 355

def self.tenant_service version: :v4, transport: :grpc, &block
  require "google/cloud/talent/#{version.to_s.downcase}"

  package_name = Google::Cloud::Talent
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Talent.const_get(package_name).const_get(:TenantService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.tenant_service_available?(version: :v4, transport: :grpc) ⇒ boolean

Determines whether the TenantService service is supported by the current client. If true, you can retrieve a client object by calling tenant_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the TenantService service, or if the versioned client gem needs an update to support the TenantService service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v4) —

    The API version to connect to. Optional. Defaults to :v4.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/google/cloud/talent.rb', line 379

def self.tenant_service_available? version: :v4, transport: :grpc
  require "google/cloud/talent/#{version.to_s.downcase}"
  package_name = Google::Cloud::Talent
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::Talent.const_get package_name
  return false unless service_module.const_defined? :TenantService
  service_module = service_module.const_get :TenantService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end