Cloud Talent Solution API - Module Google::Cloud::Talent (v2.0.0)

Reference documentation and code samples for the Cloud Talent Solution API module Google::Cloud::Talent.

Methods

.company_service

def self.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 Talent.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.

.company_service_available?

def self.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 Talent.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.

.completion

def self.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 Talent.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.

.completion_available?

def self.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 Talent.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.

.configure

def self.configure() -> ::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
  • (::Google::Cloud.configure.talent)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.event_service

def self.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 Talent.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.

.event_service_available?

def self.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 Talent.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.

.job_service

def self.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 Talent.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.

.job_service_available?

def self.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 Talent.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.

.tenant_service

def self.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 Talent.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.

.tenant_service_available?

def self.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 Talent.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.

Constants

VERSION

value: "2.0.0"