Class: OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionOutputContent
- Inherits:
-
Object
- Object
- OCI::ComputeInstanceAgent::Models::InstanceAgentCommandExecutionOutputContent
- 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
Direct Known Subclasses
InstanceAgentCommandExecutionOutputViaObjectStorageTupleDetails, InstanceAgentCommandExecutionOutputViaObjectStorageUriDetails, InstanceAgentCommandExecutionOutputViaTextDetails
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
-
#exit_code ⇒ Integer
[Required] The exit code for the command.
-
#message ⇒ String
An optional status message that Oracle Cloud Agent can populate for additional troubleshooting.
-
#output_type ⇒ String
[Required] The output destination type for the command.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.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.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ InstanceAgentCommandExecutionOutputContent
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ InstanceAgentCommandExecutionOutputContent
Initializes the object
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 |
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 89 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. = attributes[:'message'] if attributes[:'message'] end |
Instance Attribute Details
#exit_code ⇒ Integer
[Required] The exit code for the command. Exit code 0
indicates success.
34 35 36 |
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 34 def exit_code @exit_code end |
#message ⇒ String
An optional status message that Oracle Cloud Agent can populate for additional troubleshooting.
39 40 41 |
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 39 def @message end |
#output_type ⇒ String
[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.
30 31 32 |
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 30 def output_type @output_type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
42 43 44 45 46 47 48 49 50 |
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 42 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.
68 69 70 71 72 73 74 75 76 77 |
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 68 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_types ⇒ Object
Attribute type mapping.
53 54 55 56 57 58 59 60 61 |
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 53 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.
130 131 132 133 134 135 136 137 |
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 130 def ==(other) return true if equal?(other) self.class == other.class && output_type == other.output_type && exit_code == other.exit_code && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 162 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
142 143 144 |
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 142 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
151 152 153 |
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 151 def hash [output_type, exit_code, ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
195 196 197 198 199 200 201 202 203 204 |
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 195 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
189 190 191 |
# File 'lib/oci/compute_instance_agent/models/instance_agent_command_execution_output_content.rb', line 189 def to_s to_hash.to_s end |