class OCI::DataCatalog::Models::FolderTag

Represents an association of a folder to a term.

Constants

LIFECYCLE_STATE_ENUM

Attributes

created_by_id[RW]

OCID of the user who created the tag. @return [String]

folder_key[RW]

The unique key of the folder associated with this tag. @return [String]

key[RW]

[Required] Unique tag key that is immutable. @return [String]

lifecycle_state[R]

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

name[RW]

Name of the tag which matches the term name. @return [String]

term_description[RW]

Description of the related term. @return [String]

term_key[RW]

Unique key of the related term. @return [String]

term_path[RW]

Path of the related term. @return [String]

time_created[RW]

The date and time the tag was created, in the format defined by [RFC3339](tools.ietf.org/html/rfc3339). Example: `2019-03-25T21:10:29.600Z`

@return [DateTime]

uri[RW]

URI to the tag instance in the API. @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/data_catalog/models/folder_tag.rb, line 66
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'folder_key': :'folderKey',
    'key': :'key',
    'name': :'name',
    'term_key': :'termKey',
    'term_path': :'termPath',
    'term_description': :'termDescription',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'created_by_id': :'createdById',
    'uri': :'uri'
    # 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] :folder_key The value to assign to the {#folder_key} property @option attributes [String] :key The value to assign to the {#key} property @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :term_key The value to assign to the {#term_key} property @option attributes [String] :term_path The value to assign to the {#term_path} property @option attributes [String] :term_description The value to assign to the {#term_description} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :created_by_id The value to assign to the {#created_by_id} property @option attributes [String] :uri The value to assign to the {#uri} property

# File lib/oci/data_catalog/models/folder_tag.rb, line 117
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.folder_key = attributes[:'folderKey'] if attributes[:'folderKey']

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

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

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

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

  self.term_key = attributes[:'termKey'] if attributes[:'termKey']

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

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

  self.term_path = attributes[:'termPath'] if attributes[:'termPath']

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

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

  self.term_description = attributes[:'termDescription'] if attributes[:'termDescription']

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

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

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

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

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

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

Attribute type mapping.

# File lib/oci/data_catalog/models/folder_tag.rb, line 84
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'folder_key': :'String',
    'key': :'String',
    'name': :'String',
    'term_key': :'String',
    'term_path': :'String',
    'term_description': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'created_by_id': :'String',
    'uri': :'String'
    # 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/data_catalog/models/folder_tag.rb, line 192
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    folder_key == other.folder_key &&
    key == other.key &&
    name == other.name &&
    term_key == other.term_key &&
    term_path == other.term_path &&
    term_description == other.term_description &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    created_by_id == other.created_by_id &&
    uri == other.uri
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/data_catalog/models/folder_tag.rb, line 231
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/data_catalog/models/folder_tag.rb, line 211
def eql?(other)
  self == other
end
hash() click to toggle source

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

# File lib/oci/data_catalog/models/folder_tag.rb, line 220
def hash
  [folder_key, key, name, term_key, term_path, term_description, lifecycle_state, time_created, created_by_id, uri].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/data_catalog/models/folder_tag.rb, line 176
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
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/data_catalog/models/folder_tag.rb, line 264
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/data_catalog/models/folder_tag.rb, line 258
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/data_catalog/models/folder_tag.rb, line 281
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