Class: OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionOutputContent

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

Overview

The execution output from a command. 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

OUTPUT_TYPE_ENUM =
[
  OUTPUT_TYPE_TEXT = 'TEXT'.freeze,
  OUTPUT_TYPE_OBJECT_STORAGE_URI = 'OBJECT_STORAGE_URI'.freeze,
  OUTPUT_TYPE_OBJECT_STORAGE_TUPLE = 'OBJECT_STORAGE_TUPLE'.freeze,
  OUTPUT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstanceAgentCommandExecutionOutputContent

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :output_type (String)

    The value to assign to the #output_type property

  • :exit_code (Integer)

    The value to assign to the #exit_code property

  • :message (String)

    The value to assign to the #message property



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 88

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

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

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

  self.exit_code = attributes[:'exitCode'] if attributes[:'exitCode']

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

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

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

Instance Attribute Details

#exit_codeInteger

[Required] The exit code for the command. Exit code 0 indicates success.

Returns:

  • (Integer)


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

def exit_code
  @exit_code
end

#messageString

An optional status message that Oracle Cloud Agent can populate for additional troubleshooting.

Returns:

  • (String)


38
39
40
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 38

def message
  @message
end

#output_typeString

[Required] The output destination type for the command. The following values are supported:

  • TEXT - the command output is returned as plain text.

  • OBJECT_STORAGE_URI - the command output is saved to an Object Storage URL.

  • OBJECT_STORAGE_TUPLE - the command output is saved to an Object Storage bucket.

For background information about Object Storage buckets and URLs, see Overview of Object Storage.

Returns:

  • (String)


29
30
31
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 29

def output_type
  @output_type
end

Class Method Details

.attribute_mapObject

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



41
42
43
44
45
46
47
48
49
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 41

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'output_type': :'outputType',
    'exit_code': :'exitCode',
    'message': :'message'
    # 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.



67
68
69
70
71
72
73
74
75
76
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 67

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

  return 'OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionOutputViaTextDetails' if type == 'TEXT'
  return 'OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails' if type == 'OBJECT_STORAGE_URI'
  return 'OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails' if type == 'OBJECT_STORAGE_TUPLE'

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

.swagger_typesObject

Attribute type mapping.



52
53
54
55
56
57
58
59
60
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 52

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'output_type': :'String',
    'exit_code': :'Integer',
    'message': :'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



129
130
131
132
133
134
135
136
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 129

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

  self.class == other.class &&
    output_type == other.output_type &&
    exit_code == other.exit_code &&
    message == other.message
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



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_output_content.rb', line 161

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


141
142
143
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 141

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



150
151
152
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 150

def hash
  [output_type, exit_code, message].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



194
195
196
197
198
199
200
201
202
203
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 194

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



188
189
190
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 188

def to_s
  to_hash.to_s
end