SearchProfilesRequest (proto-google-cloud-talent-v4beta1 0.24.0-beta API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.talent.v4beta1.SearchProfilesRequest

All Implemented Interfaces:

SearchProfilesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class SearchProfilesRequest
extends com.google.protobuf.GeneratedMessageV3
implements SearchProfilesRequestOrBuilder
```
```
 The request body of the `SearchProfiles` call.
 
```
Protobuf type google.cloud.talent.v4beta1.SearchProfilesRequest
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SearchProfilesRequest.Builder
The request body of the `SearchProfiles` call.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested Classes
Modifier and Type	Class and Description
`static class`	`SearchProfilesRequest.Builder` The request body of the `SearchProfiles` call.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CASE_SENSITIVE_SORT_FIELD_NUMBER`
`static int`	`DISABLE_SPELL_CHECK_FIELD_NUMBER`
`static int`	`HISTOGRAM_QUERIES_FIELD_NUMBER`
`static int`	`OFFSET_FIELD_NUMBER`
`static int`	`ORDER_BY_FIELD_NUMBER`
`static int`	`PAGE_SIZE_FIELD_NUMBER`
`static int`	`PAGE_TOKEN_FIELD_NUMBER`
`static int`	`PARENT_FIELD_NUMBER`
`static int`	`PROFILE_QUERY_FIELD_NUMBER`
`static int`	`REQUEST_METADATA_FIELD_NUMBER`
`static int`	`RESULT_SET_ID_FIELD_NUMBER`
`static int`	`STRICT_KEYWORDS_SEARCH_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`boolean`	`getCaseSensitiveSort()` Optional.
`static SearchProfilesRequest`	`getDefaultInstance()`
`SearchProfilesRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`boolean`	`getDisableSpellCheck()` Optional.
`HistogramQuery`	`getHistogramQueries(int index)` Optional.
`int`	`getHistogramQueriesCount()` Optional.
`List<HistogramQuery>`	`getHistogramQueriesList()` Optional.
`HistogramQueryOrBuilder`	`getHistogramQueriesOrBuilder(int index)` Optional.
`List<? extends HistogramQueryOrBuilder>`	`getHistogramQueriesOrBuilderList()` Optional.
`int`	`getOffset()` Optional.
`String`	`getOrderBy()` Optional.
`com.google.protobuf.ByteString`	`getOrderByBytes()` Optional.
`int`	`getPageSize()` Optional.
`String`	`getPageToken()` Optional.
`com.google.protobuf.ByteString`	`getPageTokenBytes()` Optional.
`String`	`getParent()` Required.
`com.google.protobuf.ByteString`	`getParentBytes()` Required.
`com.google.protobuf.Parser<SearchProfilesRequest>`	`getParserForType()`
`ProfileQuery`	`getProfileQuery()` Optional.
`ProfileQueryOrBuilder`	`getProfileQueryOrBuilder()` Optional.
`RequestMetadata`	`getRequestMetadata()` Required.
`RequestMetadataOrBuilder`	`getRequestMetadataOrBuilder()` Required.
`String`	`getResultSetId()` Optional.
`com.google.protobuf.ByteString`	`getResultSetIdBytes()` Optional.
`int`	`getSerializedSize()`
`boolean`	`getStrictKeywordsSearch()` Optional.
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`boolean`	`hasProfileQuery()` Optional.
`boolean`	`hasRequestMetadata()` Required.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static SearchProfilesRequest.Builder`	`newBuilder()`
`static SearchProfilesRequest.Builder`	`newBuilder(SearchProfilesRequest prototype)`
`SearchProfilesRequest.Builder`	`newBuilderForType()`
`protected SearchProfilesRequest.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static SearchProfilesRequest`	`parseDelimitedFrom(InputStream input)`
`static SearchProfilesRequest`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchProfilesRequest`	`parseFrom(byte[] data)`
`static SearchProfilesRequest`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchProfilesRequest`	`parseFrom(ByteBuffer data)`
`static SearchProfilesRequest`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchProfilesRequest`	`parseFrom(com.google.protobuf.ByteString data)`
`static SearchProfilesRequest`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchProfilesRequest`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static SearchProfilesRequest`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchProfilesRequest`	`parseFrom(InputStream input)`
`static SearchProfilesRequest`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<SearchProfilesRequest>`	`parser()`
`SearchProfilesRequest.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newInstance, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- PARENT_FIELD_NUMBER
```
public static final int PARENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REQUEST_METADATA_FIELD_NUMBER
```
public static final int REQUEST_METADATA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PROFILE_QUERY_FIELD_NUMBER
```
public static final int PROFILE_QUERY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAGE_SIZE_FIELD_NUMBER
```
public static final int PAGE_SIZE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAGE_TOKEN_FIELD_NUMBER
```
public static final int PAGE_TOKEN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OFFSET_FIELD_NUMBER
```
public static final int OFFSET_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISABLE_SPELL_CHECK_FIELD_NUMBER
```
public static final int DISABLE_SPELL_CHECK_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ORDER_BY_FIELD_NUMBER
```
public static final int ORDER_BY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CASE_SENSITIVE_SORT_FIELD_NUMBER
```
public static final int CASE_SENSITIVE_SORT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HISTOGRAM_QUERIES_FIELD_NUMBER
```
public static final int HISTOGRAM_QUERIES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RESULT_SET_ID_FIELD_NUMBER
```
public static final int RESULT_SET_ID_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STRICT_KEYWORDS_SEARCH_FIELD_NUMBER
```
public static final int STRICT_KEYWORDS_SEARCH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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/api-test-project/tenants/foo".

string parent = 1;

Specified by:: getParent in interface SearchProfilesRequestOrBuilder

getParentBytes

public com.google.protobuf.ByteString getParentBytes()

 Required. The resource name of the tenant to search within.
 The format is "projects/{project_id}/tenants/{tenant_id}", for example,
 "projects/api-test-project/tenants/foo".

string parent = 1;

Specified by:: getParentBytes in interface SearchProfilesRequestOrBuilder

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;

Specified by:: hasRequestMetadata in interface SearchProfilesRequestOrBuilder

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;

Specified by:: getRequestMetadata in interface SearchProfilesRequestOrBuilder

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;

Specified by:: getRequestMetadataOrBuilder in interface SearchProfilesRequestOrBuilder

hasProfileQuery

public boolean hasProfileQuery()

 Optional. Search query to execute. See
 [ProfileQuery][google.cloud.talent.v4beta1.ProfileQuery] for more details.

.google.cloud.talent.v4beta1.ProfileQuery profile_query = 3;

Specified by:: hasProfileQuery in interface SearchProfilesRequestOrBuilder

getProfileQuery

public ProfileQuery getProfileQuery()

 Optional. Search query to execute. See
 [ProfileQuery][google.cloud.talent.v4beta1.ProfileQuery] for more details.

.google.cloud.talent.v4beta1.ProfileQuery profile_query = 3;

Specified by:: getProfileQuery in interface SearchProfilesRequestOrBuilder

getProfileQueryOrBuilder

public ProfileQueryOrBuilder getProfileQueryOrBuilder()

 Optional. Search query to execute. See
 [ProfileQuery][google.cloud.talent.v4beta1.ProfileQuery] for more details.

.google.cloud.talent.v4beta1.ProfileQuery profile_query = 3;

Specified by:: getProfileQueryOrBuilder in interface SearchProfilesRequestOrBuilder

getPageSize

public int getPageSize()

 Optional. 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;

Specified by:: getPageSize in interface SearchProfilesRequestOrBuilder

getPageToken

public String getPageToken()

 Optional. 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][google.cloud.talent.v4beta1.SearchProfilesResponse.next_page_token]
 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;

Specified by:: getPageToken in interface SearchProfilesRequestOrBuilder

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 Optional. 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][google.cloud.talent.v4beta1.SearchProfilesResponse.next_page_token]
 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;

Specified by:: getPageTokenBytes in interface SearchProfilesRequestOrBuilder

getOffset

public int getOffset()

 Optional. An integer that specifies the current offset (that is, starting
 result) in search results. This field is only considered if
 [page_token][google.cloud.talent.v4beta1.SearchProfilesRequest.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;

Specified by:: getOffset in interface SearchProfilesRequestOrBuilder

getDisableSpellCheck

public boolean getDisableSpellCheck()

 Optional. 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;

Specified by:: getDisableSpellCheck in interface SearchProfilesRequestOrBuilder

getOrderBy

public String getOrderBy()

 Optional. 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][google.cloud.talent.v4beta1.Profile.update_time] in
 descending order
   (recently updated profiles first).
 * "create_date desc": Sort by
 [Profile.create_time][google.cloud.talent.v4beta1.Profile.create_time] in
 descending order
   (recently created profiles first).
 * "first_name": Sort by
 [PersonName.PersonStructuredName.given_name][google.cloud.talent.v4beta1.PersonName.PersonStructuredName.given_name]
 in
   ascending order.
 * "first_name desc": Sort by
 [PersonName.PersonStructuredName.given_name][google.cloud.talent.v4beta1.PersonName.PersonStructuredName.given_name]
   in descending order.
 * "last_name": Sort by
 [PersonName.PersonStructuredName.family_name][google.cloud.talent.v4beta1.PersonName.PersonStructuredName.family_name]
 in
   ascending order.
 * "last_name desc": Sort by
 [PersonName.PersonStructuredName.family_name][google.cloud.talent.v4beta1.PersonName.PersonStructuredName.family_name]
   in ascending order.

string order_by = 8;

Specified by:: getOrderBy in interface SearchProfilesRequestOrBuilder

getOrderByBytes

public com.google.protobuf.ByteString getOrderByBytes()

 Optional. 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][google.cloud.talent.v4beta1.Profile.update_time] in
 descending order
   (recently updated profiles first).
 * "create_date desc": Sort by
 [Profile.create_time][google.cloud.talent.v4beta1.Profile.create_time] in
 descending order
   (recently created profiles first).
 * "first_name": Sort by
 [PersonName.PersonStructuredName.given_name][google.cloud.talent.v4beta1.PersonName.PersonStructuredName.given_name]
 in
   ascending order.
 * "first_name desc": Sort by
 [PersonName.PersonStructuredName.given_name][google.cloud.talent.v4beta1.PersonName.PersonStructuredName.given_name]
   in descending order.
 * "last_name": Sort by
 [PersonName.PersonStructuredName.family_name][google.cloud.talent.v4beta1.PersonName.PersonStructuredName.family_name]
 in
   ascending order.
 * "last_name desc": Sort by
 [PersonName.PersonStructuredName.family_name][google.cloud.talent.v4beta1.PersonName.PersonStructuredName.family_name]
   in ascending order.

string order_by = 8;

Specified by:: getOrderByBytes in interface SearchProfilesRequestOrBuilder

getCaseSensitiveSort

public boolean getCaseSensitiveSort()

 Optional. 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;

Specified by:: getCaseSensitiveSort in interface SearchProfilesRequestOrBuilder