Class: OCI::Iot::Models::InvokeRawCommandDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/iot/models/invoke_raw_command_details.rb

Overview

Definition of unstructured command invocation payload This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

REQUEST_DATA_FORMAT_ENUM = 
[
  REQUEST_DATA_FORMAT_TEXT = 'TEXT'.freeze,
  REQUEST_DATA_FORMAT_JSON = 'JSON'.freeze,
  REQUEST_DATA_FORMAT_BINARY = 'BINARY'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InvokeRawCommandDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
121
122
123
124
125
126
127
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 92

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 }

  self.request_duration = attributes[:'requestDuration'] if attributes[:'requestDuration']

  raise 'You cannot provide both :requestDuration and :request_duration' if attributes.key?(:'requestDuration') && attributes.key?(:'request_duration')

  self.request_duration = attributes[:'request_duration'] if attributes[:'request_duration']

  self.response_duration = attributes[:'responseDuration'] if attributes[:'responseDuration']

  raise 'You cannot provide both :responseDuration and :response_duration' if attributes.key?(:'responseDuration') && attributes.key?(:'response_duration')

  self.response_duration = attributes[:'response_duration'] if attributes[:'response_duration']

  self.request_endpoint = attributes[:'requestEndpoint'] if attributes[:'requestEndpoint']

  raise 'You cannot provide both :requestEndpoint and :request_endpoint' if attributes.key?(:'requestEndpoint') && attributes.key?(:'request_endpoint')

  self.request_endpoint = attributes[:'request_endpoint'] if attributes[:'request_endpoint']

  self.response_endpoint = attributes[:'responseEndpoint'] if attributes[:'responseEndpoint']

  raise 'You cannot provide both :responseEndpoint and :response_endpoint' if attributes.key?(:'responseEndpoint') && attributes.key?(:'response_endpoint')

  self.response_endpoint = attributes[:'response_endpoint'] if attributes[:'response_endpoint']

  self.request_data_format = attributes[:'requestDataFormat'] if attributes[:'requestDataFormat']

  raise 'You cannot provide both :requestDataFormat and :request_data_format' if attributes.key?(:'requestDataFormat') && attributes.key?(:'request_data_format')

  self.request_data_format = attributes[:'request_data_format'] if attributes[:'request_data_format']
end

Instance Attribute Details

#request_data_format ⇒ String

[Required] data format: json, binary, text

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 36

def request_data_format
  @request_data_format
end

#request_duration ⇒ String

Specified duration by which to send the request by.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 20

def request_duration
  @request_duration
end

#request_endpoint ⇒ String

[Required] Device endpoint where request should be forwarded to.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 28

def request_endpoint
  @request_endpoint
end

#response_duration ⇒ String

Specified duration by which to receive the response by.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 24

def response_duration
  @response_duration
end

#response_endpoint ⇒ String

Device endpoint from which response is expected to come.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 32

def response_endpoint
  @response_endpoint
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 39

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'request_duration': :'requestDuration',
    'response_duration': :'responseDuration',
    'request_endpoint': :'requestEndpoint',
    'response_endpoint': :'responseEndpoint',
    'request_data_format': :'requestDataFormat'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 69

def self.get_subtype(object_hash)
  type = object_hash[:'requestDataFormat'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Iot::Models::InvokeRawBinaryCommandDetails' if type == 'BINARY'
  return 'OCI::Iot::Models::InvokeRawTextCommandDetails' if type == 'TEXT'
  return 'OCI::Iot::Models::InvokeRawJsonCommandDetails' if type == 'JSON'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Iot::Models::InvokeRawCommandDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 52

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'request_duration': :'String',
    'response_duration': :'String',
    'request_endpoint': :'String',
    'response_endpoint': :'String',
    'request_data_format': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 144

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    request_duration == other.request_duration &&
    response_duration == other.response_duration &&
    request_endpoint == other.request_endpoint &&
    response_endpoint == other.response_endpoint &&
    request_data_format == other.request_data_format
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



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 178

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(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?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


158
159
160
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 158

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



167
168
169
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 167

def hash
  [request_duration, response_duration, request_endpoint, response_endpoint, request_data_format].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 211

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



205
206
207
 
# File 'lib/oci/iot/models/invoke_raw_command_details.rb', line 205

def to_s
  to_hash.to_s
end