Class SearchJobsRequest.CustomRankingInfo

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.talent.v4.SearchJobsRequest.CustomRankingInfo
All Implemented Interfaces:
SearchJobsRequest.CustomRankingInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
SearchJobsRequest

public static final class SearchJobsRequest.CustomRankingInfo extends com.google.protobuf.GeneratedMessage implements SearchJobsRequest.CustomRankingInfoOrBuilder
 Custom ranking information for
 [SearchJobsRequest][google.cloud.talent.v4.SearchJobsRequest].
 
Protobuf type google.cloud.talent.v4.SearchJobsRequest.CustomRankingInfo
See Also:
  • Field Details

    • IMPORTANCE_LEVEL_FIELD_NUMBER

      public static final int IMPORTANCE_LEVEL_FIELD_NUMBER
      See Also:
    • RANKING_EXPRESSION_FIELD_NUMBER

      public static final int RANKING_EXPRESSION_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getImportanceLevelValue

      public 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];
      Specified by:
      getImportanceLevelValue in interface SearchJobsRequest.CustomRankingInfoOrBuilder
      Returns:
      The enum numeric value on the wire for 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];
      Specified by:
      getImportanceLevel in interface SearchJobsRequest.CustomRankingInfoOrBuilder
      Returns:
      The 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][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];
      Specified by:
      getRankingExpression in interface SearchJobsRequest.CustomRankingInfoOrBuilder
      Returns:
      The rankingExpression.
    • getRankingExpressionBytes

      public com.google.protobuf.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];
      Specified by:
      getRankingExpressionBytes in interface SearchJobsRequest.CustomRankingInfoOrBuilder
      Returns:
      The bytes for rankingExpression.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static SearchJobsRequest.CustomRankingInfo parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchJobsRequest.CustomRankingInfo parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchJobsRequest.CustomRankingInfo parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchJobsRequest.CustomRankingInfo parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchJobsRequest.CustomRankingInfo parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchJobsRequest.CustomRankingInfo parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchJobsRequest.CustomRankingInfo parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchJobsRequest.CustomRankingInfo parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static SearchJobsRequest.CustomRankingInfo parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static SearchJobsRequest.CustomRankingInfo parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchJobsRequest.CustomRankingInfo parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static SearchJobsRequest.CustomRankingInfo parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public SearchJobsRequest.CustomRankingInfo.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static SearchJobsRequest.CustomRankingInfo.Builder newBuilder()
    • newBuilder

    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected SearchJobsRequest.CustomRankingInfo.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static SearchJobsRequest.CustomRankingInfo getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<SearchJobsRequest.CustomRankingInfo> parser()
    • getParserForType

      public com.google.protobuf.Parser<SearchJobsRequest.CustomRankingInfo> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public SearchJobsRequest.CustomRankingInfo getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder