Package com.google.cloud.talent.v4

The interfaces provided are listed below, along with usage samples.

CompanyServiceClient

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

Sample for CompanyServiceClient:


 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   TenantName parent = TenantName.of("[PROJECT]", "[TENANT]");
   Company company = Company.newBuilder().build();
   Company response = companyServiceClient.createCompany(parent, company);
 }
 

CompletionClient

Service Description: A service handles auto completion.

Sample for CompletionClient:


 try (CompletionClient completionClient = CompletionClient.create()) {
   CompleteQueryRequest request =
       CompleteQueryRequest.newBuilder()
           .setTenant(TenantName.of("[PROJECT]", "[TENANT]").toString())
           .setQuery("query107944136")
           .addAllLanguageCodes(new ArrayList<String>())
           .setPageSize(883849137)
           .setCompany(CompanyName.of("[PROJECT]", "[TENANT]", "[COMPANY]").toString())
           .build();
   CompleteQueryResponse response = completionClient.completeQuery(request);
 }
 

EventServiceClient

Service Description: A service handles client event report.

Sample for EventServiceClient:


 try (EventServiceClient eventServiceClient = EventServiceClient.create()) {
   TenantName parent = TenantName.of("[PROJECT]", "[TENANT]");
   ClientEvent clientEvent = ClientEvent.newBuilder().build();
   ClientEvent response = eventServiceClient.createClientEvent(parent, clientEvent);
 }
 

JobServiceClient

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

Sample for JobServiceClient:


 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   TenantName parent = TenantName.of("[PROJECT]", "[TENANT]");
   Job job = Job.newBuilder().build();
   Job response = jobServiceClient.createJob(parent, job);
 }
 

TenantServiceClient

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

Sample for TenantServiceClient:


 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Tenant tenant = Tenant.newBuilder().build();
   Tenant response = tenantServiceClient.createTenant(parent, tenant);
 }
 

Classes

BatchCreateJobsRequest

Request to create a batch of jobs.

Protobuf type google.cloud.talent.v4.BatchCreateJobsRequest

BatchCreateJobsRequest.Builder

Request to create a batch of jobs.

Protobuf type google.cloud.talent.v4.BatchCreateJobsRequest

BatchCreateJobsResponse

The result of JobService.BatchCreateJobs. It's used to replace google.longrunning.Operation.response in case of success.

Protobuf type google.cloud.talent.v4.BatchCreateJobsResponse

BatchCreateJobsResponse.Builder

The result of JobService.BatchCreateJobs. It's used to replace google.longrunning.Operation.response in case of success.

Protobuf type google.cloud.talent.v4.BatchCreateJobsResponse

BatchDeleteJobsRequest

Request to delete a batch of jobs.

Protobuf type google.cloud.talent.v4.BatchDeleteJobsRequest

BatchDeleteJobsRequest.Builder

Request to delete a batch of jobs.

Protobuf type google.cloud.talent.v4.BatchDeleteJobsRequest

BatchDeleteJobsResponse

The result of JobService.BatchDeleteJobs. It's used to replace google.longrunning.Operation.response in case of success.

Protobuf type google.cloud.talent.v4.BatchDeleteJobsResponse

BatchDeleteJobsResponse.Builder

The result of JobService.BatchDeleteJobs. It's used to replace google.longrunning.Operation.response in case of success.

Protobuf type google.cloud.talent.v4.BatchDeleteJobsResponse

BatchOperationMetadata

Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata.

Protobuf type google.cloud.talent.v4.BatchOperationMetadata

BatchOperationMetadata.Builder

Metadata used for long running operations returned by CTS batch APIs. It's used to replace google.longrunning.Operation.metadata.

Protobuf type google.cloud.talent.v4.BatchOperationMetadata

BatchUpdateJobsRequest

Request to update a batch of jobs.

Protobuf type google.cloud.talent.v4.BatchUpdateJobsRequest

BatchUpdateJobsRequest.Builder

Request to update a batch of jobs.

Protobuf type google.cloud.talent.v4.BatchUpdateJobsRequest

BatchUpdateJobsResponse

The result of JobService.BatchUpdateJobs. It's used to replace google.longrunning.Operation.response in case of success.

Protobuf type google.cloud.talent.v4.BatchUpdateJobsResponse

BatchUpdateJobsResponse.Builder

The result of JobService.BatchUpdateJobs. It's used to replace google.longrunning.Operation.response in case of success.

Protobuf type google.cloud.talent.v4.BatchUpdateJobsResponse

ClientEvent

An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of results for the API clients, enabling the service to perform optimally. The number of events sent must be consistent with other calls, such as job searches, issued to the service by the client.

Protobuf type google.cloud.talent.v4.ClientEvent

ClientEvent.Builder

An event issued when an end user interacts with the application that implements Cloud Talent Solution. Providing this information improves the quality of results for the API clients, enabling the service to perform optimally. The number of events sent must be consistent with other calls, such as job searches, issued to the service by the client.

Protobuf type google.cloud.talent.v4.ClientEvent

CommonProto

CommuteFilter

Parameters needed for commute search.

Protobuf type google.cloud.talent.v4.CommuteFilter

CommuteFilter.Builder

Parameters needed for commute search.

Protobuf type google.cloud.talent.v4.CommuteFilter

Company

A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position.

Protobuf type google.cloud.talent.v4.Company

Company.Builder

A Company resource represents a company in the service. A company is the entity that owns job postings, that is, the hiring entity responsible for employing applicants for the job position.

Protobuf type google.cloud.talent.v4.Company

Company.DerivedInfo

Derived details about the company.

Protobuf type google.cloud.talent.v4.Company.DerivedInfo

Company.DerivedInfo.Builder

Derived details about the company.

Protobuf type google.cloud.talent.v4.Company.DerivedInfo

CompanyName

CompanyName.Builder

Builder for projects/{project}/tenants/{tenant}/companies/{company}.

CompanyProto

CompanyServiceClient

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   TenantName parent = TenantName.of("[PROJECT]", "[TENANT]");
   Company company = Company.newBuilder().build();
   Company response = companyServiceClient.createCompany(parent, company);
 }
 

Note: close() needs to be called on the CompanyServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of CompanyServiceSettings to create(). For example:

To customize credentials:


 CompanyServiceSettings companyServiceSettings =
     CompanyServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CompanyServiceClient companyServiceClient = CompanyServiceClient.create(companyServiceSettings);
 

To customize the endpoint:


 CompanyServiceSettings companyServiceSettings =
     CompanyServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CompanyServiceClient companyServiceClient = CompanyServiceClient.create(companyServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

CompanyServiceClient.ListCompaniesFixedSizeCollection

CompanyServiceClient.ListCompaniesPage

CompanyServiceClient.ListCompaniesPagedResponse

CompanyServiceGrpc

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

CompanyServiceGrpc.CompanyServiceBlockingStub

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

CompanyServiceGrpc.CompanyServiceFutureStub

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

CompanyServiceGrpc.CompanyServiceImplBase

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

CompanyServiceGrpc.CompanyServiceStub

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

CompanyServiceProto

CompanyServiceSettings

Settings class to configure an instance of CompanyServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (jobs.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createCompany to 30 seconds:


 CompanyServiceSettings.Builder companyServiceSettingsBuilder =
     CompanyServiceSettings.newBuilder();
 companyServiceSettingsBuilder
     .createCompanySettings()
     .setRetrySettings(
         companyServiceSettingsBuilder
             .createCompanySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CompanyServiceSettings companyServiceSettings = companyServiceSettingsBuilder.build();
 

CompanyServiceSettings.Builder

Builder for CompanyServiceSettings.

CompensationFilter

Filter on job compensation type and amount.

Protobuf type google.cloud.talent.v4.CompensationFilter

CompensationFilter.Builder

Filter on job compensation type and amount.

Protobuf type google.cloud.talent.v4.CompensationFilter

CompensationInfo

Job compensation details.

Protobuf type google.cloud.talent.v4.CompensationInfo

CompensationInfo.Builder

Job compensation details.

Protobuf type google.cloud.talent.v4.CompensationInfo

CompensationInfo.CompensationEntry

A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if

  • it contains valid amount or range.
  • and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.

Protobuf type google.cloud.talent.v4.CompensationInfo.CompensationEntry

CompensationInfo.CompensationEntry.Builder

A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if

  • it contains valid amount or range.
  • and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.

Protobuf type google.cloud.talent.v4.CompensationInfo.CompensationEntry

CompensationInfo.CompensationRange

Compensation range.

Protobuf type google.cloud.talent.v4.CompensationInfo.CompensationRange

CompensationInfo.CompensationRange.Builder

Compensation range.

Protobuf type google.cloud.talent.v4.CompensationInfo.CompensationRange

CompleteQueryRequest

Auto-complete parameters.

Protobuf type google.cloud.talent.v4.CompleteQueryRequest

CompleteQueryRequest.Builder

Auto-complete parameters.

Protobuf type google.cloud.talent.v4.CompleteQueryRequest

CompleteQueryResponse

Response of auto-complete query.

Protobuf type google.cloud.talent.v4.CompleteQueryResponse

CompleteQueryResponse.Builder

Response of auto-complete query.

Protobuf type google.cloud.talent.v4.CompleteQueryResponse

CompleteQueryResponse.CompletionResult

Resource that represents completion results.

Protobuf type google.cloud.talent.v4.CompleteQueryResponse.CompletionResult

CompleteQueryResponse.CompletionResult.Builder

Resource that represents completion results.

Protobuf type google.cloud.talent.v4.CompleteQueryResponse.CompletionResult

CompletionClient

Service Description: A service handles auto completion.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 try (CompletionClient completionClient = CompletionClient.create()) {
   CompleteQueryRequest request =
       CompleteQueryRequest.newBuilder()
           .setTenant(TenantName.of("[PROJECT]", "[TENANT]").toString())
           .setQuery("query107944136")
           .addAllLanguageCodes(new ArrayList<String>())
           .setPageSize(883849137)
           .setCompany(CompanyName.of("[PROJECT]", "[TENANT]", "[COMPANY]").toString())
           .build();
   CompleteQueryResponse response = completionClient.completeQuery(request);
 }
 

Note: close() needs to be called on the CompletionClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of CompletionSettings to create(). For example:

To customize credentials:


 CompletionSettings completionSettings =
     CompletionSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CompletionClient completionClient = CompletionClient.create(completionSettings);
 

To customize the endpoint:


 CompletionSettings completionSettings =
     CompletionSettings.newBuilder().setEndpoint(myEndpoint).build();
 CompletionClient completionClient = CompletionClient.create(completionSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

CompletionGrpc

A service handles auto completion.

CompletionGrpc.CompletionBlockingStub

A service handles auto completion.

CompletionGrpc.CompletionFutureStub

A service handles auto completion.

CompletionGrpc.CompletionImplBase

A service handles auto completion.

CompletionGrpc.CompletionStub

A service handles auto completion.

CompletionServiceProto

CompletionSettings

Settings class to configure an instance of CompletionClient.

The default instance has everything set to sensible defaults:

  • The default service address (jobs.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of completeQuery to 30 seconds:


 CompletionSettings.Builder completionSettingsBuilder = CompletionSettings.newBuilder();
 completionSettingsBuilder
     .completeQuerySettings()
     .setRetrySettings(
         completionSettingsBuilder
             .completeQuerySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CompletionSettings completionSettings = completionSettingsBuilder.build();
 

CompletionSettings.Builder

Builder for CompletionSettings.

CreateClientEventRequest

The report event request.

Protobuf type google.cloud.talent.v4.CreateClientEventRequest

CreateClientEventRequest.Builder

The report event request.

Protobuf type google.cloud.talent.v4.CreateClientEventRequest

CreateCompanyRequest

The Request of the CreateCompany method.

Protobuf type google.cloud.talent.v4.CreateCompanyRequest

CreateCompanyRequest.Builder

The Request of the CreateCompany method.

Protobuf type google.cloud.talent.v4.CreateCompanyRequest

CreateJobRequest

Create job request.

Protobuf type google.cloud.talent.v4.CreateJobRequest

CreateJobRequest.Builder

Create job request.

Protobuf type google.cloud.talent.v4.CreateJobRequest

CreateTenantRequest

The Request of the CreateTenant method.

Protobuf type google.cloud.talent.v4.CreateTenantRequest

CreateTenantRequest.Builder

The Request of the CreateTenant method.

Protobuf type google.cloud.talent.v4.CreateTenantRequest

CustomAttribute

Custom attribute values that are either filterable or non-filterable.

Protobuf type google.cloud.talent.v4.CustomAttribute

CustomAttribute.Builder

Custom attribute values that are either filterable or non-filterable.

Protobuf type google.cloud.talent.v4.CustomAttribute

DeleteCompanyRequest

Request to delete a company.

Protobuf type google.cloud.talent.v4.DeleteCompanyRequest

DeleteCompanyRequest.Builder

Request to delete a company.

Protobuf type google.cloud.talent.v4.DeleteCompanyRequest

DeleteJobRequest

Delete job request.

Protobuf type google.cloud.talent.v4.DeleteJobRequest

DeleteJobRequest.Builder

Delete job request.

Protobuf type google.cloud.talent.v4.DeleteJobRequest

DeleteTenantRequest

Request to delete a tenant.

Protobuf type google.cloud.talent.v4.DeleteTenantRequest

DeleteTenantRequest.Builder

Request to delete a tenant.

Protobuf type google.cloud.talent.v4.DeleteTenantRequest

DeviceInfo

Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices.

Protobuf type google.cloud.talent.v4.DeviceInfo

DeviceInfo.Builder

Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices.

Protobuf type google.cloud.talent.v4.DeviceInfo

EventProto

EventServiceClient

Service Description: A service handles client event report.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 try (EventServiceClient eventServiceClient = EventServiceClient.create()) {
   TenantName parent = TenantName.of("[PROJECT]", "[TENANT]");
   ClientEvent clientEvent = ClientEvent.newBuilder().build();
   ClientEvent response = eventServiceClient.createClientEvent(parent, clientEvent);
 }
 

Note: close() needs to be called on the EventServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of EventServiceSettings to create(). For example:

To customize credentials:


 EventServiceSettings eventServiceSettings =
     EventServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EventServiceClient eventServiceClient = EventServiceClient.create(eventServiceSettings);
 

To customize the endpoint:


 EventServiceSettings eventServiceSettings =
     EventServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 EventServiceClient eventServiceClient = EventServiceClient.create(eventServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

EventServiceGrpc

A service handles client event report.

EventServiceGrpc.EventServiceBlockingStub

A service handles client event report.

EventServiceGrpc.EventServiceFutureStub

A service handles client event report.

EventServiceGrpc.EventServiceImplBase

A service handles client event report.

EventServiceGrpc.EventServiceStub

A service handles client event report.

EventServiceProto

EventServiceSettings

Settings class to configure an instance of EventServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (jobs.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createClientEvent to 30 seconds:


 EventServiceSettings.Builder eventServiceSettingsBuilder = EventServiceSettings.newBuilder();
 eventServiceSettingsBuilder
     .createClientEventSettings()
     .setRetrySettings(
         eventServiceSettingsBuilder
             .createClientEventSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 EventServiceSettings eventServiceSettings = eventServiceSettingsBuilder.build();
 

EventServiceSettings.Builder

Builder for EventServiceSettings.

FiltersProto

GetCompanyRequest

Request for getting a company by name.

Protobuf type google.cloud.talent.v4.GetCompanyRequest

GetCompanyRequest.Builder

Request for getting a company by name.

Protobuf type google.cloud.talent.v4.GetCompanyRequest

GetJobRequest

Get job request.

Protobuf type google.cloud.talent.v4.GetJobRequest

GetJobRequest.Builder

Get job request.

Protobuf type google.cloud.talent.v4.GetJobRequest

GetTenantRequest

Request for getting a tenant by name.

Protobuf type google.cloud.talent.v4.GetTenantRequest

GetTenantRequest.Builder

Request for getting a tenant by name.

Protobuf type google.cloud.talent.v4.GetTenantRequest

HistogramProto

HistogramQuery

The histogram request.

Protobuf type google.cloud.talent.v4.HistogramQuery

HistogramQuery.Builder

The histogram request.

Protobuf type google.cloud.talent.v4.HistogramQuery

HistogramQueryResult

Histogram result that matches HistogramQuery specified in searches.

Protobuf type google.cloud.talent.v4.HistogramQueryResult

HistogramQueryResult.Builder

Histogram result that matches HistogramQuery specified in searches.

Protobuf type google.cloud.talent.v4.HistogramQueryResult

Job

A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.

Protobuf type google.cloud.talent.v4.Job

Job.ApplicationInfo

Application related details of a job posting.

Protobuf type google.cloud.talent.v4.Job.ApplicationInfo

Job.ApplicationInfo.Builder

Application related details of a job posting.

Protobuf type google.cloud.talent.v4.Job.ApplicationInfo

Job.Builder

A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.

Protobuf type google.cloud.talent.v4.Job

Job.DerivedInfo

Derived details about the job posting.

Protobuf type google.cloud.talent.v4.Job.DerivedInfo

Job.DerivedInfo.Builder

Derived details about the job posting.

Protobuf type google.cloud.talent.v4.Job.DerivedInfo

Job.ProcessingOptions

Options for job processing.

Protobuf type google.cloud.talent.v4.Job.ProcessingOptions

Job.ProcessingOptions.Builder

Options for job processing.

Protobuf type google.cloud.talent.v4.Job.ProcessingOptions

JobEvent

An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.

Protobuf type google.cloud.talent.v4.JobEvent

JobEvent.Builder

An event issued when a job seeker interacts with the application that implements Cloud Talent Solution.

Protobuf type google.cloud.talent.v4.JobEvent

JobName

JobName.Builder

Builder for projects/{project}/tenants/{tenant}/jobs/{job}.

JobProto

JobQuery

The query required to perform a search query.

Protobuf type google.cloud.talent.v4.JobQuery

JobQuery.Builder

The query required to perform a search query.

Protobuf type google.cloud.talent.v4.JobQuery

JobResult

Mutation result of a job from a batch operation.

Protobuf type google.cloud.talent.v4.JobResult

JobResult.Builder

Mutation result of a job from a batch operation.

Protobuf type google.cloud.talent.v4.JobResult

JobServiceClient

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 try (JobServiceClient jobServiceClient = JobServiceClient.create()) {
   TenantName parent = TenantName.of("[PROJECT]", "[TENANT]");
   Job job = Job.newBuilder().build();
   Job response = jobServiceClient.createJob(parent, job);
 }
 

Note: close() needs to be called on the JobServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of JobServiceSettings to create(). For example:

To customize credentials:


 JobServiceSettings jobServiceSettings =
     JobServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 JobServiceClient jobServiceClient = JobServiceClient.create(jobServiceSettings);
 

To customize the endpoint:


 JobServiceSettings jobServiceSettings =
     JobServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 JobServiceClient jobServiceClient = JobServiceClient.create(jobServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

JobServiceClient.ListJobsFixedSizeCollection

JobServiceClient.ListJobsPage

JobServiceClient.ListJobsPagedResponse

JobServiceGrpc

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

JobServiceGrpc.JobServiceBlockingStub

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

JobServiceGrpc.JobServiceFutureStub

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

JobServiceGrpc.JobServiceImplBase

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

JobServiceGrpc.JobServiceStub

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

JobServiceProto

JobServiceSettings

Settings class to configure an instance of JobServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (jobs.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createJob to 30 seconds:


 JobServiceSettings.Builder jobServiceSettingsBuilder = JobServiceSettings.newBuilder();
 jobServiceSettingsBuilder
     .createJobSettings()
     .setRetrySettings(
         jobServiceSettingsBuilder
             .createJobSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 JobServiceSettings jobServiceSettings = jobServiceSettingsBuilder.build();
 

JobServiceSettings.Builder

Builder for JobServiceSettings.

ListCompaniesRequest

List companies for which the client has ACL visibility.

Protobuf type google.cloud.talent.v4.ListCompaniesRequest

ListCompaniesRequest.Builder

List companies for which the client has ACL visibility.

Protobuf type google.cloud.talent.v4.ListCompaniesRequest

ListCompaniesResponse

The List companies response object.

Protobuf type google.cloud.talent.v4.ListCompaniesResponse

ListCompaniesResponse.Builder

The List companies response object.

Protobuf type google.cloud.talent.v4.ListCompaniesResponse

ListJobsRequest

List jobs request.

Protobuf type google.cloud.talent.v4.ListJobsRequest

ListJobsRequest.Builder

List jobs request.

Protobuf type google.cloud.talent.v4.ListJobsRequest

ListJobsResponse

List jobs response.

Protobuf type google.cloud.talent.v4.ListJobsResponse

ListJobsResponse.Builder

List jobs response.

Protobuf type google.cloud.talent.v4.ListJobsResponse

ListTenantsRequest

List tenants for which the client has ACL visibility.

Protobuf type google.cloud.talent.v4.ListTenantsRequest

ListTenantsRequest.Builder

List tenants for which the client has ACL visibility.

Protobuf type google.cloud.talent.v4.ListTenantsRequest

ListTenantsResponse

The List tenants response object.

Protobuf type google.cloud.talent.v4.ListTenantsResponse

ListTenantsResponse.Builder

The List tenants response object.

Protobuf type google.cloud.talent.v4.ListTenantsResponse

Location

A resource that represents a location with full geographic information.

Protobuf type google.cloud.talent.v4.Location

Location.Builder

A resource that represents a location with full geographic information.

Protobuf type google.cloud.talent.v4.Location

LocationFilter

Geographic region of the search.

Protobuf type google.cloud.talent.v4.LocationFilter

LocationFilter.Builder

Geographic region of the search.

Protobuf type google.cloud.talent.v4.LocationFilter

ProjectName

ProjectName.Builder

Builder for projects/{project}.

RequestMetadata

Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.

Protobuf type google.cloud.talent.v4.RequestMetadata

RequestMetadata.Builder

Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.

Protobuf type google.cloud.talent.v4.RequestMetadata

ResponseMetadata

Additional information returned to client, such as debugging information.

Protobuf type google.cloud.talent.v4.ResponseMetadata

ResponseMetadata.Builder

Additional information returned to client, such as debugging information.

Protobuf type google.cloud.talent.v4.ResponseMetadata

SearchJobsRequest

The Request body of the SearchJobs call.

Protobuf type google.cloud.talent.v4.SearchJobsRequest

SearchJobsRequest.Builder

The Request body of the SearchJobs call.

Protobuf type google.cloud.talent.v4.SearchJobsRequest

SearchJobsRequest.CustomRankingInfo

Custom ranking information for SearchJobsRequest.

Protobuf type google.cloud.talent.v4.SearchJobsRequest.CustomRankingInfo

SearchJobsRequest.CustomRankingInfo.Builder

Custom ranking information for SearchJobsRequest.

Protobuf type google.cloud.talent.v4.SearchJobsRequest.CustomRankingInfo

SearchJobsResponse

Response for SearchJob method.

Protobuf type google.cloud.talent.v4.SearchJobsResponse

SearchJobsResponse.Builder

Response for SearchJob method.

Protobuf type google.cloud.talent.v4.SearchJobsResponse

SearchJobsResponse.CommuteInfo

Commute details related to this job.

Protobuf type google.cloud.talent.v4.SearchJobsResponse.CommuteInfo

SearchJobsResponse.CommuteInfo.Builder

Commute details related to this job.

Protobuf type google.cloud.talent.v4.SearchJobsResponse.CommuteInfo

SearchJobsResponse.MatchingJob

Job entry with metadata inside SearchJobsResponse.

Protobuf type google.cloud.talent.v4.SearchJobsResponse.MatchingJob

SearchJobsResponse.MatchingJob.Builder

Job entry with metadata inside SearchJobsResponse.

Protobuf type google.cloud.talent.v4.SearchJobsResponse.MatchingJob

SpellingCorrection

Spell check result.

Protobuf type google.cloud.talent.v4.SpellingCorrection

SpellingCorrection.Builder

Spell check result.

Protobuf type google.cloud.talent.v4.SpellingCorrection

Tenant

A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like jobs. Customer may create multiple tenants to provide data isolation for different groups.

Protobuf type google.cloud.talent.v4.Tenant

Tenant.Builder

A Tenant resource represents a tenant in the service. A tenant is a group or entity that shares common access with specific privileges for resources like jobs. Customer may create multiple tenants to provide data isolation for different groups.

Protobuf type google.cloud.talent.v4.Tenant

TenantName

TenantName.Builder

Builder for projects/{project}/tenants/{tenant}.

TenantProto

TenantServiceClient

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

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Tenant tenant = Tenant.newBuilder().build();
   Tenant response = tenantServiceClient.createTenant(parent, tenant);
 }
 

Note: close() needs to be called on the TenantServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of TenantServiceSettings to create(). For example:

To customize credentials:


 TenantServiceSettings tenantServiceSettings =
     TenantServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TenantServiceClient tenantServiceClient = TenantServiceClient.create(tenantServiceSettings);
 

To customize the endpoint:


 TenantServiceSettings tenantServiceSettings =
     TenantServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TenantServiceClient tenantServiceClient = TenantServiceClient.create(tenantServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

TenantServiceClient.ListTenantsFixedSizeCollection

TenantServiceClient.ListTenantsPage

TenantServiceClient.ListTenantsPagedResponse

TenantServiceGrpc

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

TenantServiceGrpc.TenantServiceBlockingStub

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

TenantServiceGrpc.TenantServiceFutureStub

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

TenantServiceGrpc.TenantServiceImplBase

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

TenantServiceGrpc.TenantServiceStub

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

TenantServiceProto

TenantServiceSettings

Settings class to configure an instance of TenantServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (jobs.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createTenant to 30 seconds:


 TenantServiceSettings.Builder tenantServiceSettingsBuilder = TenantServiceSettings.newBuilder();
 tenantServiceSettingsBuilder
     .createTenantSettings()
     .setRetrySettings(
         tenantServiceSettingsBuilder
             .createTenantSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TenantServiceSettings tenantServiceSettings = tenantServiceSettingsBuilder.build();
 

TenantServiceSettings.Builder

Builder for TenantServiceSettings.

TimestampRange

Message representing a period of time between two timestamps.

Protobuf type google.cloud.talent.v4.TimestampRange

TimestampRange.Builder

Message representing a period of time between two timestamps.

Protobuf type google.cloud.talent.v4.TimestampRange

UpdateCompanyRequest

Request for updating a specified company.

Protobuf type google.cloud.talent.v4.UpdateCompanyRequest

UpdateCompanyRequest.Builder

Request for updating a specified company.

Protobuf type google.cloud.talent.v4.UpdateCompanyRequest

UpdateJobRequest

Update job request.

Protobuf type google.cloud.talent.v4.UpdateJobRequest

UpdateJobRequest.Builder

Update job request.

Protobuf type google.cloud.talent.v4.UpdateJobRequest

UpdateTenantRequest

Request for updating a specified tenant.

Protobuf type google.cloud.talent.v4.UpdateTenantRequest

UpdateTenantRequest.Builder

Request for updating a specified tenant.

Protobuf type google.cloud.talent.v4.UpdateTenantRequest

Interfaces

BatchCreateJobsRequestOrBuilder

BatchCreateJobsResponseOrBuilder

BatchDeleteJobsRequestOrBuilder

BatchDeleteJobsResponseOrBuilder

BatchOperationMetadataOrBuilder

BatchUpdateJobsRequestOrBuilder

BatchUpdateJobsResponseOrBuilder

ClientEventOrBuilder

CommuteFilterOrBuilder

Company.DerivedInfoOrBuilder

CompanyOrBuilder

CompensationFilterOrBuilder

CompensationInfo.CompensationEntryOrBuilder

CompensationInfo.CompensationRangeOrBuilder

CompensationInfoOrBuilder

CompleteQueryRequestOrBuilder

CompleteQueryResponse.CompletionResultOrBuilder

CompleteQueryResponseOrBuilder

CreateClientEventRequestOrBuilder

CreateCompanyRequestOrBuilder

CreateJobRequestOrBuilder

CreateTenantRequestOrBuilder

CustomAttributeOrBuilder

DeleteCompanyRequestOrBuilder

DeleteJobRequestOrBuilder

DeleteTenantRequestOrBuilder

DeviceInfoOrBuilder

GetCompanyRequestOrBuilder

GetJobRequestOrBuilder

GetTenantRequestOrBuilder

HistogramQueryOrBuilder

HistogramQueryResultOrBuilder

Job.ApplicationInfoOrBuilder

Job.DerivedInfoOrBuilder

Job.ProcessingOptionsOrBuilder

JobEventOrBuilder

JobOrBuilder

JobQueryOrBuilder

JobResultOrBuilder

ListCompaniesRequestOrBuilder

ListCompaniesResponseOrBuilder

ListJobsRequestOrBuilder

ListJobsResponseOrBuilder

ListTenantsRequestOrBuilder

ListTenantsResponseOrBuilder

LocationFilterOrBuilder

LocationOrBuilder

RequestMetadataOrBuilder

ResponseMetadataOrBuilder

SearchJobsRequest.CustomRankingInfoOrBuilder

SearchJobsRequestOrBuilder

SearchJobsResponse.CommuteInfoOrBuilder

SearchJobsResponse.MatchingJobOrBuilder

SearchJobsResponseOrBuilder

SpellingCorrectionOrBuilder

TenantOrBuilder

TimestampRangeOrBuilder

UpdateCompanyRequestOrBuilder

UpdateJobRequestOrBuilder

UpdateTenantRequestOrBuilder

Enums

BatchOperationMetadata.State

Protobuf enum google.cloud.talent.v4.BatchOperationMetadata.State

ClientEvent.EventCase

CommuteFilter.RoadTraffic

The traffic density to use when calculating commute time.

Protobuf enum google.cloud.talent.v4.CommuteFilter.RoadTraffic

CommuteFilter.TrafficOptionCase

CommuteMethod

Method for commute. Walking, biking and wheelchair accessible transit is still in the Preview stage.

Protobuf enum google.cloud.talent.v4.CommuteMethod

CompanySize

An enum that represents the size of the company.

Protobuf enum google.cloud.talent.v4.CompanySize

CompensationFilter.FilterType

Specify the type of filtering.

Protobuf enum google.cloud.talent.v4.CompensationFilter.FilterType

CompensationInfo.CompensationEntry.CompensationAmountCase

CompensationInfo.CompensationType

The type of compensation. For compensation amounts specified in non-monetary amounts, describe the compensation scheme in the CompensationEntry.description. For example, tipping format is described in CompensationEntry.description (for example, "expect 15-20% tips based on customer bill.") and an estimate of the tips provided in CompensationEntry.amount or CompensationEntry.range ($10 per hour). For example, equity is described in CompensationEntry.description (for example, "1% - 2% equity vesting over 4 years, 1 year cliff") and value estimated in CompensationEntry.amount or CompensationEntry.range. If no value estimate is possible, units are CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED and then further clarified in CompensationEntry.description field.

Protobuf enum google.cloud.talent.v4.CompensationInfo.CompensationType

CompensationInfo.CompensationUnit

Pay frequency.

Protobuf enum google.cloud.talent.v4.CompensationInfo.CompensationUnit

CompleteQueryRequest.CompletionScope

Enum to specify the scope of completion.

Protobuf enum google.cloud.talent.v4.CompleteQueryRequest.CompletionScope

CompleteQueryRequest.CompletionType

Enum to specify auto-completion topics.

Protobuf enum google.cloud.talent.v4.CompleteQueryRequest.CompletionType

DegreeType

Educational degree level defined in International Standard Classification of Education (ISCED).

Protobuf enum google.cloud.talent.v4.DegreeType

DeviceInfo.DeviceType

An enumeration describing an API access portal and exposure mechanism.

Protobuf enum google.cloud.talent.v4.DeviceInfo.DeviceType

EmploymentType

An enum that represents the employment type of a job.

Protobuf enum google.cloud.talent.v4.EmploymentType

HtmlSanitization

Option for HTML content sanitization on user input fields, for example, job description. By setting this option, user can determine whether and how sanitization is performed on these fields.

Protobuf enum google.cloud.talent.v4.HtmlSanitization

JobBenefit

An enum that represents employee benefits included with the job.

Protobuf enum google.cloud.talent.v4.JobBenefit

JobCategory

An enum that represents the categorization or primary focus of specific role. This value is different than the "industry" associated with a role, which is related to the categorization of the company listing the job.

Protobuf enum google.cloud.talent.v4.JobCategory

JobEvent.JobEventType

An enumeration of an event attributed to the behavior of the end user, such as a job seeker.

Protobuf enum google.cloud.talent.v4.JobEvent.JobEventType

JobLevel

An enum that represents the required experience level required for the job.

Protobuf enum google.cloud.talent.v4.JobLevel

JobView

An enum that specifies the job attributes that are returned in the MatchingJob.job or ListJobsResponse.jobs fields.

Protobuf enum google.cloud.talent.v4.JobView

Location.LocationType

An enum which represents the type of a location.

Protobuf enum google.cloud.talent.v4.Location.LocationType

LocationFilter.TelecommutePreference

Specify whether to include telecommute jobs.

Protobuf enum google.cloud.talent.v4.LocationFilter.TelecommutePreference

PostingRegion

An enum that represents the job posting region. In most cases, job postings don't need to specify a region. If a region is given, jobs are eligible for searches in the specified region.

Protobuf enum google.cloud.talent.v4.PostingRegion

SearchJobsRequest.CustomRankingInfo.ImportanceLevel

The importance level for CustomRankingInfo.ranking_expression.

Protobuf enum google.cloud.talent.v4.SearchJobsRequest.CustomRankingInfo.ImportanceLevel

SearchJobsRequest.DiversificationLevel

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. If you are using pageToken to page through the result set, latency might be lower but we can't guarantee that all results are returned. If you are using page offset, latency might be higher but all results are returned.

Protobuf enum google.cloud.talent.v4.SearchJobsRequest.DiversificationLevel

SearchJobsRequest.KeywordMatchMode

Controls what keyword matching behavior the search has. When keyword matching is enabled, a keyword match returns jobs that may not match given category filters when there are matching keywords. For example, for the query "program manager" with KeywordMatchMode set to KEYWORD_MATCH_ALL, a job posting with the title "software developer," which doesn't fall into "program manager" ontology, and "program manager" appearing in its description will be surfaced. For queries like "cloud" that don't contain title or location specific ontology, jobs with "cloud" keyword matches are returned regardless of this enum'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.

Protobuf enum google.cloud.talent.v4.SearchJobsRequest.KeywordMatchMode

SearchJobsRequest.SearchMode

A string-represented enumeration of the job search mode. The service operate differently for different modes of service.

Protobuf enum google.cloud.talent.v4.SearchJobsRequest.SearchMode

Visibility

Deprecated. All resources are only visible to the owner. An enum that represents who has view access to the resource.

Protobuf enum google.cloud.talent.v4.Visibility