Class: TalonOne::SelectSelectorStep

Inherits:
ApiModelBase show all
Defined in:
lib/talon_one_sdk/models/select_selector_step.rb

Overview

Picks a subset of the items by count, range, or exact position. The operator determines which additional fields are required: - many selects items from from (start or end) and is limited by count. - between selects items between integer indices from and to. - one selects the single item at index.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ SelectSelectorStep

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 105

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::SelectSelectorStep` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::SelectSelectorStep`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end

  if attributes.key?(:'operator')
    self.operator = attributes[:'operator']
  else
    self.operator = nil
  end

  if attributes.key?(:'from')
    self.from = attributes[:'from']
  end

  if attributes.key?(:'to')
    self.to = attributes[:'to']
  end

  if attributes.key?(:'count')
    self.count = attributes[:'count']
  end

  if attributes.key?(:'index')
    self.index = attributes[:'index']
  end

  if attributes.key?(:'partial')
    self.partial = attributes[:'partial']
  end
end

Instance Attribute Details

#count ⇒ Object

The maximum number of items to select for the many operator.



31
32
33
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 31

def count
  @count
end

#from ⇒ Object

Returns the value of attribute from.



25
26
27
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 25

def from
  @from
end

#index ⇒ Object

The exact position of the item to select for the one operator.



34
35
36
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 34

def index
  @index
end

#operator ⇒ Object

The selection operator applied to the items.



23
24
25
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 23

def operator
  @operator
end

#partial ⇒ Object

Indicates if the step returns fewer items than requested when the source list is shorter than the range needs. Always true for the many and between operators; not present for one, which fails instead of returning a partial result.



37
38
39
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 37

def partial
  @partial
end

#to ⇒ Object

The end index for the between operator. The item at this index is not included.



28
29
30
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 28

def to
  @to
end

#type ⇒ Object

A step discriminator of type select.



20
21
22
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 20

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



75
76
77
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 75

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 80

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 62

def self.attribute_map
  {
    :'type' => :'type',
    :'operator' => :'operator',
    :'from' => :'from',
    :'to' => :'to',
    :'count' => :'count',
    :'index' => :'index',
    :'partial' => :'partial'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 230

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



98
99
100
101
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 98

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 85

def self.openapi_types
  {
    :'type' => :'String',
    :'operator' => :'String',
    :'from' => :'SelectSelectorStepFrom',
    :'to' => :'Integer',
    :'count' => :'Integer',
    :'index' => :'Integer',
    :'partial' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 203

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      operator == o.operator &&
      from == o.from &&
      to == o.to &&
      count == o.count &&
      index == o.index &&
      partial == o.partial
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


217
218
219
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



223
224
225
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 223

def hash
  [type, operator, from, to, count, index, partial].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 154

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @operator.nil?
    invalid_properties.push('invalid value for "operator", operator cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 252

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/talon_one_sdk/models/select_selector_step.rb', line 170

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["select"])
  return false unless type_validator.valid?(@type)
  return false if @operator.nil?
  operator_validator = EnumAttributeValidator.new('String', ["many", "between", "one"])
  return false unless operator_validator.valid?(@operator)
  true
end