class OCI::ComputeInstanceAgent::Models::InstanceAgentCommand

The command payload.

Attributes

compartment_id[RW]

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment containing the command. @return [String]

content[RW]

[Required] The contents of the command. @return [OCI::ComputeInstanceAgent::Models::InstanceAgentCommandContent]

display_name[RW]

A user-friendly name. Does not have to be unique. Avoid entering confidential information. @return [String]

execution_time_out_in_seconds[RW]

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.

@return [Integer]

id[RW]

[Required] The [OCID](docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the command. @return [String]

is_canceled[RW]

Whether a request was made to cancel the command. Canceling a command is a best-effort attempt. @return [BOOLEAN]

target[RW]

[Required] The target instance that the command runs on. @return [OCI::ComputeInstanceAgent::Models::InstanceAgentCommandTarget]

time_created[RW]

The date and time the command was created, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339).

@return [DateTime]

time_updated[RW]

The date and time the command was last updated, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339).

@return [DateTime]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/compute_instance_agent/models/instance_agent_command.rb, line 53
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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_updated The value to assign to the {#time_updated} property @option attributes [BOOLEAN] :is_canceled The value to assign to the {#is_canceled} property @option attributes [Integer] :execution_time_out_in_seconds The value to assign to the {#execution_time_out_in_seconds} property @option attributes [OCI::ComputeInstanceAgent::Models::InstanceAgentCommandTarget] :target The value to assign to the {#target} property @option attributes [OCI::ComputeInstanceAgent::Models::InstanceAgentCommandContent] :content The value to assign to the {#content} property

# File lib/oci/compute_instance_agent/models/instance_agent_command.rb, line 101
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
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/compute_instance_agent/models/instance_agent_command.rb, line 70
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

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/compute_instance_agent/models/instance_agent_command.rb, line 159
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/compute_instance_agent/models/instance_agent_command.rb, line 197
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/compute_instance_agent/models/instance_agent_command.rb, line 177
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/compute_instance_agent/models/instance_agent_command.rb, line 186
def hash
  [id, compartment_id, display_name, time_created, time_updated, is_canceled, execution_time_out_in_seconds, target, content].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/compute_instance_agent/models/instance_agent_command.rb, line 230
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/compute_instance_agent/models/instance_agent_command.rb, line 224
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/compute_instance_agent/models/instance_agent_command.rb, line 247
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