Class SearchJobsRequest.CustomRankingInfo.Builder (2.38.0)

public static final class SearchJobsRequest.CustomRankingInfo.Builder extends GeneratedMessageV3.Builder<SearchJobsRequest.CustomRankingInfo.Builder> implements SearchJobsRequest.CustomRankingInfoOrBuilder

Custom ranking information for SearchJobsRequest.

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchJobsRequest.CustomRankingInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder
Overrides

build()

public SearchJobsRequest.CustomRankingInfo build()
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo

buildPartial()

public SearchJobsRequest.CustomRankingInfo buildPartial()
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo

clear()

public SearchJobsRequest.CustomRankingInfo.Builder clear()
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public SearchJobsRequest.CustomRankingInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder
Overrides

clearImportanceLevel()

public SearchJobsRequest.CustomRankingInfo.Builder clearImportanceLevel()

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
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchJobsRequest.CustomRankingInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder
Overrides

clearRankingExpression()

public SearchJobsRequest.CustomRankingInfo.Builder clearRankingExpression()

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
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder

This builder for chaining.

clone()

public SearchJobsRequest.CustomRankingInfo.Builder clone()
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder
Overrides

getDefaultInstanceForType()

public SearchJobsRequest.CustomRankingInfo getDefaultInstanceForType()
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for importanceLevel.

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
TypeDescription
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
TypeDescription
ByteString

The bytes for rankingExpression.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchJobsRequest.CustomRankingInfo other)

public SearchJobsRequest.CustomRankingInfo.Builder mergeFrom(SearchJobsRequest.CustomRankingInfo other)
Parameter
NameDescription
otherSearchJobsRequest.CustomRankingInfo
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchJobsRequest.CustomRankingInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SearchJobsRequest.CustomRankingInfo.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchJobsRequest.CustomRankingInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public SearchJobsRequest.CustomRankingInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder
Overrides

setImportanceLevel(SearchJobsRequest.CustomRankingInfo.ImportanceLevel value)

public SearchJobsRequest.CustomRankingInfo.Builder setImportanceLevel(SearchJobsRequest.CustomRankingInfo.ImportanceLevel value)

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];

Parameter
NameDescription
valueSearchJobsRequest.CustomRankingInfo.ImportanceLevel

The importanceLevel to set.

Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder

This builder for chaining.

setImportanceLevelValue(int value)

public SearchJobsRequest.CustomRankingInfo.Builder setImportanceLevelValue(int value)

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];

Parameter
NameDescription
valueint

The enum numeric value on the wire for importanceLevel to set.

Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder

This builder for chaining.

setRankingExpression(String value)

public SearchJobsRequest.CustomRankingInfo.Builder setRankingExpression(String value)

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];

Parameter
NameDescription
valueString

The rankingExpression to set.

Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder

This builder for chaining.

setRankingExpressionBytes(ByteString value)

public SearchJobsRequest.CustomRankingInfo.Builder setRankingExpressionBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for rankingExpression to set.

Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchJobsRequest.CustomRankingInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchJobsRequest.CustomRankingInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
SearchJobsRequest.CustomRankingInfo.Builder
Overrides