Class: Google::Apis::CloudsearchV1::EnterpriseTopazSidekickRankingParams

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudsearch_v1/classes.rb,
lib/google/apis/cloudsearch_v1/representations.rb,
lib/google/apis/cloudsearch_v1/representations.rb

Overview

Ranking params.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ EnterpriseTopazSidekickRankingParams

Returns a new instance of EnterpriseTopazSidekickRankingParams.



2924
2925
2926
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2924

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

Instance Attribute Details

#end_time_ms ⇒ Fixnum

The end-time that this object will expect to occur. If the type is marked as FIXED, then this end-time will persist after bidding. If the type is marked as FLEXIBLE, this field is NOT expected to be filled and will be filled in after it has won a bid. Expected to be set when type is set to FIXED. Corresponds to the JSON property endTimeMs

Returns:

  • (Fixnum) 


2891
2892
2893
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2891

def end_time_ms
  @end_time_ms
end

#priority ⇒ String

The priority to determine between objects that have the same start_time_ms The lower-value of priority == ranked higher. Max-priority = 0. Expected to be set for all types. Corresponds to the JSON property priority

Returns:

  • (String) 


2898
2899
2900
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2898

def priority
  @priority
end

#score ⇒ Float

The score of the card to be used to break priority-ties Corresponds to the JSON property score

Returns:

  • (Float) 


2903
2904
2905
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2903

def score
  @score
end

#span_ms ⇒ Fixnum

The span that this card will take in the stream Expected to be set when type is set to FLEXIBLE. Corresponds to the JSON property spanMs

Returns:

  • (Fixnum) 


2909
2910
2911
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2909

def span_ms
  @span_ms
end

#start_time_ms ⇒ Fixnum

The start-time that this object will bid-for If the type is marked as FIXED, then this start-time will persist after bidding. If the type is marked as FLEXIBLE, then it will occur at the given time or sometime after the requested time. Expected to be set for all types. Corresponds to the JSON property startTimeMs

Returns:

  • (Fixnum) 


2917
2918
2919
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2917

def start_time_ms
  @start_time_ms
end

#type ⇒ String

The packing type of this object. Corresponds to the JSON property type

Returns:

  • (String) 


2922
2923
2924
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2922

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2929
2930
2931
2932
2933
2934
2935
2936
 
# File 'lib/google/apis/cloudsearch_v1/classes.rb', line 2929

def update!(**args)
  @end_time_ms = args[:end_time_ms] if args.key?(:end_time_ms)
  @priority = args[:priority] if args.key?(:priority)
  @score = args[:score] if args.key?(:score)
  @span_ms = args[:span_ms] if args.key?(:span_ms)
  @start_time_ms = args[:start_time_ms] if args.key?(:start_time_ms)
  @type = args[:type] if args.key?(:type)
end