class OCI::ComputeInstanceAgent::Models::InstanceAgentCommandOutputDetails
The output destination for the 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
Constants
- OUTPUT_TYPE_ENUM
Attributes
[Required] The output 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](docs.cloud.oracle.com/Content/Object/Concepts/objectstorageoverview.htm).
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/compute_instance_agent/models/instance_agent_command_output_details.rb, line 32 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'output_type': :'outputType' # rubocop:enable Style/SymbolLiteral } end
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
# File lib/oci/compute_instance_agent/models/instance_agent_command_output_details.rb, line 54 def self.get_subtype(object_hash) type = object_hash[:'outputType'] # rubocop:disable Style/SymbolLiteral return 'OCI::ComputeInstanceAgent::Models::InstanceAgentCommandOutputViaObjectStorageUriDetails' if type == 'OBJECT_STORAGE_URI' return 'OCI::ComputeInstanceAgent::Models::InstanceAgentCommandOutputViaObjectStorageTupleDetails' if type == 'OBJECT_STORAGE_TUPLE' return 'OCI::ComputeInstanceAgent::Models::InstanceAgentCommandOutputViaTextDetails' if type == 'TEXT' # TODO: Log a warning when the subtype is not found. 'OCI::ComputeInstanceAgent::Models::InstanceAgentCommandOutputDetails' end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :output_type The value to assign to the {#output_type} property
# File lib/oci/compute_instance_agent/models/instance_agent_command_output_details.rb, line 73 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'] self.output_type = "TEXT" if output_type.nil? && !attributes.key?(:'outputType') # rubocop:disable Style/StringLiterals 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.output_type = "TEXT" if output_type.nil? && !attributes.key?(:'outputType') && !attributes.key?(:'output_type') # rubocop:disable Style/StringLiterals end
Attribute type mapping.
# File lib/oci/compute_instance_agent/models/instance_agent_command_output_details.rb, line 41 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'output_type': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
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_output_details.rb, line 108 def ==(other) return true if equal?(other) self.class == other.class && output_type == other.output_type end
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_output_details.rb, line 138 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/compute_instance_agent/models/instance_agent_command_output_details.rb, line 118 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/compute_instance_agent/models/instance_agent_command_output_details.rb, line 127 def hash [output_type].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] output_type
Object
to be assigned
# File lib/oci/compute_instance_agent/models/instance_agent_command_output_details.rb, line 92 def output_type=(output_type) # rubocop:disable Style/ConditionalAssignment if output_type && !OUTPUT_TYPE_ENUM.include?(output_type) OCI.logger.debug("Unknown value for 'output_type' [" + output_type + "]. Mapping to 'OUTPUT_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @output_type = OUTPUT_TYPE_UNKNOWN_ENUM_VALUE else @output_type = output_type end # rubocop:enable Style/ConditionalAssignment end
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_output_details.rb, line 171 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/compute_instance_agent/models/instance_agent_command_output_details.rb, line 165 def to_s to_hash.to_s end
Private Instance Methods
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_output_details.rb, line 188 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