Class: OCI::ComputeInstanceAgent::Models::InstanceAgentCommand

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

Overview

The command payload.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstanceAgentCommand

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 102

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  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.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.is_canceled = attributes[:'isCanceled'] unless attributes[:'isCanceled'].nil?
  self.is_canceled = false if is_canceled.nil? && !attributes.key?(:'isCanceled') # rubocop:disable Style/StringLiterals

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

  self.is_canceled = attributes[:'is_canceled'] unless attributes[:'is_canceled'].nil?
  self.is_canceled = false if is_canceled.nil? && !attributes.key?(:'isCanceled') && !attributes.key?(:'is_canceled') # rubocop:disable Style/StringLiterals

  self.execution_time_out_in_seconds = attributes[:'executionTimeOutInSeconds'] if attributes[:'executionTimeOutInSeconds']

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

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the command.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 17

def compartment_id
  @compartment_id
end

#content ⇒ OCI::ComputeInstanceAgent::Models::InstanceAgentCommandContent

[Required] The contents of the command.

Returns:



51
52
53
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 51

def content
  @content
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique. Avoid entering confidential information.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 21

def display_name
  @display_name
end

#execution_time_out_in_seconds ⇒ Integer

The amount of time that Oracle Cloud Agent is given to run the command on the instance before timing out. The timer starts when Oracle Cloud Agent starts the command. Zero means no timeout.

Returns:

  • (Integer) 


43
44
45
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 43

def execution_time_out_in_seconds
  @execution_time_out_in_seconds
end

#id ⇒ String

[Required] The OCID of the command.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 13

def id
  @id
end

#is_canceled ⇒ BOOLEAN

Whether a request was made to cancel the command. Canceling a command is a best-effort attempt.

Returns:

  • (BOOLEAN) 


37
38
39
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 37

def is_canceled
  @is_canceled
end

#target ⇒ OCI::ComputeInstanceAgent::Models::InstanceAgentCommandTarget

[Required] The target instance that the command runs on.

Returns:



47
48
49
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 47

def target
  @target
end

#time_created ⇒ DateTime

The date and time the command was created, in the format defined by RFC3339.

Returns:

  • (DateTime) 


27
28
29
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 27

def time_created
  @time_created
end

#time_updated ⇒ DateTime

The date and time the command was last updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


33
34
35
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 33

def time_updated
  @time_updated
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
65
66
67
68
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 54

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'is_canceled': :'isCanceled',
    'execution_time_out_in_seconds': :'executionTimeOutInSeconds',
    'target': :'target',
    'content': :'content'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 71

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'is_canceled': :'BOOLEAN',
    'execution_time_out_in_seconds': :'Integer',
    'target': :'OCI::ComputeInstanceAgent::Models::InstanceAgentCommandTarget',
    'content': :'OCI::ComputeInstanceAgent::Models::InstanceAgentCommandContent'
    # 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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 160

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    is_canceled == other.is_canceled &&
    execution_time_out_in_seconds == other.execution_time_out_in_seconds &&
    target == other.target &&
    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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 198

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


178
179
180
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 178

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



187
188
189
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 187

def hash
  [id, compartment_id, display_name, time_created, time_updated, is_canceled, execution_time_out_in_seconds, target, content].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



231
232
233
234
235
236
237
238
239
240
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 231

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



225
226
227
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_command.rb', line 225

def to_s
  to_hash.to_s
end