Class JobQuery.Builder (2.46.0)

public static final class JobQuery.Builder extends GeneratedMessageV3.Builder<JobQuery.Builder> implements JobQueryOrBuilder

The query required to perform a search query.

Protobuf type google.cloud.talent.v4beta1.JobQuery

Implements

JobQueryOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllCompanies(Iterable<String> values)

public JobQuery.Builder addAllCompanies(Iterable<String> values)

This filter specifies the company entities to search against.

If a value isn't specified, jobs are searched for against all companies.

If multiple values are specified, jobs are searched against the companies specified.

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

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

At most 20 company filters are allowed.

repeated string companies = 2;

Parameter
Name Description
values Iterable<String>

The companies to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addAllCompanyDisplayNames(Iterable<String> values)

public JobQuery.Builder addAllCompanyDisplayNames(Iterable<String> values)

This filter specifies the company Company.display_name of the jobs to search against. The company name must match the value exactly.

Alternatively, the value being searched for can be wrapped in different match operators. SUBSTRING_MATCH([value]) The company name must contain a case insensitive substring match of the value. Using this function may increase latency.

Sample Value: SUBSTRING_MATCH(google)

MULTI_WORD_TOKEN_MATCH([value]) The value will be treated as a multi word token and the company name must contain a case insensitive match of the value. Using this function may increase latency.

Sample Value: MULTI_WORD_TOKEN_MATCH(google)

If a value isn't specified, jobs within the search results are associated with any company.

If multiple values are specified, jobs within the search results may be associated with any of the specified companies.

At most 20 company display name filters are allowed.

repeated string company_display_names = 6;

Parameter
Name Description
values Iterable<String>

The companyDisplayNames to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addAllEmploymentTypes(Iterable<? extends EmploymentType> values)

public JobQuery.Builder addAllEmploymentTypes(Iterable<? extends EmploymentType> values)

The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME.

If a value isn't specified, jobs in the search results includes any employment type.

If multiple values are specified, jobs in the search results include any of the specified employment types.

repeated .google.cloud.talent.v4beta1.EmploymentType employment_types = 10;

Parameter
Name Description
values Iterable<? extends com.google.cloud.talent.v4beta1.EmploymentType>

The employmentTypes to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addAllEmploymentTypesValue(Iterable<Integer> values)

public JobQuery.Builder addAllEmploymentTypesValue(Iterable<Integer> values)

The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME.

If a value isn't specified, jobs in the search results includes any employment type.

If multiple values are specified, jobs in the search results include any of the specified employment types.

repeated .google.cloud.talent.v4beta1.EmploymentType employment_types = 10;

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for employmentTypes to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addAllExcludedJobs(Iterable<String> values)

public JobQuery.Builder addAllExcludedJobs(Iterable<String> values)

This filter specifies a list of job names to be excluded during search.

At most 400 excluded job names are allowed.

repeated string excluded_jobs = 13;

Parameter
Name Description
values Iterable<String>

The excludedJobs to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addAllJobCategories(Iterable<? extends JobCategory> values)

public JobQuery.Builder addAllJobCategories(Iterable<? extends JobCategory> values)

The category filter specifies the categories of jobs to search against. See JobCategory for more information.

If a value isn't specified, jobs from any category are searched against.

If multiple values are specified, jobs from any of the specified categories are searched against.

repeated .google.cloud.talent.v4beta1.JobCategory job_categories = 4;

Parameter
Name Description
values Iterable<? extends com.google.cloud.talent.v4beta1.JobCategory>

The jobCategories to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addAllJobCategoriesValue(Iterable<Integer> values)

public JobQuery.Builder addAllJobCategoriesValue(Iterable<Integer> values)

The category filter specifies the categories of jobs to search against. See JobCategory for more information.

If a value isn't specified, jobs from any category are searched against.

If multiple values are specified, jobs from any of the specified categories are searched against.

repeated .google.cloud.talent.v4beta1.JobCategory job_categories = 4;

Parameter
Name Description
values Iterable<Integer>

The enum numeric values on the wire for jobCategories to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addAllLanguageCodes(Iterable<String> values)

public JobQuery.Builder addAllLanguageCodes(Iterable<String> values)

This filter specifies the locale of jobs to search against, for example, "en-US".

If a value isn't specified, the search results can contain jobs in any locale.

Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

At most 10 language code filters are allowed.

repeated string language_codes = 11;

Parameter
Name Description
values Iterable<String>

The languageCodes to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addAllLocationFilters(Iterable<? extends LocationFilter> values)

public JobQuery.Builder addAllLocationFilters(Iterable<? extends LocationFilter> values)

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Parameter
Name Description
values Iterable<? extends com.google.cloud.talent.v4beta1.LocationFilter>
Returns
Type Description
JobQuery.Builder

addCompanies(String value)

public JobQuery.Builder addCompanies(String value)

This filter specifies the company entities to search against.

If a value isn't specified, jobs are searched for against all companies.

If multiple values are specified, jobs are searched against the companies specified.

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

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

At most 20 company filters are allowed.

repeated string companies = 2;

Parameter
Name Description
value String

The companies to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addCompaniesBytes(ByteString value)

public JobQuery.Builder addCompaniesBytes(ByteString value)

This filter specifies the company entities to search against.

If a value isn't specified, jobs are searched for against all companies.

If multiple values are specified, jobs are searched against the companies specified.

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

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

At most 20 company filters are allowed.

repeated string companies = 2;

Parameter
Name Description
value ByteString

The bytes of the companies to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addCompanyDisplayNames(String value)

public JobQuery.Builder addCompanyDisplayNames(String value)

This filter specifies the company Company.display_name of the jobs to search against. The company name must match the value exactly.

Alternatively, the value being searched for can be wrapped in different match operators. SUBSTRING_MATCH([value]) The company name must contain a case insensitive substring match of the value. Using this function may increase latency.

Sample Value: SUBSTRING_MATCH(google)

MULTI_WORD_TOKEN_MATCH([value]) The value will be treated as a multi word token and the company name must contain a case insensitive match of the value. Using this function may increase latency.

Sample Value: MULTI_WORD_TOKEN_MATCH(google)

If a value isn't specified, jobs within the search results are associated with any company.

If multiple values are specified, jobs within the search results may be associated with any of the specified companies.

At most 20 company display name filters are allowed.

repeated string company_display_names = 6;

Parameter
Name Description
value String

The companyDisplayNames to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addCompanyDisplayNamesBytes(ByteString value)

public JobQuery.Builder addCompanyDisplayNamesBytes(ByteString value)

This filter specifies the company Company.display_name of the jobs to search against. The company name must match the value exactly.

Alternatively, the value being searched for can be wrapped in different match operators. SUBSTRING_MATCH([value]) The company name must contain a case insensitive substring match of the value. Using this function may increase latency.

Sample Value: SUBSTRING_MATCH(google)

MULTI_WORD_TOKEN_MATCH([value]) The value will be treated as a multi word token and the company name must contain a case insensitive match of the value. Using this function may increase latency.

Sample Value: MULTI_WORD_TOKEN_MATCH(google)

If a value isn't specified, jobs within the search results are associated with any company.

If multiple values are specified, jobs within the search results may be associated with any of the specified companies.

At most 20 company display name filters are allowed.

repeated string company_display_names = 6;

Parameter
Name Description
value ByteString

The bytes of the companyDisplayNames to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addEmploymentTypes(EmploymentType value)

public JobQuery.Builder addEmploymentTypes(EmploymentType value)

The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME.

If a value isn't specified, jobs in the search results includes any employment type.

If multiple values are specified, jobs in the search results include any of the specified employment types.

repeated .google.cloud.talent.v4beta1.EmploymentType employment_types = 10;

Parameter
Name Description
value EmploymentType

The employmentTypes to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addEmploymentTypesValue(int value)

public JobQuery.Builder addEmploymentTypesValue(int value)

The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME.

If a value isn't specified, jobs in the search results includes any employment type.

If multiple values are specified, jobs in the search results include any of the specified employment types.

repeated .google.cloud.talent.v4beta1.EmploymentType employment_types = 10;

Parameter
Name Description
value int

The enum numeric value on the wire for employmentTypes to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addExcludedJobs(String value)

public JobQuery.Builder addExcludedJobs(String value)

This filter specifies a list of job names to be excluded during search.

At most 400 excluded job names are allowed.

repeated string excluded_jobs = 13;

Parameter
Name Description
value String

The excludedJobs to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addExcludedJobsBytes(ByteString value)

public JobQuery.Builder addExcludedJobsBytes(ByteString value)

This filter specifies a list of job names to be excluded during search.

At most 400 excluded job names are allowed.

repeated string excluded_jobs = 13;

Parameter
Name Description
value ByteString

The bytes of the excludedJobs to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addJobCategories(JobCategory value)

public JobQuery.Builder addJobCategories(JobCategory value)

The category filter specifies the categories of jobs to search against. See JobCategory for more information.

If a value isn't specified, jobs from any category are searched against.

If multiple values are specified, jobs from any of the specified categories are searched against.

repeated .google.cloud.talent.v4beta1.JobCategory job_categories = 4;

Parameter
Name Description
value JobCategory

The jobCategories to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addJobCategoriesValue(int value)

public JobQuery.Builder addJobCategoriesValue(int value)

The category filter specifies the categories of jobs to search against. See JobCategory for more information.

If a value isn't specified, jobs from any category are searched against.

If multiple values are specified, jobs from any of the specified categories are searched against.

repeated .google.cloud.talent.v4beta1.JobCategory job_categories = 4;

Parameter
Name Description
value int

The enum numeric value on the wire for jobCategories to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addLanguageCodes(String value)

public JobQuery.Builder addLanguageCodes(String value)

This filter specifies the locale of jobs to search against, for example, "en-US".

If a value isn't specified, the search results can contain jobs in any locale.

Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

At most 10 language code filters are allowed.

repeated string language_codes = 11;

Parameter
Name Description
value String

The languageCodes to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addLanguageCodesBytes(ByteString value)

public JobQuery.Builder addLanguageCodesBytes(ByteString value)

This filter specifies the locale of jobs to search against, for example, "en-US".

If a value isn't specified, the search results can contain jobs in any locale.

Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

At most 10 language code filters are allowed.

repeated string language_codes = 11;

Parameter
Name Description
value ByteString

The bytes of the languageCodes to add.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

addLocationFilters(LocationFilter value)

public JobQuery.Builder addLocationFilters(LocationFilter value)

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Parameter
Name Description
value LocationFilter
Returns
Type Description
JobQuery.Builder

addLocationFilters(LocationFilter.Builder builderForValue)

public JobQuery.Builder addLocationFilters(LocationFilter.Builder builderForValue)

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Parameter
Name Description
builderForValue LocationFilter.Builder
Returns
Type Description
JobQuery.Builder

addLocationFilters(int index, LocationFilter value)

public JobQuery.Builder addLocationFilters(int index, LocationFilter value)

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Parameters
Name Description
index int
value LocationFilter
Returns
Type Description
JobQuery.Builder

addLocationFilters(int index, LocationFilter.Builder builderForValue)

public JobQuery.Builder addLocationFilters(int index, LocationFilter.Builder builderForValue)

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Parameters
Name Description
index int
builderForValue LocationFilter.Builder
Returns
Type Description
JobQuery.Builder

addLocationFiltersBuilder()

public LocationFilter.Builder addLocationFiltersBuilder()

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Returns
Type Description
LocationFilter.Builder

addLocationFiltersBuilder(int index)

public LocationFilter.Builder addLocationFiltersBuilder(int index)

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Parameter
Name Description
index int
Returns
Type Description
LocationFilter.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public JobQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
JobQuery.Builder
Overrides

build()

public JobQuery build()
Returns
Type Description
JobQuery

buildPartial()

public JobQuery buildPartial()
Returns
Type Description
JobQuery

clear()

public JobQuery.Builder clear()
Returns
Type Description
JobQuery.Builder
Overrides

clearCommuteFilter()

public JobQuery.Builder clearCommuteFilter()

Allows filtering jobs by commute time with different travel methods (for example, driving or public transit).

Note: This only works when you specify a CommuteMethod. In this case, location_filters is ignored.

Currently we don't support sorting by commute time.

.google.cloud.talent.v4beta1.CommuteFilter commute_filter = 5;

Returns
Type Description
JobQuery.Builder

clearCompanies()

public JobQuery.Builder clearCompanies()

This filter specifies the company entities to search against.

If a value isn't specified, jobs are searched for against all companies.

If multiple values are specified, jobs are searched against the companies specified.

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

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

At most 20 company filters are allowed.

repeated string companies = 2;

Returns
Type Description
JobQuery.Builder

This builder for chaining.

clearCompanyDisplayNames()

public JobQuery.Builder clearCompanyDisplayNames()

This filter specifies the company Company.display_name of the jobs to search against. The company name must match the value exactly.

Alternatively, the value being searched for can be wrapped in different match operators. SUBSTRING_MATCH([value]) The company name must contain a case insensitive substring match of the value. Using this function may increase latency.

Sample Value: SUBSTRING_MATCH(google)

MULTI_WORD_TOKEN_MATCH([value]) The value will be treated as a multi word token and the company name must contain a case insensitive match of the value. Using this function may increase latency.

Sample Value: MULTI_WORD_TOKEN_MATCH(google)

If a value isn't specified, jobs within the search results are associated with any company.

If multiple values are specified, jobs within the search results may be associated with any of the specified companies.

At most 20 company display name filters are allowed.

repeated string company_display_names = 6;

Returns
Type Description
JobQuery.Builder

This builder for chaining.

clearCompensationFilter()

public JobQuery.Builder clearCompensationFilter()

This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched.

.google.cloud.talent.v4beta1.CompensationFilter compensation_filter = 7;

Returns
Type Description
JobQuery.Builder

clearCustomAttributeFilter()

public JobQuery.Builder clearCustomAttributeFilter()

This filter specifies a structured syntax to match against the Job.custom_attributes marked as filterable.

The syntax for this expression is a subset of SQL syntax.

Supported operators are: =, !=, <, <=, >, and >= where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters.

Supported functions are LOWER([field_name]) to perform a case insensitive match and EMPTY([field_name]) to filter on the existence of a key.

Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 10000 bytes in length.

Sample Query: (LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10

string custom_attribute_filter = 8;

Returns
Type Description
JobQuery.Builder

This builder for chaining.

clearDisableSpellCheck()

public JobQuery.Builder clearDisableSpellCheck()

This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer".

Defaults to false: a spell check is performed.

bool disable_spell_check = 9;

Returns
Type Description
JobQuery.Builder

This builder for chaining.

clearEmploymentTypes()

public JobQuery.Builder clearEmploymentTypes()

The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME.

If a value isn't specified, jobs in the search results includes any employment type.

If multiple values are specified, jobs in the search results include any of the specified employment types.

repeated .google.cloud.talent.v4beta1.EmploymentType employment_types = 10;

Returns
Type Description
JobQuery.Builder

This builder for chaining.

clearExcludedJobs()

public JobQuery.Builder clearExcludedJobs()

This filter specifies a list of job names to be excluded during search.

At most 400 excluded job names are allowed.

repeated string excluded_jobs = 13;

Returns
Type Description
JobQuery.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public JobQuery.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
JobQuery.Builder
Overrides

clearJobCategories()

public JobQuery.Builder clearJobCategories()

The category filter specifies the categories of jobs to search against. See JobCategory for more information.

If a value isn't specified, jobs from any category are searched against.

If multiple values are specified, jobs from any of the specified categories are searched against.

repeated .google.cloud.talent.v4beta1.JobCategory job_categories = 4;

Returns
Type Description
JobQuery.Builder

This builder for chaining.

clearLanguageCodes()

public JobQuery.Builder clearLanguageCodes()

This filter specifies the locale of jobs to search against, for example, "en-US".

If a value isn't specified, the search results can contain jobs in any locale.

Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

At most 10 language code filters are allowed.

repeated string language_codes = 11;

Returns
Type Description
JobQuery.Builder

This builder for chaining.

clearLocationFilters()

public JobQuery.Builder clearLocationFilters()

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Returns
Type Description
JobQuery.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public JobQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
JobQuery.Builder
Overrides

clearPublishTimeRange()

public JobQuery.Builder clearPublishTimeRange()

Jobs published within a range specified by this filter are searched against.

.google.cloud.talent.v4beta1.TimestampRange publish_time_range = 12;

Returns
Type Description
JobQuery.Builder

clearQuery()

public JobQuery.Builder clearQuery()

The query string that matches against the job title, description, and location fields.

The maximum number of allowed characters is 255.

string query = 1;

Returns
Type Description
JobQuery.Builder

This builder for chaining.

clearQueryLanguageCode()

public JobQuery.Builder clearQueryLanguageCode()

The language code of query. For example, "en-US". This field helps to better interpret the query.

If a value isn't specified, the query language code is automatically detected, which may not be accurate.

Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

string query_language_code = 14;

Returns
Type Description
JobQuery.Builder

This builder for chaining.

clone()

public JobQuery.Builder clone()
Returns
Type Description
JobQuery.Builder
Overrides

getCommuteFilter()

public CommuteFilter getCommuteFilter()

Allows filtering jobs by commute time with different travel methods (for example, driving or public transit).

Note: This only works when you specify a CommuteMethod. In this case, location_filters is ignored.

Currently we don't support sorting by commute time.

.google.cloud.talent.v4beta1.CommuteFilter commute_filter = 5;

Returns
Type Description
CommuteFilter

The commuteFilter.

getCommuteFilterBuilder()

public CommuteFilter.Builder getCommuteFilterBuilder()

Allows filtering jobs by commute time with different travel methods (for example, driving or public transit).

Note: This only works when you specify a CommuteMethod. In this case, location_filters is ignored.

Currently we don't support sorting by commute time.

.google.cloud.talent.v4beta1.CommuteFilter commute_filter = 5;

Returns
Type Description
CommuteFilter.Builder

getCommuteFilterOrBuilder()

public CommuteFilterOrBuilder getCommuteFilterOrBuilder()

Allows filtering jobs by commute time with different travel methods (for example, driving or public transit).

Note: This only works when you specify a CommuteMethod. In this case, location_filters is ignored.

Currently we don't support sorting by commute time.

.google.cloud.talent.v4beta1.CommuteFilter commute_filter = 5;

Returns
Type Description
CommuteFilterOrBuilder

getCompanies(int index)

public String getCompanies(int index)

This filter specifies the company entities to search against.

If a value isn't specified, jobs are searched for against all companies.

If multiple values are specified, jobs are searched against the companies specified.

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

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

At most 20 company filters are allowed.

repeated string companies = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The companies at the given index.

getCompaniesBytes(int index)

public ByteString getCompaniesBytes(int index)

This filter specifies the company entities to search against.

If a value isn't specified, jobs are searched for against all companies.

If multiple values are specified, jobs are searched against the companies specified.

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

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

At most 20 company filters are allowed.

repeated string companies = 2;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the companies at the given index.

getCompaniesCount()

public int getCompaniesCount()

This filter specifies the company entities to search against.

If a value isn't specified, jobs are searched for against all companies.

If multiple values are specified, jobs are searched against the companies specified.

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

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

At most 20 company filters are allowed.

repeated string companies = 2;

Returns
Type Description
int

The count of companies.

getCompaniesList()

public ProtocolStringList getCompaniesList()

This filter specifies the company entities to search against.

If a value isn't specified, jobs are searched for against all companies.

If multiple values are specified, jobs are searched against the companies specified.

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

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

At most 20 company filters are allowed.

repeated string companies = 2;

Returns
Type Description
ProtocolStringList

A list containing the companies.

getCompanyDisplayNames(int index)

public String getCompanyDisplayNames(int index)

This filter specifies the company Company.display_name of the jobs to search against. The company name must match the value exactly.

Alternatively, the value being searched for can be wrapped in different match operators. SUBSTRING_MATCH([value]) The company name must contain a case insensitive substring match of the value. Using this function may increase latency.

Sample Value: SUBSTRING_MATCH(google)

MULTI_WORD_TOKEN_MATCH([value]) The value will be treated as a multi word token and the company name must contain a case insensitive match of the value. Using this function may increase latency.

Sample Value: MULTI_WORD_TOKEN_MATCH(google)

If a value isn't specified, jobs within the search results are associated with any company.

If multiple values are specified, jobs within the search results may be associated with any of the specified companies.

At most 20 company display name filters are allowed.

repeated string company_display_names = 6;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The companyDisplayNames at the given index.

getCompanyDisplayNamesBytes(int index)

public ByteString getCompanyDisplayNamesBytes(int index)

This filter specifies the company Company.display_name of the jobs to search against. The company name must match the value exactly.

Alternatively, the value being searched for can be wrapped in different match operators. SUBSTRING_MATCH([value]) The company name must contain a case insensitive substring match of the value. Using this function may increase latency.

Sample Value: SUBSTRING_MATCH(google)

MULTI_WORD_TOKEN_MATCH([value]) The value will be treated as a multi word token and the company name must contain a case insensitive match of the value. Using this function may increase latency.

Sample Value: MULTI_WORD_TOKEN_MATCH(google)

If a value isn't specified, jobs within the search results are associated with any company.

If multiple values are specified, jobs within the search results may be associated with any of the specified companies.

At most 20 company display name filters are allowed.

repeated string company_display_names = 6;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the companyDisplayNames at the given index.

getCompanyDisplayNamesCount()

public int getCompanyDisplayNamesCount()

This filter specifies the company Company.display_name of the jobs to search against. The company name must match the value exactly.

Alternatively, the value being searched for can be wrapped in different match operators. SUBSTRING_MATCH([value]) The company name must contain a case insensitive substring match of the value. Using this function may increase latency.

Sample Value: SUBSTRING_MATCH(google)

MULTI_WORD_TOKEN_MATCH([value]) The value will be treated as a multi word token and the company name must contain a case insensitive match of the value. Using this function may increase latency.

Sample Value: MULTI_WORD_TOKEN_MATCH(google)

If a value isn't specified, jobs within the search results are associated with any company.

If multiple values are specified, jobs within the search results may be associated with any of the specified companies.

At most 20 company display name filters are allowed.

repeated string company_display_names = 6;

Returns
Type Description
int

The count of companyDisplayNames.

getCompanyDisplayNamesList()

public ProtocolStringList getCompanyDisplayNamesList()

This filter specifies the company Company.display_name of the jobs to search against. The company name must match the value exactly.

Alternatively, the value being searched for can be wrapped in different match operators. SUBSTRING_MATCH([value]) The company name must contain a case insensitive substring match of the value. Using this function may increase latency.

Sample Value: SUBSTRING_MATCH(google)

MULTI_WORD_TOKEN_MATCH([value]) The value will be treated as a multi word token and the company name must contain a case insensitive match of the value. Using this function may increase latency.

Sample Value: MULTI_WORD_TOKEN_MATCH(google)

If a value isn't specified, jobs within the search results are associated with any company.

If multiple values are specified, jobs within the search results may be associated with any of the specified companies.

At most 20 company display name filters are allowed.

repeated string company_display_names = 6;

Returns
Type Description
ProtocolStringList

A list containing the companyDisplayNames.

getCompensationFilter()

public CompensationFilter getCompensationFilter()

This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched.

.google.cloud.talent.v4beta1.CompensationFilter compensation_filter = 7;

Returns
Type Description
CompensationFilter

The compensationFilter.

getCompensationFilterBuilder()

public CompensationFilter.Builder getCompensationFilterBuilder()

This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched.

.google.cloud.talent.v4beta1.CompensationFilter compensation_filter = 7;

Returns
Type Description
CompensationFilter.Builder

getCompensationFilterOrBuilder()

public CompensationFilterOrBuilder getCompensationFilterOrBuilder()

This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched.

.google.cloud.talent.v4beta1.CompensationFilter compensation_filter = 7;

Returns
Type Description
CompensationFilterOrBuilder

getCustomAttributeFilter()

public String getCustomAttributeFilter()

This filter specifies a structured syntax to match against the Job.custom_attributes marked as filterable.

The syntax for this expression is a subset of SQL syntax.

Supported operators are: =, !=, <, <=, >, and >= where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters.

Supported functions are LOWER([field_name]) to perform a case insensitive match and EMPTY([field_name]) to filter on the existence of a key.

Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 10000 bytes in length.

Sample Query: (LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10

string custom_attribute_filter = 8;

Returns
Type Description
String

The customAttributeFilter.

getCustomAttributeFilterBytes()

public ByteString getCustomAttributeFilterBytes()

This filter specifies a structured syntax to match against the Job.custom_attributes marked as filterable.

The syntax for this expression is a subset of SQL syntax.

Supported operators are: =, !=, <, <=, >, and >= where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters.

Supported functions are LOWER([field_name]) to perform a case insensitive match and EMPTY([field_name]) to filter on the existence of a key.

Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 10000 bytes in length.

Sample Query: (LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10

string custom_attribute_filter = 8;

Returns
Type Description
ByteString

The bytes for customAttributeFilter.

getDefaultInstanceForType()

public JobQuery getDefaultInstanceForType()
Returns
Type Description
JobQuery

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisableSpellCheck()

public boolean getDisableSpellCheck()

This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer".

Defaults to false: a spell check is performed.

bool disable_spell_check = 9;

Returns
Type Description
boolean

The disableSpellCheck.

getEmploymentTypes(int index)

public EmploymentType getEmploymentTypes(int index)

The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME.

If a value isn't specified, jobs in the search results includes any employment type.

If multiple values are specified, jobs in the search results include any of the specified employment types.

repeated .google.cloud.talent.v4beta1.EmploymentType employment_types = 10;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
EmploymentType

The employmentTypes at the given index.

getEmploymentTypesCount()

public int getEmploymentTypesCount()

The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME.

If a value isn't specified, jobs in the search results includes any employment type.

If multiple values are specified, jobs in the search results include any of the specified employment types.

repeated .google.cloud.talent.v4beta1.EmploymentType employment_types = 10;

Returns
Type Description
int

The count of employmentTypes.

getEmploymentTypesList()

public List<EmploymentType> getEmploymentTypesList()

The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME.

If a value isn't specified, jobs in the search results includes any employment type.

If multiple values are specified, jobs in the search results include any of the specified employment types.

repeated .google.cloud.talent.v4beta1.EmploymentType employment_types = 10;

Returns
Type Description
List<EmploymentType>

A list containing the employmentTypes.

getEmploymentTypesValue(int index)

public int getEmploymentTypesValue(int index)

The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME.

If a value isn't specified, jobs in the search results includes any employment type.

If multiple values are specified, jobs in the search results include any of the specified employment types.

repeated .google.cloud.talent.v4beta1.EmploymentType employment_types = 10;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of employmentTypes at the given index.

getEmploymentTypesValueList()

public List<Integer> getEmploymentTypesValueList()

The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME.

If a value isn't specified, jobs in the search results includes any employment type.

If multiple values are specified, jobs in the search results include any of the specified employment types.

repeated .google.cloud.talent.v4beta1.EmploymentType employment_types = 10;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for employmentTypes.

getExcludedJobs(int index)

public String getExcludedJobs(int index)

This filter specifies a list of job names to be excluded during search.

At most 400 excluded job names are allowed.

repeated string excluded_jobs = 13;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The excludedJobs at the given index.

getExcludedJobsBytes(int index)

public ByteString getExcludedJobsBytes(int index)

This filter specifies a list of job names to be excluded during search.

At most 400 excluded job names are allowed.

repeated string excluded_jobs = 13;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the excludedJobs at the given index.

getExcludedJobsCount()

public int getExcludedJobsCount()

This filter specifies a list of job names to be excluded during search.

At most 400 excluded job names are allowed.

repeated string excluded_jobs = 13;

Returns
Type Description
int

The count of excludedJobs.

getExcludedJobsList()

public ProtocolStringList getExcludedJobsList()

This filter specifies a list of job names to be excluded during search.

At most 400 excluded job names are allowed.

repeated string excluded_jobs = 13;

Returns
Type Description
ProtocolStringList

A list containing the excludedJobs.

getJobCategories(int index)

public JobCategory getJobCategories(int index)

The category filter specifies the categories of jobs to search against. See JobCategory for more information.

If a value isn't specified, jobs from any category are searched against.

If multiple values are specified, jobs from any of the specified categories are searched against.

repeated .google.cloud.talent.v4beta1.JobCategory job_categories = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
JobCategory

The jobCategories at the given index.

getJobCategoriesCount()

public int getJobCategoriesCount()

The category filter specifies the categories of jobs to search against. See JobCategory for more information.

If a value isn't specified, jobs from any category are searched against.

If multiple values are specified, jobs from any of the specified categories are searched against.

repeated .google.cloud.talent.v4beta1.JobCategory job_categories = 4;

Returns
Type Description
int

The count of jobCategories.

getJobCategoriesList()

public List<JobCategory> getJobCategoriesList()

The category filter specifies the categories of jobs to search against. See JobCategory for more information.

If a value isn't specified, jobs from any category are searched against.

If multiple values are specified, jobs from any of the specified categories are searched against.

repeated .google.cloud.talent.v4beta1.JobCategory job_categories = 4;

Returns
Type Description
List<JobCategory>

A list containing the jobCategories.

getJobCategoriesValue(int index)

public int getJobCategoriesValue(int index)

The category filter specifies the categories of jobs to search against. See JobCategory for more information.

If a value isn't specified, jobs from any category are searched against.

If multiple values are specified, jobs from any of the specified categories are searched against.

repeated .google.cloud.talent.v4beta1.JobCategory job_categories = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
int

The enum numeric value on the wire of jobCategories at the given index.

getJobCategoriesValueList()

public List<Integer> getJobCategoriesValueList()

The category filter specifies the categories of jobs to search against. See JobCategory for more information.

If a value isn't specified, jobs from any category are searched against.

If multiple values are specified, jobs from any of the specified categories are searched against.

repeated .google.cloud.talent.v4beta1.JobCategory job_categories = 4;

Returns
Type Description
List<Integer>

A list containing the enum numeric values on the wire for jobCategories.

getLanguageCodes(int index)

public String getLanguageCodes(int index)

This filter specifies the locale of jobs to search against, for example, "en-US".

If a value isn't specified, the search results can contain jobs in any locale.

Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

At most 10 language code filters are allowed.

repeated string language_codes = 11;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The languageCodes at the given index.

getLanguageCodesBytes(int index)

public ByteString getLanguageCodesBytes(int index)

This filter specifies the locale of jobs to search against, for example, "en-US".

If a value isn't specified, the search results can contain jobs in any locale.

Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

At most 10 language code filters are allowed.

repeated string language_codes = 11;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the languageCodes at the given index.

getLanguageCodesCount()

public int getLanguageCodesCount()

This filter specifies the locale of jobs to search against, for example, "en-US".

If a value isn't specified, the search results can contain jobs in any locale.

Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

At most 10 language code filters are allowed.

repeated string language_codes = 11;

Returns
Type Description
int

The count of languageCodes.

getLanguageCodesList()

public ProtocolStringList getLanguageCodesList()

This filter specifies the locale of jobs to search against, for example, "en-US".

If a value isn't specified, the search results can contain jobs in any locale.

Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

At most 10 language code filters are allowed.

repeated string language_codes = 11;

Returns
Type Description
ProtocolStringList

A list containing the languageCodes.

getLocationFilters(int index)

public LocationFilter getLocationFilters(int index)

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Parameter
Name Description
index int
Returns
Type Description
LocationFilter

getLocationFiltersBuilder(int index)

public LocationFilter.Builder getLocationFiltersBuilder(int index)

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Parameter
Name Description
index int
Returns
Type Description
LocationFilter.Builder

getLocationFiltersBuilderList()

public List<LocationFilter.Builder> getLocationFiltersBuilderList()

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Returns
Type Description
List<Builder>

getLocationFiltersCount()

public int getLocationFiltersCount()

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Returns
Type Description
int

getLocationFiltersList()

public List<LocationFilter> getLocationFiltersList()

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Returns
Type Description
List<LocationFilter>

getLocationFiltersOrBuilder(int index)

public LocationFilterOrBuilder getLocationFiltersOrBuilder(int index)

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Parameter
Name Description
index int
Returns
Type Description
LocationFilterOrBuilder

getLocationFiltersOrBuilderList()

public List<? extends LocationFilterOrBuilder> getLocationFiltersOrBuilderList()

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Returns
Type Description
List<? extends com.google.cloud.talent.v4beta1.LocationFilterOrBuilder>

getPublishTimeRange()

public TimestampRange getPublishTimeRange()

Jobs published within a range specified by this filter are searched against.

.google.cloud.talent.v4beta1.TimestampRange publish_time_range = 12;

Returns
Type Description
TimestampRange

The publishTimeRange.

getPublishTimeRangeBuilder()

public TimestampRange.Builder getPublishTimeRangeBuilder()

Jobs published within a range specified by this filter are searched against.

.google.cloud.talent.v4beta1.TimestampRange publish_time_range = 12;

Returns
Type Description
TimestampRange.Builder

getPublishTimeRangeOrBuilder()

public TimestampRangeOrBuilder getPublishTimeRangeOrBuilder()

Jobs published within a range specified by this filter are searched against.

.google.cloud.talent.v4beta1.TimestampRange publish_time_range = 12;

Returns
Type Description
TimestampRangeOrBuilder

getQuery()

public String getQuery()

The query string that matches against the job title, description, and location fields.

The maximum number of allowed characters is 255.

string query = 1;

Returns
Type Description
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

The query string that matches against the job title, description, and location fields.

The maximum number of allowed characters is 255.

string query = 1;

Returns
Type Description
ByteString

The bytes for query.

getQueryLanguageCode()

public String getQueryLanguageCode()

The language code of query. For example, "en-US". This field helps to better interpret the query.

If a value isn't specified, the query language code is automatically detected, which may not be accurate.

Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

string query_language_code = 14;

Returns
Type Description
String

The queryLanguageCode.

getQueryLanguageCodeBytes()

public ByteString getQueryLanguageCodeBytes()

The language code of query. For example, "en-US". This field helps to better interpret the query.

If a value isn't specified, the query language code is automatically detected, which may not be accurate.

Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

string query_language_code = 14;

Returns
Type Description
ByteString

The bytes for queryLanguageCode.

hasCommuteFilter()

public boolean hasCommuteFilter()

Allows filtering jobs by commute time with different travel methods (for example, driving or public transit).

Note: This only works when you specify a CommuteMethod. In this case, location_filters is ignored.

Currently we don't support sorting by commute time.

.google.cloud.talent.v4beta1.CommuteFilter commute_filter = 5;

Returns
Type Description
boolean

Whether the commuteFilter field is set.

hasCompensationFilter()

public boolean hasCompensationFilter()

This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched.

.google.cloud.talent.v4beta1.CompensationFilter compensation_filter = 7;

Returns
Type Description
boolean

Whether the compensationFilter field is set.

hasPublishTimeRange()

public boolean hasPublishTimeRange()

Jobs published within a range specified by this filter are searched against.

.google.cloud.talent.v4beta1.TimestampRange publish_time_range = 12;

Returns
Type Description
boolean

Whether the publishTimeRange field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCommuteFilter(CommuteFilter value)

public JobQuery.Builder mergeCommuteFilter(CommuteFilter value)

Allows filtering jobs by commute time with different travel methods (for example, driving or public transit).

Note: This only works when you specify a CommuteMethod. In this case, location_filters is ignored.

Currently we don't support sorting by commute time.

.google.cloud.talent.v4beta1.CommuteFilter commute_filter = 5;

Parameter
Name Description
value CommuteFilter
Returns
Type Description
JobQuery.Builder

mergeCompensationFilter(CompensationFilter value)

public JobQuery.Builder mergeCompensationFilter(CompensationFilter value)

This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched.

.google.cloud.talent.v4beta1.CompensationFilter compensation_filter = 7;

Parameter
Name Description
value CompensationFilter
Returns
Type Description
JobQuery.Builder

mergeFrom(JobQuery other)

public JobQuery.Builder mergeFrom(JobQuery other)
Parameter
Name Description
other JobQuery
Returns
Type Description
JobQuery.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public JobQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobQuery.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public JobQuery.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
JobQuery.Builder
Overrides

mergePublishTimeRange(TimestampRange value)

public JobQuery.Builder mergePublishTimeRange(TimestampRange value)

Jobs published within a range specified by this filter are searched against.

.google.cloud.talent.v4beta1.TimestampRange publish_time_range = 12;

Parameter
Name Description
value TimestampRange
Returns
Type Description
JobQuery.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final JobQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
JobQuery.Builder
Overrides

removeLocationFilters(int index)

public JobQuery.Builder removeLocationFilters(int index)

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Parameter
Name Description
index int
Returns
Type Description
JobQuery.Builder

setCommuteFilter(CommuteFilter value)

public JobQuery.Builder setCommuteFilter(CommuteFilter value)

Allows filtering jobs by commute time with different travel methods (for example, driving or public transit).

Note: This only works when you specify a CommuteMethod. In this case, location_filters is ignored.

Currently we don't support sorting by commute time.

.google.cloud.talent.v4beta1.CommuteFilter commute_filter = 5;

Parameter
Name Description
value CommuteFilter
Returns
Type Description
JobQuery.Builder

setCommuteFilter(CommuteFilter.Builder builderForValue)

public JobQuery.Builder setCommuteFilter(CommuteFilter.Builder builderForValue)

Allows filtering jobs by commute time with different travel methods (for example, driving or public transit).

Note: This only works when you specify a CommuteMethod. In this case, location_filters is ignored.

Currently we don't support sorting by commute time.

.google.cloud.talent.v4beta1.CommuteFilter commute_filter = 5;

Parameter
Name Description
builderForValue CommuteFilter.Builder
Returns
Type Description
JobQuery.Builder

setCompanies(int index, String value)

public JobQuery.Builder setCompanies(int index, String value)

This filter specifies the company entities to search against.

If a value isn't specified, jobs are searched for against all companies.

If multiple values are specified, jobs are searched against the companies specified.

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

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

At most 20 company filters are allowed.

repeated string companies = 2;

Parameters
Name Description
index int

The index to set the value at.

value String

The companies to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setCompanyDisplayNames(int index, String value)

public JobQuery.Builder setCompanyDisplayNames(int index, String value)

This filter specifies the company Company.display_name of the jobs to search against. The company name must match the value exactly.

Alternatively, the value being searched for can be wrapped in different match operators. SUBSTRING_MATCH([value]) The company name must contain a case insensitive substring match of the value. Using this function may increase latency.

Sample Value: SUBSTRING_MATCH(google)

MULTI_WORD_TOKEN_MATCH([value]) The value will be treated as a multi word token and the company name must contain a case insensitive match of the value. Using this function may increase latency.

Sample Value: MULTI_WORD_TOKEN_MATCH(google)

If a value isn't specified, jobs within the search results are associated with any company.

If multiple values are specified, jobs within the search results may be associated with any of the specified companies.

At most 20 company display name filters are allowed.

repeated string company_display_names = 6;

Parameters
Name Description
index int

The index to set the value at.

value String

The companyDisplayNames to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setCompensationFilter(CompensationFilter value)

public JobQuery.Builder setCompensationFilter(CompensationFilter value)

This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched.

.google.cloud.talent.v4beta1.CompensationFilter compensation_filter = 7;

Parameter
Name Description
value CompensationFilter
Returns
Type Description
JobQuery.Builder

setCompensationFilter(CompensationFilter.Builder builderForValue)

public JobQuery.Builder setCompensationFilter(CompensationFilter.Builder builderForValue)

This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched.

.google.cloud.talent.v4beta1.CompensationFilter compensation_filter = 7;

Parameter
Name Description
builderForValue CompensationFilter.Builder
Returns
Type Description
JobQuery.Builder

setCustomAttributeFilter(String value)

public JobQuery.Builder setCustomAttributeFilter(String value)

This filter specifies a structured syntax to match against the Job.custom_attributes marked as filterable.

The syntax for this expression is a subset of SQL syntax.

Supported operators are: =, !=, <, <=, >, and >= where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters.

Supported functions are LOWER([field_name]) to perform a case insensitive match and EMPTY([field_name]) to filter on the existence of a key.

Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 10000 bytes in length.

Sample Query: (LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10

string custom_attribute_filter = 8;

Parameter
Name Description
value String

The customAttributeFilter to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setCustomAttributeFilterBytes(ByteString value)

public JobQuery.Builder setCustomAttributeFilterBytes(ByteString value)

This filter specifies a structured syntax to match against the Job.custom_attributes marked as filterable.

The syntax for this expression is a subset of SQL syntax.

Supported operators are: =, !=, <, <=, >, and >= where the left of the operator is a custom field key and the right of the operator is a number or a quoted string. You must escape backslash (\\) and quote (\") characters.

Supported functions are LOWER([field_name]) to perform a case insensitive match and EMPTY([field_name]) to filter on the existence of a key.

Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 100 comparisons or functions are allowed in the expression. The expression must be < 10000 bytes in length.

Sample Query: (LOWER(driving_license)="class \"a\"" OR EMPTY(driving_license)) AND driving_years > 10

string custom_attribute_filter = 8;

Parameter
Name Description
value ByteString

The bytes for customAttributeFilter to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setDisableSpellCheck(boolean value)

public JobQuery.Builder setDisableSpellCheck(boolean value)

This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer".

Defaults to false: a spell check is performed.

bool disable_spell_check = 9;

Parameter
Name Description
value boolean

The disableSpellCheck to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setEmploymentTypes(int index, EmploymentType value)

public JobQuery.Builder setEmploymentTypes(int index, EmploymentType value)

The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME.

If a value isn't specified, jobs in the search results includes any employment type.

If multiple values are specified, jobs in the search results include any of the specified employment types.

repeated .google.cloud.talent.v4beta1.EmploymentType employment_types = 10;

Parameters
Name Description
index int

The index to set the value at.

value EmploymentType

The employmentTypes to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setEmploymentTypesValue(int index, int value)

public JobQuery.Builder setEmploymentTypesValue(int index, int value)

The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME.

If a value isn't specified, jobs in the search results includes any employment type.

If multiple values are specified, jobs in the search results include any of the specified employment types.

repeated .google.cloud.talent.v4beta1.EmploymentType employment_types = 10;

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for employmentTypes to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setExcludedJobs(int index, String value)

public JobQuery.Builder setExcludedJobs(int index, String value)

This filter specifies a list of job names to be excluded during search.

At most 400 excluded job names are allowed.

repeated string excluded_jobs = 13;

Parameters
Name Description
index int

The index to set the value at.

value String

The excludedJobs to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public JobQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
JobQuery.Builder
Overrides

setJobCategories(int index, JobCategory value)

public JobQuery.Builder setJobCategories(int index, JobCategory value)

The category filter specifies the categories of jobs to search against. See JobCategory for more information.

If a value isn't specified, jobs from any category are searched against.

If multiple values are specified, jobs from any of the specified categories are searched against.

repeated .google.cloud.talent.v4beta1.JobCategory job_categories = 4;

Parameters
Name Description
index int

The index to set the value at.

value JobCategory

The jobCategories to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setJobCategoriesValue(int index, int value)

public JobQuery.Builder setJobCategoriesValue(int index, int value)

The category filter specifies the categories of jobs to search against. See JobCategory for more information.

If a value isn't specified, jobs from any category are searched against.

If multiple values are specified, jobs from any of the specified categories are searched against.

repeated .google.cloud.talent.v4beta1.JobCategory job_categories = 4;

Parameters
Name Description
index int

The index to set the value at.

value int

The enum numeric value on the wire for jobCategories to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setLanguageCodes(int index, String value)

public JobQuery.Builder setLanguageCodes(int index, String value)

This filter specifies the locale of jobs to search against, for example, "en-US".

If a value isn't specified, the search results can contain jobs in any locale.

Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

At most 10 language code filters are allowed.

repeated string language_codes = 11;

Parameters
Name Description
index int

The index to set the value at.

value String

The languageCodes to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setLocationFilters(int index, LocationFilter value)

public JobQuery.Builder setLocationFilters(int index, LocationFilter value)

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Parameters
Name Description
index int
value LocationFilter
Returns
Type Description
JobQuery.Builder

setLocationFilters(int index, LocationFilter.Builder builderForValue)

public JobQuery.Builder setLocationFilters(int index, LocationFilter.Builder builderForValue)

The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information.

If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located.

If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

repeated .google.cloud.talent.v4beta1.LocationFilter location_filters = 3;

Parameters
Name Description
index int
builderForValue LocationFilter.Builder
Returns
Type Description
JobQuery.Builder

setPublishTimeRange(TimestampRange value)

public JobQuery.Builder setPublishTimeRange(TimestampRange value)

Jobs published within a range specified by this filter are searched against.

.google.cloud.talent.v4beta1.TimestampRange publish_time_range = 12;

Parameter
Name Description
value TimestampRange
Returns
Type Description
JobQuery.Builder

setPublishTimeRange(TimestampRange.Builder builderForValue)

public JobQuery.Builder setPublishTimeRange(TimestampRange.Builder builderForValue)

Jobs published within a range specified by this filter are searched against.

.google.cloud.talent.v4beta1.TimestampRange publish_time_range = 12;

Parameter
Name Description
builderForValue TimestampRange.Builder
Returns
Type Description
JobQuery.Builder

setQuery(String value)

public JobQuery.Builder setQuery(String value)

The query string that matches against the job title, description, and location fields.

The maximum number of allowed characters is 255.

string query = 1;

Parameter
Name Description
value String

The query to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setQueryBytes(ByteString value)

public JobQuery.Builder setQueryBytes(ByteString value)

The query string that matches against the job title, description, and location fields.

The maximum number of allowed characters is 255.

string query = 1;

Parameter
Name Description
value ByteString

The bytes for query to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setQueryLanguageCode(String value)

public JobQuery.Builder setQueryLanguageCode(String value)

The language code of query. For example, "en-US". This field helps to better interpret the query.

If a value isn't specified, the query language code is automatically detected, which may not be accurate.

Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

string query_language_code = 14;

Parameter
Name Description
value String

The queryLanguageCode to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setQueryLanguageCodeBytes(ByteString value)

public JobQuery.Builder setQueryLanguageCodeBytes(ByteString value)

The language code of query. For example, "en-US". This field helps to better interpret the query.

If a value isn't specified, the query language code is automatically detected, which may not be accurate.

Language code should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages.

string query_language_code = 14;

Parameter
Name Description
value ByteString

The bytes for queryLanguageCode to set.

Returns
Type Description
JobQuery.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public JobQuery.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
JobQuery.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final JobQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
JobQuery.Builder
Overrides