class OCI::CloudGuard::Models::ManagedList

A cloud guard list containing one or more items of a list type

Constants

FEED_PROVIDER_ENUM
LIFECYCLE_STATE_ENUM
LIST_TYPE_ENUM

Attributes

compartment_id[RW]

[Required] Compartment Identifier where the resource is created @return [String]

defined_tags[RW]

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

@return [Hash<String, Hash<String, Object>>]

description[RW]

ManagedList description @return [String]

display_name[RW]

[Required] ManagedList display name @return [String]

feed_provider[R]

provider of the feed @return [String]

freeform_tags[RW]

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

@return [Hash<String, String>]

id[RW]

[Required] Unique identifier that is immutable on creation @return [String]

is_editable[RW]

If this list is editable or not @return [BOOLEAN]

lifecycle_state[R]

The current state of the resource. @return [String]

lifecyle_details[RW]

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state. @return [String]

list_items[RW]

List of ManagedListItem @return [Array<String>]

list_type[R]

[Required] type of the list @return [String]

source_managed_list_id[RW]

OCID of the Source ManagedList @return [String]

system_tags[RW]

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). System tags can be viewed by users, but can only be created by the system.

Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

@return [Hash<String, Hash<String, Object>>]

time_created[RW]

The date and time the managed list was created. Format defined by RFC3339. @return [DateTime]

time_updated[RW]

The date and time the managed list was updated. Format defined by 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/cloud_guard/models/managed_list.rb, line 118
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'source_managed_list_id': :'sourceManagedListId',
    'list_type': :'listType',
    'list_items': :'listItems',
    'feed_provider': :'feedProvider',
    'is_editable': :'isEditable',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecyle_details': :'lifecyleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # 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] :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 [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :source_managed_list_id The value to assign to the {#source_managed_list_id} property @option attributes [String] :list_type The value to assign to the {#list_type} property @option attributes [Array<String>] :list_items The value to assign to the {#list_items} property @option attributes [String] :feed_provider The value to assign to the {#feed_provider} property @option attributes [BOOLEAN] :is_editable The value to assign to the {#is_editable} 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 [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [String] :lifecyle_details The value to assign to the {#lifecyle_details} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [Hash<String, Hash<String, Object>>] :system_tags The value to assign to the {#system_tags} property

# File lib/oci/cloud_guard/models/managed_list.rb, line 187
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.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.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.source_managed_list_id = attributes[:'sourceManagedListId'] if attributes[:'sourceManagedListId']

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

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

  self.list_type = attributes[:'listType'] if attributes[:'listType']

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

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

  self.list_items = attributes[:'listItems'] if attributes[:'listItems']

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

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

  self.feed_provider = attributes[:'feedProvider'] if attributes[:'feedProvider']

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

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

  self.is_editable = attributes[:'isEditable'] unless attributes[:'isEditable'].nil?

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

  self.is_editable = attributes[:'is_editable'] unless attributes[:'is_editable'].nil?

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

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

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

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

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

  self.system_tags = attributes[:'system_tags'] if attributes[:'system_tags']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/cloud_guard/models/managed_list.rb, line 142
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'source_managed_list_id': :'String',
    'list_type': :'String',
    'list_items': :'Array<String>',
    'feed_provider': :'String',
    'is_editable': :'BOOLEAN',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecyle_details': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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/cloud_guard/models/managed_list.rb, line 328
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    source_managed_list_id == other.source_managed_list_id &&
    list_type == other.list_type &&
    list_items == other.list_items &&
    feed_provider == other.feed_provider &&
    is_editable == other.is_editable &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecyle_details == other.lifecyle_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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/cloud_guard/models/managed_list.rb, line 373
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/cloud_guard/models/managed_list.rb, line 353
def eql?(other)
  self == other
end
feed_provider=(feed_provider) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] feed_provider Object to be assigned

# File lib/oci/cloud_guard/models/managed_list.rb, line 299
def feed_provider=(feed_provider)
  # rubocop:disable Style/ConditionalAssignment
  if feed_provider && !FEED_PROVIDER_ENUM.include?(feed_provider)
    OCI.logger.debug("Unknown value for 'feed_provider' [" + feed_provider + "]. Mapping to 'FEED_PROVIDER_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @feed_provider = FEED_PROVIDER_UNKNOWN_ENUM_VALUE
  else
    @feed_provider = feed_provider
  end
  # rubocop:enable Style/ConditionalAssignment
end
hash() click to toggle source

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

# File lib/oci/cloud_guard/models/managed_list.rb, line 362
def hash
  [id, display_name, description, compartment_id, source_managed_list_id, list_type, list_items, feed_provider, is_editable, time_created, time_updated, lifecycle_state, lifecyle_details, freeform_tags, defined_tags, system_tags].hash
end
lifecycle_state=(lifecycle_state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state Object to be assigned

# File lib/oci/cloud_guard/models/managed_list.rb, line 312
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
list_type=(list_type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] list_type Object to be assigned

# File lib/oci/cloud_guard/models/managed_list.rb, line 286
def list_type=(list_type)
  # rubocop:disable Style/ConditionalAssignment
  if list_type && !LIST_TYPE_ENUM.include?(list_type)
    OCI.logger.debug("Unknown value for 'list_type' [" + list_type + "]. Mapping to 'LIST_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @list_type = LIST_TYPE_UNKNOWN_ENUM_VALUE
  else
    @list_type = list_type
  end
  # rubocop:enable Style/ConditionalAssignment
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/cloud_guard/models/managed_list.rb, line 406
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/cloud_guard/models/managed_list.rb, line 400
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/cloud_guard/models/managed_list.rb, line 423
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