Class: IntersightClient::ConnectorCommandControlMessage

Inherits:
ConnectorAuthMessage show all
Defined in:
lib/intersight_client/models/connector_command_control_message.rb

Overview

A Command Message is sent from a cloud service to the connectors command plugin to execute a given command on the platform and begin tunneling input/output to/from the command.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Attributes inherited from ConnectorAuthMessage

#remote_user_locale, #remote_user_name, #remote_user_roles, #remote_user_session_id

Attributes inherited from ConnectorBaseMessage

#encrypted_aes_key, #encryption_key, #secure_properties

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConnectorCommandControlMessage

Initializes the object



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 119

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

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

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'class_id')
    self.class_id = attributes[:'class_id']
  else
    self.class_id = 'connector.CommandControlMessage'
  end

  if attributes.key?(:'object_type')
    self.object_type = attributes[:'object_type']
  else
    self.object_type = 'connector.CommandControlMessage'
  end

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

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

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

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

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

Instance Attribute Details

#class_id ⇒ Object

The fully-qualified name of the instantiated, concrete type. This property is used as a discriminator to identify the type of the payload when marshaling and unmarshaling data.



20
21
22
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 20

def class_id
  @class_id
end

#dir ⇒ Object

The working directory of the command. If empty command is executed in the same directory the device connector process was called.



26
27
28
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 26

def dir
  @dir
end

#msg_type ⇒ Object

Message carrying the operation to perform.



29
30
31
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 29

def msg_type
  @msg_type
end

#object_type ⇒ Object

The fully-qualified name of the instantiated, concrete type. The value should be the same as the ‘ClassId’ property.



23
24
25
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 23

def object_type
  @object_type
end

#stream ⇒ Object

The command to execute. Commands must be whitelisted by platform implementation, if a command does not match any whitelisted command patterns an error will be returned to the requesting service on command start.



32
33
34
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 32

def stream
  @stream
end

#terminal ⇒ Object

Indicates that a pseudo terminal should be attached to the command. Used for interactive commands. e.g A cross launch cli.



35
36
37
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 35

def terminal
  @terminal
end

#timeout ⇒ Object

The timeout for the command to complete and exit after starting or receiving input. If timeout is not set a default of 10 minutes will be used. If there is input to the command stream the timeout is extended.



38
39
40
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 38

def timeout
  @timeout
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns the key-value map of all the JSON attributes this model knows about, including the ones defined in its parent(s)



81
82
83
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 81

def self.acceptable_attribute_map
  attribute_map.merge(superclass.acceptable_attribute_map)
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



76
77
78
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 76

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 63

def self.attribute_map
  {
    :'class_id' => :'ClassId',
    :'object_type' => :'ObjectType',
    :'dir' => :'Dir',
    :'msg_type' => :'MsgType',
    :'stream' => :'Stream',
    :'terminal' => :'Terminal',
    :'timeout' => :'Timeout'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



244
245
246
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 244

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



105
106
107
108
109
110
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 105

def self.openapi_all_of
  [
  :'ConnectorAuthMessage',
  :'ConnectorCommandControlMessageAllOf'
  ]
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



113
114
115
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 113

def self.openapi_discriminator_name
  :'ClassId'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



99
100
101
102
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 99

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 86

def self.openapi_types
  {
    :'class_id' => :'String',
    :'object_type' => :'String',
    :'dir' => :'String',
    :'msg_type' => :'String',
    :'stream' => :'String',
    :'terminal' => :'Boolean',
    :'timeout' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 217

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      class_id == o.class_id &&
      object_type == o.object_type &&
      dir == o.dir &&
      msg_type == o.msg_type &&
      stream == o.stream &&
      terminal == o.terminal &&
      timeout == o.timeout && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 275

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(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
    # models (e.g. Pet) or oneOf
    klass = IntersightClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 346

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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 251

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  ConnectorCommandControlMessage.openapi_types.each_pair do |key, type|
    if attributes[ConnectorCommandControlMessage.attribute_map[key]].nil? && ConnectorCommandControlMessage.openapi_nullable.include?(key)
      self.send("#{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[ConnectorCommandControlMessage.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[ConnectorCommandControlMessage.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[ConnectorCommandControlMessage.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[ConnectorCommandControlMessage.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


231
232
233
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 231

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



237
238
239
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 237

def hash
  [class_id, object_type, dir, msg_type, stream, terminal, timeout].hash
end

#list_invalid_properties ⇒ Object

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



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 170

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

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

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



322
323
324
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 322

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 328

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

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

#to_s ⇒ String

Returns the string representation of the object



316
317
318
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 316

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



185
186
187
188
189
190
191
192
193
 
# File 'lib/intersight_client/models/connector_command_control_message.rb', line 185

def valid?
  return false if @class_id.nil?
  class_id_validator = EnumAttributeValidator.new('String', ["connector.CommandControlMessage"])
  return false unless class_id_validator.valid?(@class_id)
  return false if @object_type.nil?
  object_type_validator = EnumAttributeValidator.new('String', ["connector.CommandControlMessage"])
  return false unless object_type_validator.valid?(@object_type)
  true && super
end