Class: OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecution

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb

Overview

A command’s execution summary.

Constant Summary collapse

DELIVERY_STATE_ENUM = 
[
  DELIVERY_STATE_VISIBLE = 'VISIBLE'.freeze,
  DELIVERY_STATE_PENDING = 'PENDING'.freeze,
  DELIVERY_STATE_ACKED = 'ACKED'.freeze,
  DELIVERY_STATE_ACKED_CANCELED = 'ACKED_CANCELED'.freeze,
  DELIVERY_STATE_EXPIRED = 'EXPIRED'.freeze,
  DELIVERY_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_TIMED_OUT = 'TIMED_OUT'.freeze,
  LIFECYCLE_STATE_CANCELED = 'CANCELED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstanceAgentCommandExecution

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 128

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.instance_agent_command_id = attributes[:'instanceAgentCommandId'] if attributes[:'instanceAgentCommandId']

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

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

  self.instance_id = attributes[:'instanceId'] if attributes[:'instanceId']

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

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

  self.delivery_state = attributes[:'deliveryState'] if attributes[:'deliveryState']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.sequence_number = attributes[:'sequenceNumber'] if attributes[:'sequenceNumber']

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

Instance Attribute Details

#content ⇒ OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionOutputContent

This attribute is required.

Returns:



77
78
79
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 77

def content
  @content
end

#delivery_state ⇒ String

[Required] Specifies the command delivery state.

* `VISIBLE` - The command is visible to instance.
* `PENDING` - The command is pending ack from the instance.
* `ACKED` - The command has been received and acked by the instance.
* `ACKED_CANCELED` - The canceled command has been received and acked by the instance.
* `EXPIRED` - The instance has not requested for commands and its delivery has expired.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 46

def delivery_state
  @delivery_state
end

#display_name ⇒ String

The user friendly display name of the command.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 73

def display_name
  @display_name
end

#instance_agent_command_id ⇒ String

[Required] The OCID of the command

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 32

def instance_agent_command_id
  @instance_agent_command_id
end

#instance_id ⇒ String

[Required] The OCID of the instance

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 36

def instance_id
  @instance_id
end

#lifecycle_state ⇒ String

[Required] command execution life cycle state.

  • ACCEPTED - The command execution has been accepted to run.

  • IN_PROGRESS - The command execution is in progress.

  • SUCCEEDED - The command execution is successful.

  • FAILED - The command execution has failed.

  • TIMED_OUT - The command execution has timedout.

  • CANCELED - The command execution has canceled.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 57

def lifecycle_state
  @lifecycle_state
end

#sequence_number ⇒ Integer

[Required] The large non-consecutive number that Run Command Service assigns to each created command.

Returns:

  • (Integer) 


69
70
71
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 69

def sequence_number
  @sequence_number
end

#time_created ⇒ DateTime

[Required] The command creation date

Returns:

  • (DateTime) 


61
62
63
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 61

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The command last updated at date.

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 65

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 80

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'instance_agent_command_id': :'instanceAgentCommandId',
    'instance_id': :'instanceId',
    'delivery_state': :'deliveryState',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'sequence_number': :'sequenceNumber',
    'display_name': :'displayName',
    'content': :'content'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 97

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'instance_agent_command_id': :'String',
    'instance_id': :'String',
    'delivery_state': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'sequence_number': :'Integer',
    'display_name': :'String',
    'content': :'OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionOutputContent'
    # 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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 218

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

  self.class == other.class &&
    instance_agent_command_id == other.instance_agent_command_id &&
    instance_id == other.instance_id &&
    delivery_state == other.delivery_state &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    sequence_number == other.sequence_number &&
    display_name == other.display_name &&
    content == other.content
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 256

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


236
237
238
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 236

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



245
246
247
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 245

def hash
  [instance_agent_command_id, instance_id, delivery_state, lifecycle_state, time_created, time_updated, sequence_number, display_name, content].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



289
290
291
292
293
294
295
296
297
298
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 289

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



283
284
285
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution.rb', line 283

def to_s
  to_hash.to_s
end