Class: ProtonApi::RiskAllocationRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/models/risk_allocation_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RiskAllocationRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 81

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

  if attributes.has_key?(:'allocation_method')
    self.allocation_method = attributes[:'allocation_method']
  end

  if attributes.has_key?(:'opt_config')
    self.opt_config = attributes[:'opt_config']
  end

  if attributes.has_key?(:'market_data_source')
    self.market_data_source = attributes[:'market_data_source']
  else
    self.market_data_source = 'nucleus'
  end

  if attributes.has_key?(:'risk_score')
    self.risk_score = attributes[:'risk_score']
  end

  if attributes.has_key?(:'use_proxy_data')
    self.use_proxy_data = attributes[:'use_proxy_data']
  else
    self.use_proxy_data = false
  end

  if attributes.has_key?(:'allocations')
    if (value = attributes[:'allocations']).is_a?(Array)
      self.allocations = value
    end
  end
end

Instance Attribute Details

#allocation_method ⇒ Object

Returns the value of attribute allocation_method.



19
20
21
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 19

def allocation_method
  @allocation_method
end

#allocations ⇒ Object

Returns the value of attribute allocations.



29
30
31
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 29

def allocations
  @allocations
end

#client_id ⇒ Object

Returns the value of attribute client_id.



17
18
19
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 17

def client_id
  @client_id
end

#market_data_source ⇒ Object

Returns the value of attribute market_data_source.



23
24
25
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 23

def market_data_source
  @market_data_source
end

#opt_config ⇒ Object

Returns the value of attribute opt_config.



21
22
23
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 21

def opt_config
  @opt_config
end

#risk_score ⇒ Object

Returns the value of attribute risk_score.



25
26
27
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 25

def risk_score
  @risk_score
end

#use_proxy_data ⇒ Object

Returns the value of attribute use_proxy_data.



27
28
29
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 27

def use_proxy_data
  @use_proxy_data
end

Class Method Details

.attribute_map ⇒ Object

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



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 54

def self.attribute_map
  {
    :'client_id' => :'client_id',
    :'allocation_method' => :'allocation_method',
    :'opt_config' => :'opt_config',
    :'market_data_source' => :'market_data_source',
    :'risk_score' => :'risk_score',
    :'use_proxy_data' => :'use_proxy_data',
    :'allocations' => :'allocations'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 67

def self.swagger_types
  {
    :'client_id' => :'String',
    :'allocation_method' => :'String',
    :'opt_config' => :'OptConfig',
    :'market_data_source' => :'String',
    :'risk_score' => :'Float',
    :'use_proxy_data' => :'BOOLEAN',
    :'allocations' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 190

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      client_id == o.client_id &&
      allocation_method == o.allocation_method &&
      opt_config == o.opt_config &&
      market_data_source == o.market_data_source &&
      risk_score == o.risk_score &&
      use_proxy_data == o.use_proxy_data &&
      allocations == o.allocations
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 237

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    value
  when :Date
    value
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = ProtonApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 301

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 217

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if 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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


204
205
206
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



210
211
212
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 210

def hash
  [client_id, allocation_method, opt_config, market_data_source, risk_score, use_proxy_data, allocations].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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 124

def list_invalid_properties
  invalid_properties = Array.new
  if @allocation_method.nil?
    invalid_properties.push('invalid value for "allocation_method", allocation_method cannot be nil.')
  end

  if !@risk_score.nil? && @risk_score > 100
    invalid_properties.push('invalid value for "risk_score", must be smaller than or equal to 100.')
  end

  if !@risk_score.nil? && @risk_score < 0
    invalid_properties.push('invalid value for "risk_score", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



282
283
284
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 282

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



288
289
290
291
292
293
294
295
296
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 288

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns String presentation of the object.

Returns:

  • (String) —

    String presentation of the object



276
277
278
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 276

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



143
144
145
146
147
148
149
150
151
152
 
# File 'lib/proton_api/models/risk_allocation_request.rb', line 143

def valid?
  return false if @allocation_method.nil?
  allocation_method_validator = EnumAttributeValidator.new('String', ['select', 'create'])
  return false unless allocation_method_validator.valid?(@allocation_method)
  market_data_source_validator = EnumAttributeValidator.new('String', ['nucleus', 'integration'])
  return false unless market_data_source_validator.valid?(@market_data_source)
  return false if !@risk_score.nil? && @risk_score > 100
  return false if !@risk_score.nil? && @risk_score < 0
  true
end