Class: Google::Apis::JobsV3p1beta1::CustomRankingInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/jobs_v3p1beta1/classes.rb,
generated/google/apis/jobs_v3p1beta1/representations.rb,
generated/google/apis/jobs_v3p1beta1/representations.rb

Overview

Input only. Custom ranking information for SearchJobsRequest.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CustomRankingInfo

Returns a new instance of CustomRankingInfo



979
980
981
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 979

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#importance_level ⇒ String

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. Corresponds to the JSON property importanceLevel

Returns:

  • (String) 


961
962
963
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 961

def importance_level
  @importance_level
end

#ranking_expression ⇒ String

Required. Controls over how job documents get ranked on top of existing relevance score (determined by API algorithm). The product of 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 < 100 characters in length. Sample ranking expression (year + 25) * 0.25 - (freshness / 0.5) Corresponds to the JSON property rankingExpression

Returns:

  • (String) 


977
978
979
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 977

def ranking_expression
  @ranking_expression
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



984
985
986
987
 
# File 'generated/google/apis/jobs_v3p1beta1/classes.rb', line 984

def update!(**args)
  @importance_level = args[:importance_level] if args.key?(:importance_level)
  @ranking_expression = args[:ranking_expression] if args.key?(:ranking_expression)
end