public final class SearchProfilesRequest extends GeneratedMessageV3 implements SearchProfilesRequestOrBuilder
The request body of the SearchProfiles
call.
Protobuf type google.cloud.talent.v4beta1.SearchProfilesRequest
Static Fields
CASE_SENSITIVE_SORT_FIELD_NUMBER
public static final int CASE_SENSITIVE_SORT_FIELD_NUMBER
Field Value
DISABLE_SPELL_CHECK_FIELD_NUMBER
public static final int DISABLE_SPELL_CHECK_FIELD_NUMBER
Field Value
HISTOGRAM_QUERIES_FIELD_NUMBER
public static final int HISTOGRAM_QUERIES_FIELD_NUMBER
Field Value
OFFSET_FIELD_NUMBER
public static final int OFFSET_FIELD_NUMBER
Field Value
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
PROFILE_QUERY_FIELD_NUMBER
public static final int PROFILE_QUERY_FIELD_NUMBER
Field Value
public static final int REQUEST_METADATA_FIELD_NUMBER
Field Value
RESULT_SET_ID_FIELD_NUMBER
public static final int RESULT_SET_ID_FIELD_NUMBER
Field Value
STRICT_KEYWORDS_SEARCH_FIELD_NUMBER
public static final int STRICT_KEYWORDS_SEARCH_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static SearchProfilesRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static SearchProfilesRequest.Builder newBuilder()
Returns
newBuilder(SearchProfilesRequest prototype)
public static SearchProfilesRequest.Builder newBuilder(SearchProfilesRequest prototype)
Parameter
Returns
public static SearchProfilesRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchProfilesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static SearchProfilesRequest parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchProfilesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static SearchProfilesRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchProfilesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchProfilesRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static SearchProfilesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static SearchProfilesRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static SearchProfilesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static SearchProfilesRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchProfilesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<SearchProfilesRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
Returns
Type | Description |
boolean | The caseSensitiveSort.
|
getDefaultInstanceForType()
public SearchProfilesRequest getDefaultInstanceForType()
Returns
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;
Returns
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;
Parameter
Returns
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;
Returns
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;
Returns
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;
Parameter
Returns
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;
Returns
Type | Description |
List<? extends com.google.cloud.talent.v4beta1.HistogramQueryOrBuilder> | |
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;
Returns
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;
Returns
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;
Returns
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;
Returns
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;
Returns
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;
Returns
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) = { ... }
Returns
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) = { ... }
Returns
getParserForType()
public Parser<SearchProfilesRequest> getParserForType()
Returns
Overrides
getProfileQuery()
public ProfileQuery getProfileQuery()
Search query to execute. See ProfileQuery for more details.
.google.cloud.talent.v4beta1.ProfileQuery profile_query = 3;
Returns
getProfileQueryOrBuilder()
public ProfileQueryOrBuilder getProfileQueryOrBuilder()
Search query to execute. See ProfileQuery for more details.
.google.cloud.talent.v4beta1.ProfileQuery profile_query = 3;
Returns
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];
Returns
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];
Returns
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;
Returns
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;
Returns
Type | Description |
ByteString | The bytes for resultSetId.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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;
Returns
Type | Description |
boolean | The strictKeywordsSearch.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasProfileQuery()
public boolean hasProfileQuery()
Search query to execute. See ProfileQuery for more details.
.google.cloud.talent.v4beta1.ProfileQuery profile_query = 3;
Returns
Type | Description |
boolean | Whether the profileQuery field is set.
|
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];
Returns
Type | Description |
boolean | Whether the requestMetadata field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public SearchProfilesRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchProfilesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public SearchProfilesRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions