Google Cloud Talent Solution v4 API - Class JobQuery (2.4.0)

public sealed class JobQuery : IMessage<JobQuery>, IEquatable<JobQuery>, IDeepCloneable<JobQuery>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Talent Solution v4 API class JobQuery.

The query required to perform a search query.

Inheritance

object > JobQuery

Namespace

Google.Cloud.Talent.V4

Assembly

Google.Cloud.Talent.V4.dll

Constructors

JobQuery()

public JobQuery()

JobQuery(JobQuery)

public JobQuery(JobQuery other)
Parameter
NameDescription
otherJobQuery

Properties

CommuteFilter

public CommuteFilter CommuteFilter { get; set; }

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][google.cloud.talent.v4.CommuteMethod]. In this case, [location_filters][google.cloud.talent.v4.JobQuery.location_filters] is ignored.

Currently we don't support sorting by commute time.

Property Value
TypeDescription
CommuteFilter

Companies

public RepeatedField<string> Companies { get; }

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".

At most 20 company filters are allowed.

Property Value
TypeDescription
RepeatedFieldstring

CompanyDisplayNames

public RepeatedField<string> CompanyDisplayNames { get; }

This filter specifies the company [Company.display_name][google.cloud.talent.v4.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.

Property Value
TypeDescription
RepeatedFieldstring

CompensationFilter

public CompensationFilter CompensationFilter { get; set; }

This search filter is applied only to [Job.compensation_info][google.cloud.talent.v4.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.

Property Value
TypeDescription
CompensationFilter

CustomAttributeFilter

public string CustomAttributeFilter { get; set; }

This filter specifies a structured syntax to match against the [Job.custom_attributes][google.cloud.talent.v4.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

Property Value
TypeDescription
string

DisableSpellCheck

public bool DisableSpellCheck { get; set; }

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.

Property Value
TypeDescription
bool

EmploymentTypes

public RepeatedField<EmploymentType> EmploymentTypes { get; }

The employment type filter specifies the employment type of jobs to search against, such as [EmploymentType.FULL_TIME][google.cloud.talent.v4.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.

Property Value
TypeDescription
RepeatedFieldEmploymentType

ExcludedJobs

public RepeatedField<string> ExcludedJobs { get; }

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

At most 400 excluded job names are allowed.

Property Value
TypeDescription
RepeatedFieldstring

JobCategories

public RepeatedField<JobCategory> JobCategories { get; }

The category filter specifies the categories of jobs to search against. See [JobCategory][google.cloud.talent.v4.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.

Property Value
TypeDescription
RepeatedFieldJobCategory

LanguageCodes

public RepeatedField<string> LanguageCodes { get; }

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.

Property Value
TypeDescription
RepeatedFieldstring

LocationFilters

public RepeatedField<LocationFilter> LocationFilters { get; }

The location filter specifies geo-regions containing the jobs to search against. See [LocationFilter][google.cloud.talent.v4.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][google.cloud.talent.v4.LocationFilter.distance_in_miles] parameter, the maximum provided distance is used for all locations.

At most 5 location filters are allowed.

Property Value
TypeDescription
RepeatedFieldLocationFilter

PublishTimeRange

public TimestampRange PublishTimeRange { get; set; }

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

Property Value
TypeDescription
TimestampRange

Query

public string Query { get; set; }

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

The maximum number of allowed characters is 255.

Property Value
TypeDescription
string

QueryLanguageCode

public string QueryLanguageCode { get; set; }

The language code of [query][google.cloud.talent.v4.JobQuery.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.

Property Value
TypeDescription
string