class OCI::Logging::Models::UnifiedAgentConfigurationSummary
Unified Agent configuration summary object returned by the list API.
Constants
- CONFIGURATION_STATE_ENUM
- CONFIGURATION_TYPE_ENUM
- LIFECYCLE_STATE_ENUM
Attributes
[Required] The OCID of the compartment that the resource belongs to. @return [String]
[Required] State of unified agent service configuration. @return [String]
[Required] Type of Unified Agent service configuration. @return [String]
Description for this resource. @return [String]
[Required] The user-friendly display name. This must be unique within the enclosing resource, and it's changeable. Avoid entering confidential information.
@return [String]
[Required] The OCID of the resource. @return [String]
[Required] Whether or not this resource is currently enabled. @return [BOOLEAN]
[Required] The pipeline state. @return [String]
Time the resource was created. @return [DateTime]
Time the resource was last modified. @return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/logging/models/unified_agent_configuration_summary.rb, line 90 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'display_name': :'displayName', 'description': :'description', 'defined_tags': :'definedTags', 'freeform_tags': :'freeformTags', 'time_created': :'timeCreated', 'time_last_modified': :'timeLastModified', 'lifecycle_state': :'lifecycleState', 'is_enabled': :'isEnabled', 'configuration_type': :'configurationType', 'configuration_state': :'configurationState' # rubocop:enable Style/SymbolLiteral } end
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 [String] :description The value to assign to the {#description} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [DateTime] :time_last_modified The value to assign to the {#time_last_modified} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [BOOLEAN] :is_enabled The value to assign to the {#is_enabled} property @option attributes [String] :configuration_type The value to assign to the {#configuration_type} property @option attributes [String] :configuration_state The value to assign to the {#configuration_state} property
# File lib/oci/logging/models/unified_agent_configuration_summary.rb, line 147 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.description = attributes[:'description'] if attributes[:'description'] self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags'] self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] 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_last_modified = attributes[:'timeLastModified'] if attributes[:'timeLastModified'] raise 'You cannot provide both :timeLastModified and :time_last_modified' if attributes.key?(:'timeLastModified') && attributes.key?(:'time_last_modified') self.time_last_modified = attributes[:'time_last_modified'] if attributes[:'time_last_modified'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil? self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isEnabled and :is_enabled' if attributes.key?(:'isEnabled') && attributes.key?(:'is_enabled') self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil? self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') && !attributes.key?(:'is_enabled') # rubocop:disable Style/StringLiterals self.configuration_type = attributes[:'configurationType'] if attributes[:'configurationType'] raise 'You cannot provide both :configurationType and :configuration_type' if attributes.key?(:'configurationType') && attributes.key?(:'configuration_type') self.configuration_type = attributes[:'configuration_type'] if attributes[:'configuration_type'] self.configuration_state = attributes[:'configurationState'] if attributes[:'configurationState'] raise 'You cannot provide both :configurationState and :configuration_state' if attributes.key?(:'configurationState') && attributes.key?(:'configuration_state') self.configuration_state = attributes[:'configuration_state'] if attributes[:'configuration_state'] end
Attribute type mapping.
# File lib/oci/logging/models/unified_agent_configuration_summary.rb, line 110 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'display_name': :'String', 'description': :'String', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'freeform_tags': :'Hash<String, String>', 'time_created': :'DateTime', 'time_last_modified': :'DateTime', 'lifecycle_state': :'String', 'is_enabled': :'BOOLEAN', 'configuration_type': :'String', 'configuration_state': :'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/logging/models/unified_agent_configuration_summary.rb, line 266 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && display_name == other.display_name && description == other.description && defined_tags == other.defined_tags && freeform_tags == other.freeform_tags && time_created == other.time_created && time_last_modified == other.time_last_modified && lifecycle_state == other.lifecycle_state && is_enabled == other.is_enabled && configuration_type == other.configuration_type && configuration_state == other.configuration_state 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/logging/models/unified_agent_configuration_summary.rb, line 307 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
Custom attribute writer method checking allowed values (enum). @param [Object] configuration_state
Object
to be assigned
# File lib/oci/logging/models/unified_agent_configuration_summary.rb, line 250 def configuration_state=(configuration_state) # rubocop:disable Style/ConditionalAssignment if configuration_state && !CONFIGURATION_STATE_ENUM.include?(configuration_state) OCI.logger.debug("Unknown value for 'configuration_state' [" + configuration_state + "]. Mapping to 'CONFIGURATION_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @configuration_state = CONFIGURATION_STATE_UNKNOWN_ENUM_VALUE else @configuration_state = configuration_state end # rubocop:enable Style/ConditionalAssignment end
Custom attribute writer method checking allowed values (enum). @param [Object] configuration_type
Object
to be assigned
# File lib/oci/logging/models/unified_agent_configuration_summary.rb, line 237 def configuration_type=(configuration_type) # rubocop:disable Style/ConditionalAssignment if configuration_type && !CONFIGURATION_TYPE_ENUM.include?(configuration_type) OCI.logger.debug("Unknown value for 'configuration_type' [" + configuration_type + "]. Mapping to 'CONFIGURATION_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @configuration_type = CONFIGURATION_TYPE_UNKNOWN_ENUM_VALUE else @configuration_type = configuration_type end # rubocop:enable Style/ConditionalAssignment end
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/logging/models/unified_agent_configuration_summary.rb, line 287 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/logging/models/unified_agent_configuration_summary.rb, line 296 def hash [id, compartment_id, display_name, description, defined_tags, freeform_tags, time_created, time_last_modified, lifecycle_state, is_enabled, configuration_type, configuration_state].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/logging/models/unified_agent_configuration_summary.rb, line 224 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state 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/logging/models/unified_agent_configuration_summary.rb, line 340 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/logging/models/unified_agent_configuration_summary.rb, line 334 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/logging/models/unified_agent_configuration_summary.rb, line 357 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