Class: GetStream::Generated::Models::RankingConfig

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/getstream_ruby/generated/models/ranking_config.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#==, #inspect, omit_empty_fields, #to_h, #to_json

Constructor Details

#initialize(attributes = {}) ⇒ RankingConfig

Initialize with attributes



26
27
28
29
30
31
32
 
# File 'lib/getstream_ruby/generated/models/ranking_config.rb', line 26

def initialize(attributes = {})
  super(attributes)
  @type = attributes[:type] || attributes['type']
  @score = attributes[:score] || attributes['score'] || nil
  @defaults = attributes[:defaults] || attributes['defaults'] || nil
  @functions = attributes[:functions] || attributes['functions'] || nil
end

Instance Attribute Details

#defaults ⇒ Object

Returns Default values for ranking.

Returns:

  • (Object) —

    Default values for ranking



20
21
22
 
# File 'lib/getstream_ruby/generated/models/ranking_config.rb', line 20

def defaults
  @defaults
end

#functions ⇒ Hash<String, DecayFunctionConfig>

Returns Decay functions configuration.

Returns:



23
24
25
 
# File 'lib/getstream_ruby/generated/models/ranking_config.rb', line 23

def functions
  @functions
end

#score ⇒ String

Returns Scoring formula. Required when type is ‘expression’ or ‘interest’.

Returns:

  • (String) —

    Scoring formula. Required when type is ‘expression’ or ‘interest’



17
18
19
 
# File 'lib/getstream_ruby/generated/models/ranking_config.rb', line 17

def score
  @score
end

#type ⇒ String

Returns Type of ranking algorithm. Required. Must be one of: recency, expression, interest.

Returns:

  • (String) —

    Type of ranking algorithm. Required. Must be one of: recency, expression, interest



14
15
16
 
# File 'lib/getstream_ruby/generated/models/ranking_config.rb', line 14

def type
  @type
end

Class Method Details

.json_field_mappings ⇒ Object

Override field mappings for JSON serialization



35
36
37
38
39
40
41
42
 
# File 'lib/getstream_ruby/generated/models/ranking_config.rb', line 35

def self.json_field_mappings
  {
    type: 'type',
    score: 'score',
    defaults: 'defaults',
    functions: 'functions'
  }
end