com.google.cloud.talent.v4

Interface SearchJobsRequest.CustomRankingInfoOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

SearchJobsRequest.CustomRankingInfo, SearchJobsRequest.CustomRankingInfo.Builder

Enclosing class:

SearchJobsRequest

public static interface SearchJobsRequest.CustomRankingInfoOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
SearchJobsRequest.CustomRankingInfo.ImportanceLevel	getImportanceLevel() Required.
int	getImportanceLevelValue() Required.
String	getRankingExpression() Required.
ByteString	getRankingExpressionBytes() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getImportanceLevelValue

int getImportanceLevelValue()

 Required. Controls over how important the score of
 [CustomRankingInfo.ranking_expression][google.cloud.talent.v4.SearchJobsRequest.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:

The enum numeric value on the wire for importanceLevel.

getImportanceLevel

SearchJobsRequest.CustomRankingInfo.ImportanceLevel getImportanceLevel()

 Required. Controls over how important the score of
 [CustomRankingInfo.ranking_expression][google.cloud.talent.v4.SearchJobsRequest.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:

The importanceLevel.

getRankingExpression

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][google.cloud.talent.v4.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:

The rankingExpression.

getRankingExpressionBytes

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][google.cloud.talent.v4.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:

The bytes for rankingExpression.