- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.6
- 2.2.9
public static final class SearchProfilesRequest.Builder extends GeneratedMessageV3.Builder<SearchProfilesRequest.Builder> implements SearchProfilesRequestOrBuilder
The request body of the SearchProfiles
call.
Protobuf type google.cloud.talent.v4beta1.SearchProfilesRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchProfilesRequest.BuilderImplements
SearchProfilesRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Type | Description |
Descriptor |
Methods
addAllHistogramQueries(Iterable<? extends HistogramQuery> values)
public SearchProfilesRequest.Builder addAllHistogramQueries(Iterable<? extends HistogramQuery> values)
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Name | Description |
values | Iterable<? extends com.google.cloud.talent.v4beta1.HistogramQuery> |
Type | Description |
SearchProfilesRequest.Builder |
addHistogramQueries(HistogramQuery value)
public SearchProfilesRequest.Builder addHistogramQueries(HistogramQuery value)
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Name | Description |
value | HistogramQuery |
Type | Description |
SearchProfilesRequest.Builder |
addHistogramQueries(HistogramQuery.Builder builderForValue)
public SearchProfilesRequest.Builder addHistogramQueries(HistogramQuery.Builder builderForValue)
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Name | Description |
builderForValue | HistogramQuery.Builder |
Type | Description |
SearchProfilesRequest.Builder |
addHistogramQueries(int index, HistogramQuery value)
public SearchProfilesRequest.Builder addHistogramQueries(int index, HistogramQuery value)
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Name | Description |
index | int |
value | HistogramQuery |
Type | Description |
SearchProfilesRequest.Builder |
addHistogramQueries(int index, HistogramQuery.Builder builderForValue)
public SearchProfilesRequest.Builder addHistogramQueries(int index, HistogramQuery.Builder builderForValue)
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Name | Description |
index | int |
builderForValue | HistogramQuery.Builder |
Type | Description |
SearchProfilesRequest.Builder |
addHistogramQueriesBuilder()
public HistogramQuery.Builder addHistogramQueriesBuilder()
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Type | Description |
HistogramQuery.Builder |
addHistogramQueriesBuilder(int index)
public HistogramQuery.Builder addHistogramQueriesBuilder(int index)
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Name | Description |
index | int |
Type | Description |
HistogramQuery.Builder |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public SearchProfilesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
SearchProfilesRequest.Builder |
build()
public SearchProfilesRequest build()
Type | Description |
SearchProfilesRequest |
buildPartial()
public SearchProfilesRequest buildPartial()
Type | Description |
SearchProfilesRequest |
clear()
public SearchProfilesRequest.Builder clear()
Type | Description |
SearchProfilesRequest.Builder |
clearCaseSensitiveSort()
public SearchProfilesRequest.Builder clearCaseSensitiveSort()
When sort by field is based on alphabetical order, sort values case sensitively (based on ASCII) when the value is set to true. Default value is case in-sensitive sort (false).
bool case_sensitive_sort = 9;
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
clearDisableSpellCheck()
public SearchProfilesRequest.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".
bool disable_spell_check = 7;
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public SearchProfilesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Name | Description |
field | FieldDescriptor |
Type | Description |
SearchProfilesRequest.Builder |
clearHistogramQueries()
public SearchProfilesRequest.Builder clearHistogramQueries()
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Type | Description |
SearchProfilesRequest.Builder |
clearOffset()
public SearchProfilesRequest.Builder clearOffset()
An integer that specifies the current offset (that is, starting result) in search results. This field is only considered if page_token is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to search from the first profile, and 10 means to search from the 11th profile. This can be used for pagination, for example pageSize = 10 and offset = 10 means to search from the second page.
int32 offset = 6;
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public SearchProfilesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Name | Description |
oneof | OneofDescriptor |
Type | Description |
SearchProfilesRequest.Builder |
clearOrderBy()
public SearchProfilesRequest.Builder clearOrderBy()
The criteria that determines how search results are sorted. Defaults is "relevance desc" if no value is specified. Supported options are:
- "relevance desc": By descending relevance, as determined by the API algorithms.
- "update_date desc": Sort by Profile.update_time in descending order (recently updated profiles first).
- "create_date desc": Sort by Profile.create_time in descending order (recently created profiles first).
- "first_name": Sort by PersonName.PersonStructuredName.given_name in ascending order.
- "first_name desc": Sort by PersonName.PersonStructuredName.given_name in descending order.
- "last_name": Sort by PersonName.PersonStructuredName.family_name in ascending order.
- "last_name desc": Sort by PersonName.PersonStructuredName.family_name in ascending order.
string order_by = 8;
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
clearPageSize()
public SearchProfilesRequest.Builder clearPageSize()
A limit on the number of profiles returned in the search results. A value above the default value 10 can increase search response time. The maximum value allowed is 100. Otherwise an error is thrown.
int32 page_size = 4;
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
clearPageToken()
public SearchProfilesRequest.Builder clearPageToken()
The pageToken, similar to offset enables users of the API to paginate through the search results. To retrieve the first page of results, set the pageToken to empty. The search response includes a nextPageToken field that can be used to populate the pageToken field for the next page of results. Using pageToken instead of offset increases the performance of the API, especially compared to larger offset values.
string page_token = 5;
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
clearParent()
public SearchProfilesRequest.Builder clearParent()
Required. The resource name of the tenant to search within. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
clearProfileQuery()
public SearchProfilesRequest.Builder clearProfileQuery()
Search query to execute. See ProfileQuery for more details.
.google.cloud.talent.v4beta1.ProfileQuery profile_query = 3;
Type | Description |
SearchProfilesRequest.Builder |
clearRequestMetadata()
public SearchProfilesRequest.Builder clearRequestMetadata()
Required. The meta information collected about the profile search user. This is used to improve the search quality of the service. These values are provided by users, and must be precise and consistent.
.google.cloud.talent.v4beta1.RequestMetadata request_metadata = 2 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
SearchProfilesRequest.Builder |
clearResultSetId()
public SearchProfilesRequest.Builder clearResultSetId()
An id that uniquely identifies the result set of a SearchProfiles call. The id should be retrieved from the SearchProfilesResponse message returned from a previous invocation of SearchProfiles. A result set is an ordered list of search results. If this field is not set, a new result set is computed based on the profile_query. A new result_set_id is returned as a handle to access this result set. If this field is set, the service will ignore the resource and profile_query values, and simply retrieve a page of results from the corresponding result set. In this case, one and only one of page_token or offset must be set. A typical use case is to invoke SearchProfilesRequest without this field, then use the resulting result_set_id in SearchProfilesResponse to page through the results.
string result_set_id = 12;
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
clearStrictKeywordsSearch()
public SearchProfilesRequest.Builder clearStrictKeywordsSearch()
This flag is used to indicate whether the service will attempt to understand synonyms and terms related to the search query or treat the query "as is" when it generates a set of results. By default this flag is set to false, thus allowing expanded results to also be returned. For example a search for "software engineer" might also return candidates who have experience in jobs similar to software engineer positions. By setting this flag to true, the service will only attempt to deliver candidates has software engineer in his/her global fields by treating "software engineer" as a keyword. It is recommended to provide a feature in the UI (such as a checkbox) to allow recruiters to set this flag to true if they intend to search for longer boolean strings.
bool strict_keywords_search = 13;
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
clone()
public SearchProfilesRequest.Builder clone()
Type | Description |
SearchProfilesRequest.Builder |
getCaseSensitiveSort()
public boolean getCaseSensitiveSort()
When sort by field is based on alphabetical order, sort values case sensitively (based on ASCII) when the value is set to true. Default value is case in-sensitive sort (false).
bool case_sensitive_sort = 9;
Type | Description |
boolean | The caseSensitiveSort. |
getDefaultInstanceForType()
public SearchProfilesRequest getDefaultInstanceForType()
Type | Description |
SearchProfilesRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Type | Description |
Descriptor |
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".
bool disable_spell_check = 7;
Type | Description |
boolean | The disableSpellCheck. |
getHistogramQueries(int index)
public HistogramQuery getHistogramQueries(int index)
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Name | Description |
index | int |
Type | Description |
HistogramQuery |
getHistogramQueriesBuilder(int index)
public HistogramQuery.Builder getHistogramQueriesBuilder(int index)
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Name | Description |
index | int |
Type | Description |
HistogramQuery.Builder |
getHistogramQueriesBuilderList()
public List<HistogramQuery.Builder> getHistogramQueriesBuilderList()
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Type | Description |
List<Builder> |
getHistogramQueriesCount()
public int getHistogramQueriesCount()
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Type | Description |
int |
getHistogramQueriesList()
public List<HistogramQuery> getHistogramQueriesList()
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Type | Description |
List<HistogramQuery> |
getHistogramQueriesOrBuilder(int index)
public HistogramQueryOrBuilder getHistogramQueriesOrBuilder(int index)
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Name | Description |
index | int |
Type | Description |
HistogramQueryOrBuilder |
getHistogramQueriesOrBuilderList()
public List<? extends HistogramQueryOrBuilder> getHistogramQueriesOrBuilderList()
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Type | Description |
List<? extends com.google.cloud.talent.v4beta1.HistogramQueryOrBuilder> |
getOffset()
public int getOffset()
An integer that specifies the current offset (that is, starting result) in search results. This field is only considered if page_token is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to search from the first profile, and 10 means to search from the 11th profile. This can be used for pagination, for example pageSize = 10 and offset = 10 means to search from the second page.
int32 offset = 6;
Type | Description |
int | The offset. |
getOrderBy()
public String getOrderBy()
The criteria that determines how search results are sorted. Defaults is "relevance desc" if no value is specified. Supported options are:
- "relevance desc": By descending relevance, as determined by the API algorithms.
- "update_date desc": Sort by Profile.update_time in descending order (recently updated profiles first).
- "create_date desc": Sort by Profile.create_time in descending order (recently created profiles first).
- "first_name": Sort by PersonName.PersonStructuredName.given_name in ascending order.
- "first_name desc": Sort by PersonName.PersonStructuredName.given_name in descending order.
- "last_name": Sort by PersonName.PersonStructuredName.family_name in ascending order.
- "last_name desc": Sort by PersonName.PersonStructuredName.family_name in ascending order.
string order_by = 8;
Type | Description |
String | The orderBy. |
getOrderByBytes()
public ByteString getOrderByBytes()
The criteria that determines how search results are sorted. Defaults is "relevance desc" if no value is specified. Supported options are:
- "relevance desc": By descending relevance, as determined by the API algorithms.
- "update_date desc": Sort by Profile.update_time in descending order (recently updated profiles first).
- "create_date desc": Sort by Profile.create_time in descending order (recently created profiles first).
- "first_name": Sort by PersonName.PersonStructuredName.given_name in ascending order.
- "first_name desc": Sort by PersonName.PersonStructuredName.given_name in descending order.
- "last_name": Sort by PersonName.PersonStructuredName.family_name in ascending order.
- "last_name desc": Sort by PersonName.PersonStructuredName.family_name in ascending order.
string order_by = 8;
Type | Description |
ByteString | The bytes for orderBy. |
getPageSize()
public int getPageSize()
A limit on the number of profiles returned in the search results. A value above the default value 10 can increase search response time. The maximum value allowed is 100. Otherwise an error is thrown.
int32 page_size = 4;
Type | Description |
int | The pageSize. |
getPageToken()
public String getPageToken()
The pageToken, similar to offset enables users of the API to paginate through the search results. To retrieve the first page of results, set the pageToken to empty. The search response includes a nextPageToken field that can be used to populate the pageToken field for the next page of results. Using pageToken instead of offset increases the performance of the API, especially compared to larger offset values.
string page_token = 5;
Type | Description |
String | The pageToken. |
getPageTokenBytes()
public ByteString getPageTokenBytes()
The pageToken, similar to offset enables users of the API to paginate through the search results. To retrieve the first page of results, set the pageToken to empty. The search response includes a nextPageToken field that can be used to populate the pageToken field for the next page of results. Using pageToken instead of offset increases the performance of the API, especially compared to larger offset values.
string page_token = 5;
Type | Description |
ByteString | The bytes for pageToken. |
getParent()
public String getParent()
Required. The resource name of the tenant to search within. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Type | Description |
String | The parent. |
getParentBytes()
public ByteString getParentBytes()
Required. The resource name of the tenant to search within. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Type | Description |
ByteString | The bytes for parent. |
getProfileQuery()
public ProfileQuery getProfileQuery()
Search query to execute. See ProfileQuery for more details.
.google.cloud.talent.v4beta1.ProfileQuery profile_query = 3;
Type | Description |
ProfileQuery | The profileQuery. |
getProfileQueryBuilder()
public ProfileQuery.Builder getProfileQueryBuilder()
Search query to execute. See ProfileQuery for more details.
.google.cloud.talent.v4beta1.ProfileQuery profile_query = 3;
Type | Description |
ProfileQuery.Builder |
getProfileQueryOrBuilder()
public ProfileQueryOrBuilder getProfileQueryOrBuilder()
Search query to execute. See ProfileQuery for more details.
.google.cloud.talent.v4beta1.ProfileQuery profile_query = 3;
Type | Description |
ProfileQueryOrBuilder |
getRequestMetadata()
public RequestMetadata getRequestMetadata()
Required. The meta information collected about the profile search user. This is used to improve the search quality of the service. These values are provided by users, and must be precise and consistent.
.google.cloud.talent.v4beta1.RequestMetadata request_metadata = 2 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
RequestMetadata | The requestMetadata. |
getRequestMetadataBuilder()
public RequestMetadata.Builder getRequestMetadataBuilder()
Required. The meta information collected about the profile search user. This is used to improve the search quality of the service. These values are provided by users, and must be precise and consistent.
.google.cloud.talent.v4beta1.RequestMetadata request_metadata = 2 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
RequestMetadata.Builder |
getRequestMetadataOrBuilder()
public RequestMetadataOrBuilder getRequestMetadataOrBuilder()
Required. The meta information collected about the profile search user. This is used to improve the search quality of the service. These values are provided by users, and must be precise and consistent.
.google.cloud.talent.v4beta1.RequestMetadata request_metadata = 2 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
RequestMetadataOrBuilder |
getResultSetId()
public String getResultSetId()
An id that uniquely identifies the result set of a SearchProfiles call. The id should be retrieved from the SearchProfilesResponse message returned from a previous invocation of SearchProfiles. A result set is an ordered list of search results. If this field is not set, a new result set is computed based on the profile_query. A new result_set_id is returned as a handle to access this result set. If this field is set, the service will ignore the resource and profile_query values, and simply retrieve a page of results from the corresponding result set. In this case, one and only one of page_token or offset must be set. A typical use case is to invoke SearchProfilesRequest without this field, then use the resulting result_set_id in SearchProfilesResponse to page through the results.
string result_set_id = 12;
Type | Description |
String | The resultSetId. |
getResultSetIdBytes()
public ByteString getResultSetIdBytes()
An id that uniquely identifies the result set of a SearchProfiles call. The id should be retrieved from the SearchProfilesResponse message returned from a previous invocation of SearchProfiles. A result set is an ordered list of search results. If this field is not set, a new result set is computed based on the profile_query. A new result_set_id is returned as a handle to access this result set. If this field is set, the service will ignore the resource and profile_query values, and simply retrieve a page of results from the corresponding result set. In this case, one and only one of page_token or offset must be set. A typical use case is to invoke SearchProfilesRequest without this field, then use the resulting result_set_id in SearchProfilesResponse to page through the results.
string result_set_id = 12;
Type | Description |
ByteString | The bytes for resultSetId. |
getStrictKeywordsSearch()
public boolean getStrictKeywordsSearch()
This flag is used to indicate whether the service will attempt to understand synonyms and terms related to the search query or treat the query "as is" when it generates a set of results. By default this flag is set to false, thus allowing expanded results to also be returned. For example a search for "software engineer" might also return candidates who have experience in jobs similar to software engineer positions. By setting this flag to true, the service will only attempt to deliver candidates has software engineer in his/her global fields by treating "software engineer" as a keyword. It is recommended to provide a feature in the UI (such as a checkbox) to allow recruiters to set this flag to true if they intend to search for longer boolean strings.
bool strict_keywords_search = 13;
Type | Description |
boolean | The strictKeywordsSearch. |
hasProfileQuery()
public boolean hasProfileQuery()
Search query to execute. See ProfileQuery for more details.
.google.cloud.talent.v4beta1.ProfileQuery profile_query = 3;
Type | Description |
boolean | Whether the profileQuery field is set. |
hasRequestMetadata()
public boolean hasRequestMetadata()
Required. The meta information collected about the profile search user. This is used to improve the search quality of the service. These values are provided by users, and must be precise and consistent.
.google.cloud.talent.v4beta1.RequestMetadata request_metadata = 2 [(.google.api.field_behavior) = REQUIRED];
Type | Description |
boolean | Whether the requestMetadata field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Type | Description |
boolean |
mergeFrom(SearchProfilesRequest other)
public SearchProfilesRequest.Builder mergeFrom(SearchProfilesRequest other)
Name | Description |
other | SearchProfilesRequest |
Type | Description |
SearchProfilesRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchProfilesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Type | Description |
SearchProfilesRequest.Builder |
Type | Description |
IOException |
mergeFrom(Message other)
public SearchProfilesRequest.Builder mergeFrom(Message other)
Name | Description |
other | Message |
Type | Description |
SearchProfilesRequest.Builder |
mergeProfileQuery(ProfileQuery value)
public SearchProfilesRequest.Builder mergeProfileQuery(ProfileQuery value)
Search query to execute. See ProfileQuery for more details.
.google.cloud.talent.v4beta1.ProfileQuery profile_query = 3;
Name | Description |
value | ProfileQuery |
Type | Description |
SearchProfilesRequest.Builder |
mergeRequestMetadata(RequestMetadata value)
public SearchProfilesRequest.Builder mergeRequestMetadata(RequestMetadata value)
Required. The meta information collected about the profile search user. This is used to improve the search quality of the service. These values are provided by users, and must be precise and consistent.
.google.cloud.talent.v4beta1.RequestMetadata request_metadata = 2 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
value | RequestMetadata |
Type | Description |
SearchProfilesRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final SearchProfilesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
SearchProfilesRequest.Builder |
removeHistogramQueries(int index)
public SearchProfilesRequest.Builder removeHistogramQueries(int index)
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Name | Description |
index | int |
Type | Description |
SearchProfilesRequest.Builder |
setCaseSensitiveSort(boolean value)
public SearchProfilesRequest.Builder setCaseSensitiveSort(boolean value)
When sort by field is based on alphabetical order, sort values case sensitively (based on ASCII) when the value is set to true. Default value is case in-sensitive sort (false).
bool case_sensitive_sort = 9;
Name | Description |
value | boolean The caseSensitiveSort to set. |
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
setDisableSpellCheck(boolean value)
public SearchProfilesRequest.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".
bool disable_spell_check = 7;
Name | Description |
value | boolean The disableSpellCheck to set. |
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public SearchProfilesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Name | Description |
field | FieldDescriptor |
value | Object |
Type | Description |
SearchProfilesRequest.Builder |
setHistogramQueries(int index, HistogramQuery value)
public SearchProfilesRequest.Builder setHistogramQueries(int index, HistogramQuery value)
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Name | Description |
index | int |
value | HistogramQuery |
Type | Description |
SearchProfilesRequest.Builder |
setHistogramQueries(int index, HistogramQuery.Builder builderForValue)
public SearchProfilesRequest.Builder setHistogramQueries(int index, HistogramQuery.Builder builderForValue)
A list of expressions specifies histogram requests against matching profiles for SearchProfilesRequest. The expression syntax looks like a function definition with parameters. Function syntax: function_name(histogram_facet[, list of buckets]) Data types:
- Histogram facet: facet names with format
a-zA-Z+
. - String: string like "any string with backslash escape for quote(\")."
- Number: whole number and floating point number like 10, -1 and -0.01.
- List: list of elements with comma(,) separator surrounded by square brackets. For example, [1, 2, 3] and ["one", "two", "three"]. Built-in constants:
- MIN (minimum number similar to java Double.MIN_VALUE)
- MAX (maximum number similar to java Double.MAX_VALUE) Built-in functions:
- bucket(start, end[, label]) Bucket build-in function creates a bucket with range of start, end). Note that the end is exclusive. For example, bucket(1, MAX, "positive number") or bucket(1, 10). Histogram Facets:
- admin1: Admin1 is a global placeholder for referring to state, province, or the particular term a country uses to define the geographic structure below the country level. Examples include states codes such as "CA", "IL", "NY", and provinces, such as "BC".
- locality: Locality is a global placeholder for referring to city, town, or the particular term a country uses to define the geographic structure below the admin1 level. Examples include city names such as "Mountain View" and "New York".
- extended_locality: Extended locality is concatenated version of admin1 and locality with comma separator. For example, "Mountain View, CA" and "New York, NY".
- postal_code: Postal code of profile which follows locale code.
- country: Country code (ISO-3166-1 alpha-2 code) of profile, such as US, JP, GB.
- job_title: Normalized job titles specified in EmploymentHistory.
- company_name: Normalized company name of profiles to match on.
- institution: The school name. For example, "MIT", "University of California, Berkeley"
- degree: Highest education degree in ISCED code. Each value in degree covers a specific level of education, without any expansion to upper nor lower levels of education degree.
- experience_in_months: experience in months. 0 means 0 month to 1 month (exclusive).
- application_date: The application date specifies application start dates. See [ApplicationDateFilter for more details.
- application_outcome_notes: The application outcome reason specifies the reasons behind the outcome of the job application. See ApplicationOutcomeNotesFilter for more details.
- application_job_title: The application job title specifies the job applied for in the application. See ApplicationJobFilter for more details.
- hirable_status: Hirable status specifies the profile's hirable status.
- string_custom_attribute: String custom attributes. Values can be accessed via square bracket notation like string_custom_attribute["key1"].
- numeric_custom_attribute: Numeric custom attributes. Values can be accessed via square bracket notation like numeric_custom_attribute["key1"]. Example expressions:
- count(admin1)
- count(experience_in_months, [bucket(0, 12, "1 year"), bucket(12, 36, "1-3 years"), bucket(36, MAX, "3+ years")])
- count(string_custom_attribute["assigned_recruiter"])
- count(numeric_custom_attribute["favorite_number"], [bucket(MIN, 0, "negative"), bucket(0, MAX, "non-negative")])
repeated .google.cloud.talent.v4beta1.HistogramQuery histogram_queries = 10;
Name | Description |
index | int |
builderForValue | HistogramQuery.Builder |
Type | Description |
SearchProfilesRequest.Builder |
setOffset(int value)
public SearchProfilesRequest.Builder setOffset(int value)
An integer that specifies the current offset (that is, starting result) in search results. This field is only considered if page_token is unset. The maximum allowed value is 5000. Otherwise an error is thrown. For example, 0 means to search from the first profile, and 10 means to search from the 11th profile. This can be used for pagination, for example pageSize = 10 and offset = 10 means to search from the second page.
int32 offset = 6;
Name | Description |
value | int The offset to set. |
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
setOrderBy(String value)
public SearchProfilesRequest.Builder setOrderBy(String value)
The criteria that determines how search results are sorted. Defaults is "relevance desc" if no value is specified. Supported options are:
- "relevance desc": By descending relevance, as determined by the API algorithms.
- "update_date desc": Sort by Profile.update_time in descending order (recently updated profiles first).
- "create_date desc": Sort by Profile.create_time in descending order (recently created profiles first).
- "first_name": Sort by PersonName.PersonStructuredName.given_name in ascending order.
- "first_name desc": Sort by PersonName.PersonStructuredName.given_name in descending order.
- "last_name": Sort by PersonName.PersonStructuredName.family_name in ascending order.
- "last_name desc": Sort by PersonName.PersonStructuredName.family_name in ascending order.
string order_by = 8;
Name | Description |
value | String The orderBy to set. |
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
setOrderByBytes(ByteString value)
public SearchProfilesRequest.Builder setOrderByBytes(ByteString value)
The criteria that determines how search results are sorted. Defaults is "relevance desc" if no value is specified. Supported options are:
- "relevance desc": By descending relevance, as determined by the API algorithms.
- "update_date desc": Sort by Profile.update_time in descending order (recently updated profiles first).
- "create_date desc": Sort by Profile.create_time in descending order (recently created profiles first).
- "first_name": Sort by PersonName.PersonStructuredName.given_name in ascending order.
- "first_name desc": Sort by PersonName.PersonStructuredName.given_name in descending order.
- "last_name": Sort by PersonName.PersonStructuredName.family_name in ascending order.
- "last_name desc": Sort by PersonName.PersonStructuredName.family_name in ascending order.
string order_by = 8;
Name | Description |
value | ByteString The bytes for orderBy to set. |
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
setPageSize(int value)
public SearchProfilesRequest.Builder setPageSize(int value)
A limit on the number of profiles returned in the search results. A value above the default value 10 can increase search response time. The maximum value allowed is 100. Otherwise an error is thrown.
int32 page_size = 4;
Name | Description |
value | int The pageSize to set. |
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
setPageToken(String value)
public SearchProfilesRequest.Builder setPageToken(String value)
The pageToken, similar to offset enables users of the API to paginate through the search results. To retrieve the first page of results, set the pageToken to empty. The search response includes a nextPageToken field that can be used to populate the pageToken field for the next page of results. Using pageToken instead of offset increases the performance of the API, especially compared to larger offset values.
string page_token = 5;
Name | Description |
value | String The pageToken to set. |
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public SearchProfilesRequest.Builder setPageTokenBytes(ByteString value)
The pageToken, similar to offset enables users of the API to paginate through the search results. To retrieve the first page of results, set the pageToken to empty. The search response includes a nextPageToken field that can be used to populate the pageToken field for the next page of results. Using pageToken instead of offset increases the performance of the API, especially compared to larger offset values.
string page_token = 5;
Name | Description |
value | ByteString The bytes for pageToken to set. |
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
setParent(String value)
public SearchProfilesRequest.Builder setParent(String value)
Required. The resource name of the tenant to search within. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Name | Description |
value | String The parent to set. |
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public SearchProfilesRequest.Builder setParentBytes(ByteString value)
Required. The resource name of the tenant to search within. The format is "projects/{project_id}/tenants/{tenant_id}". For example, "projects/foo/tenants/bar".
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Name | Description |
value | ByteString The bytes for parent to set. |
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
setProfileQuery(ProfileQuery value)
public SearchProfilesRequest.Builder setProfileQuery(ProfileQuery value)
Search query to execute. See ProfileQuery for more details.
.google.cloud.talent.v4beta1.ProfileQuery profile_query = 3;
Name | Description |
value | ProfileQuery |
Type | Description |
SearchProfilesRequest.Builder |
setProfileQuery(ProfileQuery.Builder builderForValue)
public SearchProfilesRequest.Builder setProfileQuery(ProfileQuery.Builder builderForValue)
Search query to execute. See ProfileQuery for more details.
.google.cloud.talent.v4beta1.ProfileQuery profile_query = 3;
Name | Description |
builderForValue | ProfileQuery.Builder |
Type | Description |
SearchProfilesRequest.Builder |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public SearchProfilesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Type | Description |
SearchProfilesRequest.Builder |
setRequestMetadata(RequestMetadata value)
public SearchProfilesRequest.Builder setRequestMetadata(RequestMetadata value)
Required. The meta information collected about the profile search user. This is used to improve the search quality of the service. These values are provided by users, and must be precise and consistent.
.google.cloud.talent.v4beta1.RequestMetadata request_metadata = 2 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
value | RequestMetadata |
Type | Description |
SearchProfilesRequest.Builder |
setRequestMetadata(RequestMetadata.Builder builderForValue)
public SearchProfilesRequest.Builder setRequestMetadata(RequestMetadata.Builder builderForValue)
Required. The meta information collected about the profile search user. This is used to improve the search quality of the service. These values are provided by users, and must be precise and consistent.
.google.cloud.talent.v4beta1.RequestMetadata request_metadata = 2 [(.google.api.field_behavior) = REQUIRED];
Name | Description |
builderForValue | RequestMetadata.Builder |
Type | Description |
SearchProfilesRequest.Builder |
setResultSetId(String value)
public SearchProfilesRequest.Builder setResultSetId(String value)
An id that uniquely identifies the result set of a SearchProfiles call. The id should be retrieved from the SearchProfilesResponse message returned from a previous invocation of SearchProfiles. A result set is an ordered list of search results. If this field is not set, a new result set is computed based on the profile_query. A new result_set_id is returned as a handle to access this result set. If this field is set, the service will ignore the resource and profile_query values, and simply retrieve a page of results from the corresponding result set. In this case, one and only one of page_token or offset must be set. A typical use case is to invoke SearchProfilesRequest without this field, then use the resulting result_set_id in SearchProfilesResponse to page through the results.
string result_set_id = 12;
Name | Description |
value | String The resultSetId to set. |
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
setResultSetIdBytes(ByteString value)
public SearchProfilesRequest.Builder setResultSetIdBytes(ByteString value)
An id that uniquely identifies the result set of a SearchProfiles call. The id should be retrieved from the SearchProfilesResponse message returned from a previous invocation of SearchProfiles. A result set is an ordered list of search results. If this field is not set, a new result set is computed based on the profile_query. A new result_set_id is returned as a handle to access this result set. If this field is set, the service will ignore the resource and profile_query values, and simply retrieve a page of results from the corresponding result set. In this case, one and only one of page_token or offset must be set. A typical use case is to invoke SearchProfilesRequest without this field, then use the resulting result_set_id in SearchProfilesResponse to page through the results.
string result_set_id = 12;
Name | Description |
value | ByteString The bytes for resultSetId to set. |
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
setStrictKeywordsSearch(boolean value)
public SearchProfilesRequest.Builder setStrictKeywordsSearch(boolean value)
This flag is used to indicate whether the service will attempt to understand synonyms and terms related to the search query or treat the query "as is" when it generates a set of results. By default this flag is set to false, thus allowing expanded results to also be returned. For example a search for "software engineer" might also return candidates who have experience in jobs similar to software engineer positions. By setting this flag to true, the service will only attempt to deliver candidates has software engineer in his/her global fields by treating "software engineer" as a keyword. It is recommended to provide a feature in the UI (such as a checkbox) to allow recruiters to set this flag to true if they intend to search for longer boolean strings.
bool strict_keywords_search = 13;
Name | Description |
value | boolean The strictKeywordsSearch to set. |
Type | Description |
SearchProfilesRequest.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final SearchProfilesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Name | Description |
unknownFields | UnknownFieldSet |
Type | Description |
SearchProfilesRequest.Builder |