SearchJobsRequest (proto-google-cloud-talent-v4beta1 0.14.0-beta API)

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

All Implemented Interfaces:

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

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SearchJobsRequest.Builder` Input only.
`static class`	`SearchJobsRequest.CustomRankingInfo` Input only.
`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.SearchMode` A string-represented enumeration of the job search mode.

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

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`	`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`	`REQUEST_METADATA_FIELD_NUMBER`
`static int`	`REQUIRE_PRECISE_RESULT_SIZE_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
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`SearchJobsRequest.CustomRankingInfo`	`getCustomRankingInfo()` Optional.
`SearchJobsRequest.CustomRankingInfoOrBuilder`	`getCustomRankingInfoOrBuilder()` Optional.
`static SearchJobsRequest`	`getDefaultInstance()`
`SearchJobsRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`boolean`	`getDisableKeywordMatch()` Optional.
`SearchJobsRequest.DiversificationLevel`	`getDiversificationLevel()` Optional.
`int`	`getDiversificationLevelValue()` Optional.
`boolean`	`getEnableBroadening()` Optional.
`HistogramQuery`	`getHistogramQueries(int index)` Optional.
`int`	`getHistogramQueriesCount()` Optional.
`List<HistogramQuery>`	`getHistogramQueriesList()` Optional.
`HistogramQueryOrBuilder`	`getHistogramQueriesOrBuilder(int index)` Optional.
`List<? extends HistogramQueryOrBuilder>`	`getHistogramQueriesOrBuilderList()` Optional.
`JobQuery`	`getJobQuery()` Optional.
`JobQueryOrBuilder`	`getJobQueryOrBuilder()` Optional.
`JobView`	`getJobView()` Optional.
`int`	`getJobViewValue()` 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<SearchJobsRequest>`	`getParserForType()`
`RequestMetadata`	`getRequestMetadata()` Required.
`RequestMetadataOrBuilder`	`getRequestMetadataOrBuilder()` Required.
`boolean`	`getRequirePreciseResultSize()` Optional.
`SearchJobsRequest.SearchMode`	`getSearchMode()` Optional.
`int`	`getSearchModeValue()` Optional.
`int`	`getSerializedSize()`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasCustomRankingInfo()` Optional.
`int`	`hashCode()`
`boolean`	`hasJobQuery()` Optional.
`boolean`	`hasRequestMetadata()` Required.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static SearchJobsRequest.Builder`	`newBuilder()`
`static SearchJobsRequest.Builder`	`newBuilder(SearchJobsRequest prototype)`
`SearchJobsRequest.Builder`	`newBuilderForType()`
`protected SearchJobsRequest.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`static SearchJobsRequest`	`parseDelimitedFrom(InputStream input)`
`static SearchJobsRequest`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchJobsRequest`	`parseFrom(byte[] data)`
`static SearchJobsRequest`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchJobsRequest`	`parseFrom(ByteBuffer data)`
`static SearchJobsRequest`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchJobsRequest`	`parseFrom(com.google.protobuf.ByteString data)`
`static SearchJobsRequest`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchJobsRequest`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static SearchJobsRequest`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchJobsRequest`	`parseFrom(InputStream input)`
`static SearchJobsRequest`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<SearchJobsRequest>`	`parser()`
`SearchJobsRequest.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, 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
- REQUIRE_PRECISE_RESULT_SIZE_FIELD_NUMBER
```
public static final int REQUIRE_PRECISE_RESULT_SIZE_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
- 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
- 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

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/tenant/foo".
 Tenant id is optional and the default tenant is used if unspecified, for
 example, "projects/api-test-project".

string parent = 1;

Specified by:: getParent in interface SearchJobsRequestOrBuilder

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/tenant/foo".
 Tenant id is optional and the default tenant is used if unspecified, for
 example, "projects/api-test-project".

string parent = 1;

Specified by:: getParentBytes in interface SearchJobsRequestOrBuilder

getSearchModeValue

public int getSearchModeValue()

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

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

Specified by:: getSearchModeValue in interface SearchJobsRequestOrBuilder

getSearchMode

public SearchJobsRequest.SearchMode getSearchMode()

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

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

Specified by:: getSearchMode in interface SearchJobsRequestOrBuilder

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.v4beta1.RequestMetadata request_metadata = 3;

Specified by:: hasRequestMetadata in interface SearchJobsRequestOrBuilder

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.v4beta1.RequestMetadata request_metadata = 3;

Specified by:: getRequestMetadata in interface SearchJobsRequestOrBuilder

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.v4beta1.RequestMetadata request_metadata = 3;

Specified by:: getRequestMetadataOrBuilder in interface SearchJobsRequestOrBuilder

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

hasJobQuery in interface SearchJobsRequestOrBuilder

getJobQuery

public JobQuery getJobQuery()

 Optional.
 Query used to search against jobs, such as keyword, location filters, etc.

.google.cloud.talent.v4beta1.JobQuery job_query = 4;

Specified by:: getJobQuery in interface SearchJobsRequestOrBuilder

getJobQueryOrBuilder

public JobQueryOrBuilder getJobQueryOrBuilder()

 Optional.
 Query used to search against jobs, such as keyword, location filters, etc.

.google.cloud.talent.v4beta1.JobQuery job_query = 4;

Specified by:: getJobQueryOrBuilder in interface SearchJobsRequestOrBuilder

getEnableBroadening

public boolean getEnableBroadening()

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

getRequirePreciseResultSize

public boolean getRequirePreciseResultSize()

 Optional.
 Controls if the search job request requires the return of a precise
 count of the first 300 results. Setting this to `true` ensures
 consistency in the number of results per page. Best practice is to set this
 value to true if a client allows users to jump directly to a
 non-sequential search results page.
 Enabling this flag may adversely impact performance.
 Defaults to false.

bool require_precise_result_size = 6;

Specified by:: getRequirePreciseResultSize in interface SearchJobsRequestOrBuilder