SearchJobsRequest (Google Cloud Talent Solution Parent 2.4.6 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.talent.v4.SearchJobsRequest

All Implemented Interfaces:

SearchJobsRequestOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable
```
public final class SearchJobsRequest
extends GeneratedMessageV3
implements SearchJobsRequestOrBuilder
```
```
 The Request body of the `SearchJobs` call.
 
```
Protobuf type google.cloud.talent.v4.SearchJobsRequest
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SearchJobsRequest.Builder` The Request body of the `SearchJobs` call.
`static class`	`SearchJobsRequest.CustomRankingInfo` Custom ranking information for [SearchJobsRequest][google.cloud.talent.v4.SearchJobsRequest].
`static interface`	`SearchJobsRequest.CustomRankingInfoOrBuilder`
`static class`	`SearchJobsRequest.DiversificationLevel` Controls whether highly similar jobs are returned next to each other in the search results.
`static class`	`SearchJobsRequest.KeywordMatchMode` Controls what keyword matching behavior the search has.
`static class`	`SearchJobsRequest.SearchMode` A string-represented enumeration of the job search mode.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CUSTOM_RANKING_INFO_FIELD_NUMBER`
`static int`	`DISABLE_KEYWORD_MATCH_FIELD_NUMBER`
`static int`	`DIVERSIFICATION_LEVEL_FIELD_NUMBER`
`static int`	`ENABLE_BROADENING_FIELD_NUMBER`
`static int`	`HISTOGRAM_QUERIES_FIELD_NUMBER`
`static int`	`JOB_QUERY_FIELD_NUMBER`
`static int`	`JOB_VIEW_FIELD_NUMBER`
`static int`	`KEYWORD_MATCH_MODE_FIELD_NUMBER`
`static int`	`MAX_PAGE_SIZE_FIELD_NUMBER`
`static int`	`OFFSET_FIELD_NUMBER`
`static int`	`ORDER_BY_FIELD_NUMBER`
`static int`	`PAGE_TOKEN_FIELD_NUMBER`
`static int`	`PARENT_FIELD_NUMBER`
`static int`	`REQUEST_METADATA_FIELD_NUMBER`
`static int`	`SEARCH_MODE_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 Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`SearchJobsRequest.CustomRankingInfo`	`getCustomRankingInfo()` Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm).
`SearchJobsRequest.CustomRankingInfoOrBuilder`	`getCustomRankingInfoOrBuilder()` Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm).
`static SearchJobsRequest`	`getDefaultInstance()`
`SearchJobsRequest`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`boolean`	`getDisableKeywordMatch()` Deprecated. google.cloud.talent.v4.SearchJobsRequest.disable_keyword_match is deprecated. See google/cloud/talent/v4/job_service.proto;l=739
`SearchJobsRequest.DiversificationLevel`	`getDiversificationLevel()` Controls whether highly similar jobs are returned next to each other in the search results.
`int`	`getDiversificationLevelValue()` Controls whether highly similar jobs are returned next to each other in the search results.
`boolean`	`getEnableBroadening()` Controls whether to broaden the search when it produces sparse results.
`HistogramQuery`	`getHistogramQueries(int index)` An expression specifies a histogram request against matching jobs.
`int`	`getHistogramQueriesCount()` An expression specifies a histogram request against matching jobs.
`List<HistogramQuery>`	`getHistogramQueriesList()` An expression specifies a histogram request against matching jobs.
`HistogramQueryOrBuilder`	`getHistogramQueriesOrBuilder(int index)` An expression specifies a histogram request against matching jobs.
`List<? extends HistogramQueryOrBuilder>`	`getHistogramQueriesOrBuilderList()` An expression specifies a histogram request against matching jobs.
`JobQuery`	`getJobQuery()` Query used to search against jobs, such as keyword, location filters, etc.
`JobQueryOrBuilder`	`getJobQueryOrBuilder()` Query used to search against jobs, such as keyword, location filters, etc.
`JobView`	`getJobView()` The desired job attributes returned for jobs in the search response.
`int`	`getJobViewValue()` The desired job attributes returned for jobs in the search response.
`SearchJobsRequest.KeywordMatchMode`	`getKeywordMatchMode()` Controls what keyword match options to use.
`int`	`getKeywordMatchModeValue()` Controls what keyword match options to use.
`int`	`getMaxPageSize()` A limit on the number of jobs returned in the search results.
`int`	`getOffset()` An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results.
`String`	`getOrderBy()` The criteria determining how search results are sorted.
`ByteString`	`getOrderByBytes()` The criteria determining how search results are sorted.
`String`	`getPageToken()` The token specifying the current offset within search results.
`ByteString`	`getPageTokenBytes()` The token specifying the current offset within search results.
`String`	`getParent()` Required.
`ByteString`	`getParentBytes()` Required.
`Parser<SearchJobsRequest>`	`getParserForType()`
`RequestMetadata`	`getRequestMetadata()` Required.
`RequestMetadataOrBuilder`	`getRequestMetadataOrBuilder()` Required.
`SearchJobsRequest.SearchMode`	`getSearchMode()` Mode of a search.
`int`	`getSearchModeValue()` Mode of a search.
`int`	`getSerializedSize()`
`UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasCustomRankingInfo()` Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm).
`int`	`hashCode()`
`boolean`	`hasJobQuery()` Query used to search against jobs, such as keyword, location filters, etc.
`boolean`	`hasRequestMetadata()` Required.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static SearchJobsRequest.Builder`	`newBuilder()`
`static SearchJobsRequest.Builder`	`newBuilder(SearchJobsRequest prototype)`
`SearchJobsRequest.Builder`	`newBuilderForType()`
`protected SearchJobsRequest.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)`
`static SearchJobsRequest`	`parseDelimitedFrom(InputStream input)`
`static SearchJobsRequest`	`parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static SearchJobsRequest`	`parseFrom(byte[] data)`
`static SearchJobsRequest`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static SearchJobsRequest`	`parseFrom(ByteBuffer data)`
`static SearchJobsRequest`	`parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static SearchJobsRequest`	`parseFrom(ByteString data)`
`static SearchJobsRequest`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static SearchJobsRequest`	`parseFrom(CodedInputStream input)`
`static SearchJobsRequest`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static SearchJobsRequest`	`parseFrom(InputStream input)`
`static SearchJobsRequest`	`parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<SearchJobsRequest>`	`parser()`
`SearchJobsRequest.Builder`	`toBuilder()`
`void`	`writeTo(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, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, 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
- SEARCH_MODE_FIELD_NUMBER
```
public static final int SEARCH_MODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REQUEST_METADATA_FIELD_NUMBER
```
public static final int REQUEST_METADATA_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- JOB_QUERY_FIELD_NUMBER
```
public static final int JOB_QUERY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ENABLE_BROADENING_FIELD_NUMBER
```
public static final int ENABLE_BROADENING_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HISTOGRAM_QUERIES_FIELD_NUMBER
```
public static final int HISTOGRAM_QUERIES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- JOB_VIEW_FIELD_NUMBER
```
public static final int JOB_VIEW_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OFFSET_FIELD_NUMBER
```
public static final int OFFSET_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MAX_PAGE_SIZE_FIELD_NUMBER
```
public static final int MAX_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
- ORDER_BY_FIELD_NUMBER
```
public static final int ORDER_BY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DIVERSIFICATION_LEVEL_FIELD_NUMBER
```
public static final int DIVERSIFICATION_LEVEL_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CUSTOM_RANKING_INFO_FIELD_NUMBER
```
public static final int CUSTOM_RANKING_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISABLE_KEYWORD_MATCH_FIELD_NUMBER
```
public static final int DISABLE_KEYWORD_MATCH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- KEYWORD_MATCH_MODE_FIELD_NUMBER
```
public static final int KEYWORD_MATCH_MODE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class GeneratedMessageV3

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class 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/foo/tenants/bar".


 string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:: getParent in interface SearchJobsRequestOrBuilder
Returns:: 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) = { ... }
Specified by:

getParentBytes in interface SearchJobsRequestOrBuilder

Returns:

The bytes for parent.

getSearchModeValue
```
public int getSearchModeValue()
```
```
 Mode of a search.
 Defaults to [SearchMode.JOB_SEARCH][google.cloud.talent.v4.SearchJobsRequest.SearchMode.JOB_SEARCH].
 
```
.google.cloud.talent.v4.SearchJobsRequest.SearchMode search_mode = 2;
Specified by:

getSearchModeValue in interface SearchJobsRequestOrBuilder

Returns:

The enum numeric value on the wire for searchMode.

getSearchMode

public SearchJobsRequest.SearchMode getSearchMode()

 Mode of a search.
 Defaults to [SearchMode.JOB_SEARCH][google.cloud.talent.v4.SearchJobsRequest.SearchMode.JOB_SEARCH].

.google.cloud.talent.v4.SearchJobsRequest.SearchMode search_mode = 2;

Specified by:: getSearchMode in interface SearchJobsRequestOrBuilder
Returns:: The searchMode.

hasRequestMetadata

public boolean hasRequestMetadata()

 Required. The meta information collected about the job searcher, used to improve the
 search quality of the service. The identifiers (such as `user_id`) are
 provided by users, and must be unique and consistent.


 .google.cloud.talent.v4.RequestMetadata request_metadata = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:: hasRequestMetadata in interface SearchJobsRequestOrBuilder
Returns:: Whether the requestMetadata field is set.

getRequestMetadata

public RequestMetadata getRequestMetadata()

 Required. The meta information collected about the job searcher, used to improve the
 search quality of the service. The identifiers (such as `user_id`) are
 provided by users, and must be unique and consistent.


 .google.cloud.talent.v4.RequestMetadata request_metadata = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getRequestMetadata in interface SearchJobsRequestOrBuilder
Returns:: The requestMetadata.

getRequestMetadataOrBuilder

public RequestMetadataOrBuilder getRequestMetadataOrBuilder()

 Required. The meta information collected about the job searcher, used to improve the
 search quality of the service. The identifiers (such as `user_id`) are
 provided by users, and must be unique and consistent.


 .google.cloud.talent.v4.RequestMetadata request_metadata = 3 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getRequestMetadataOrBuilder in interface SearchJobsRequestOrBuilder

hasJobQuery
```
public boolean hasJobQuery()
```
```
 Query used to search against jobs, such as keyword, location filters, etc.
 
```
.google.cloud.talent.v4.JobQuery job_query = 4;
Specified by:

hasJobQuery in interface SearchJobsRequestOrBuilder

Returns:

Whether the jobQuery field is set.

getJobQuery
```
public JobQuery getJobQuery()
```
```
 Query used to search against jobs, such as keyword, location filters, etc.
 
```
.google.cloud.talent.v4.JobQuery job_query = 4;
Specified by:

getJobQuery in interface SearchJobsRequestOrBuilder

Returns:

The jobQuery.

getJobQueryOrBuilder
```
public JobQueryOrBuilder getJobQueryOrBuilder()
```
```
 Query used to search against jobs, such as keyword, location filters, etc.
 
```
.google.cloud.talent.v4.JobQuery job_query = 4;
Specified by:

getJobQueryOrBuilder in interface SearchJobsRequestOrBuilder

getEnableBroadening

public boolean getEnableBroadening()

 Controls whether to broaden the search when it produces sparse results.
 Broadened queries append results to the end of the matching results
 list.
 Defaults to false.

bool enable_broadening = 5;

Specified by:: getEnableBroadening in interface SearchJobsRequestOrBuilder
Returns:: The enableBroadening.