Class SearchJobsRequest.CustomRankingInfo (2.45.0)

public static final class SearchJobsRequest.CustomRankingInfo extends GeneratedMessageV3 implements SearchJobsRequest.CustomRankingInfoOrBuilder

Custom ranking information for SearchJobsRequest.

Protobuf type google.cloud.talent.v4.SearchJobsRequest.CustomRankingInfo

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SearchJobsRequest.CustomRankingInfo

Static Fields

IMPORTANCE_LEVEL_FIELD_NUMBER

public static final int IMPORTANCE_LEVEL_FIELD_NUMBER
Field Value
Type Description
int

RANKING_EXPRESSION_FIELD_NUMBER

public static final int RANKING_EXPRESSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchJobsRequest.CustomRankingInfo getDefaultInstance()
Returns
Type Description
SearchJobsRequest.CustomRankingInfo

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchJobsRequest.CustomRankingInfo.Builder newBuilder()
Returns
Type Description
SearchJobsRequest.CustomRankingInfo.Builder

newBuilder(SearchJobsRequest.CustomRankingInfo prototype)

public static SearchJobsRequest.CustomRankingInfo.Builder newBuilder(SearchJobsRequest.CustomRankingInfo prototype)
Parameter
Name Description
prototype SearchJobsRequest.CustomRankingInfo
Returns
Type Description
SearchJobsRequest.CustomRankingInfo.Builder

parseDelimitedFrom(InputStream input)

public static SearchJobsRequest.CustomRankingInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchJobsRequest.CustomRankingInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchJobsRequest.CustomRankingInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchJobsRequest.CustomRankingInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchJobsRequest.CustomRankingInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchJobsRequest.CustomRankingInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchJobsRequest.CustomRankingInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchJobsRequest.CustomRankingInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchJobsRequest.CustomRankingInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchJobsRequest.CustomRankingInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchJobsRequest.CustomRankingInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchJobsRequest.CustomRankingInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchJobsRequest.CustomRankingInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchJobsRequest.CustomRankingInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchJobsRequest.CustomRankingInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchJobsRequest.CustomRankingInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchJobsRequest.CustomRankingInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchJobsRequest.CustomRankingInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchJobsRequest.CustomRankingInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchJobsRequest.CustomRankingInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchJobsRequest.CustomRankingInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchJobsRequest.CustomRankingInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchJobsRequest.CustomRankingInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchJobsRequest.CustomRankingInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchJobsRequest.CustomRankingInfo> parser()
Returns
Type Description
Parser<CustomRankingInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchJobsRequest.CustomRankingInfo getDefaultInstanceForType()
Returns
Type Description
SearchJobsRequest.CustomRankingInfo

getImportanceLevel()

public SearchJobsRequest.CustomRankingInfo.ImportanceLevel getImportanceLevel()

Required. Controls over how important the score of CustomRankingInfo.ranking_expression gets applied to job's final ranking position.

An error is thrown if not specified.

.google.cloud.talent.v4.SearchJobsRequest.CustomRankingInfo.ImportanceLevel importance_level = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SearchJobsRequest.CustomRankingInfo.ImportanceLevel

The importanceLevel.

getImportanceLevelValue()

public int getImportanceLevelValue()

Required. Controls over how important the score of CustomRankingInfo.ranking_expression gets applied to job's final ranking position.

An error is thrown if not specified.

.google.cloud.talent.v4.SearchJobsRequest.CustomRankingInfo.ImportanceLevel importance_level = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for importanceLevel.

getParserForType()

public Parser<SearchJobsRequest.CustomRankingInfo> getParserForType()
Returns
Type Description
Parser<CustomRankingInfo>
Overrides

getRankingExpression()

public String getRankingExpression()

Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). A combination of the ranking expression and relevance score is used to determine job's final ranking position.

The syntax for this expression is a subset of Google SQL syntax.

Supported operators are: +, -, *, /, where the left and right side of the operator is either a numeric Job.custom_attributes key, integer/double value or an expression that can be evaluated to a number.

Parenthesis are supported to adjust calculation precedence. The expression must be < 200 characters in length.

The expression is considered invalid for a job if the expression references custom attributes that are not populated on the job or if the expression results in a divide by zero. If an expression is invalid for a job, that job is demoted to the end of the results.

Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5)

string ranking_expression = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The rankingExpression.

getRankingExpressionBytes()

public ByteString getRankingExpressionBytes()

Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). A combination of the ranking expression and relevance score is used to determine job's final ranking position.

The syntax for this expression is a subset of Google SQL syntax.

Supported operators are: +, -, *, /, where the left and right side of the operator is either a numeric Job.custom_attributes key, integer/double value or an expression that can be evaluated to a number.

Parenthesis are supported to adjust calculation precedence. The expression must be < 200 characters in length.

The expression is considered invalid for a job if the expression references custom attributes that are not populated on the job or if the expression results in a divide by zero. If an expression is invalid for a job, that job is demoted to the end of the results.

Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5)

string ranking_expression = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for rankingExpression.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchJobsRequest.CustomRankingInfo.Builder newBuilderForType()
Returns
Type Description
SearchJobsRequest.CustomRankingInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchJobsRequest.CustomRankingInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchJobsRequest.CustomRankingInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchJobsRequest.CustomRankingInfo.Builder toBuilder()
Returns
Type Description
SearchJobsRequest.CustomRankingInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException