class OCI::DataCatalog::Models::AttributeSummary

Summary of an entity attribute.

Constants

ASSOCIATED_RULE_TYPES_ENUM
LIFECYCLE_STATE_ENUM

Attributes

associated_rule_types[R]

Rule types associated with attribute. @return [Array<String>]

business_name[RW]

Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object. @return [String]

custom_property_members[RW]

The list of customized properties along with the values for this object @return [Array<OCI::DataCatalog::Models::CustomPropertyGetUsage>]

datatype_entity_key[RW]

Entity key that represents the datatype of this attribute , applicable if this attribute is a complex type. @return [String]

description[RW]

Detailed description of the attribute. @return [String]

display_name[RW]

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

@return [String]

entity_key[RW]

The unique key of the parent entity. @return [String]

external_data_type[RW]

Data type of the attribute as defined in the external source system. @return [String]

external_datatype_entity_key[RW]

External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type. @return [String]

external_key[RW]

Unique external key of this attribute in the external source system. @return [String]

external_parent_attribute_key[RW]

External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type. @return [String]

is_derived_attribute[RW]

Whether a column is derived or not. @return [BOOLEAN]

is_nullable[RW]

Property that identifies if this attribute can be assigned null values. @return [BOOLEAN]

key[RW]

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

length[RW]

Max allowed length of the attribute value. @return [Integer]

lifecycle_state[R]

State of the attribute. @return [String]

max_collection_count[RW]

The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type. For type specifications in systems that specify only "capacity" without upper or lower bound , this property can also be used to just mean "capacity". Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in Xml , maxItems in Json

@return [Integer]

min_collection_count[RW]

The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type. @return [Integer]

parent_attribute_key[RW]

Attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex datatype. @return [String]

path[RW]

Full path of the attribute. @return [String]

precision[RW]

Precision of the attribute value usually applies to float data type. @return [Integer]

scale[RW]

Scale of the attribute value usually applies to float data type. @return [Integer]

time_created[RW]

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

@return [DateTime]

time_updated[RW]

The last time that any change was made to the attribute. An [RFC3339](tools.ietf.org/html/rfc3339) formatted datetime string.

@return [DateTime]

uri[RW]

URI to the attribute 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/attribute_summary.rb, line 139
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'display_name': :'displayName',
    'business_name': :'businessName',
    'description': :'description',
    'entity_key': :'entityKey',
    'external_key': :'externalKey',
    'length': :'length',
    'precision': :'precision',
    'scale': :'scale',
    'is_nullable': :'isNullable',
    'uri': :'uri',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'external_data_type': :'externalDataType',
    'min_collection_count': :'minCollectionCount',
    'max_collection_count': :'maxCollectionCount',
    'datatype_entity_key': :'datatypeEntityKey',
    'external_datatype_entity_key': :'externalDatatypeEntityKey',
    'parent_attribute_key': :'parentAttributeKey',
    'external_parent_attribute_key': :'externalParentAttributeKey',
    'path': :'path',
    'custom_property_members': :'customPropertyMembers',
    'associated_rule_types': :'associatedRuleTypes',
    'is_derived_attribute': :'isDerivedAttribute',
    'time_updated': :'timeUpdated'
    # 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] :key The value to assign to the {#key} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :business_name The value to assign to the {#business_name} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [String] :entity_key The value to assign to the {#entity_key} property @option attributes [String] :external_key The value to assign to the {#external_key} property @option attributes [Integer] :length The value to assign to the {#length} property @option attributes [Integer] :precision The value to assign to the {#precision} property @option attributes [Integer] :scale The value to assign to the {#scale} property @option attributes [BOOLEAN] :is_nullable The value to assign to the {#is_nullable} property @option attributes [String] :uri The value to assign to the {#uri} 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] :external_data_type The value to assign to the {#external_data_type} property @option attributes [Integer] :min_collection_count The value to assign to the {#min_collection_count} property @option attributes [Integer] :max_collection_count The value to assign to the {#max_collection_count} property @option attributes [String] :datatype_entity_key The value to assign to the {#datatype_entity_key} property @option attributes [String] :external_datatype_entity_key The value to assign to the {#external_datatype_entity_key} property @option attributes [String] :parent_attribute_key The value to assign to the {#parent_attribute_key} property @option attributes [String] :external_parent_attribute_key The value to assign to the {#external_parent_attribute_key} property @option attributes [String] :path The value to assign to the {#path} property @option attributes [Array<OCI::DataCatalog::Models::CustomPropertyGetUsage>] :custom_property_members The value to assign to the {#custom_property_members} property @option attributes [Array<String>] :associated_rule_types The value to assign to the {#associated_rule_types} property @option attributes [BOOLEAN] :is_derived_attribute The value to assign to the {#is_derived_attribute} property @option attributes [DateTime] :time_updated The value to assign to the {#time_updated} property

# File lib/oci/data_catalog/models/attribute_summary.rb, line 235
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.key = attributes[:'key'] if attributes[:'key']

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

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

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

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

  self.entity_key = attributes[:'entityKey'] if attributes[:'entityKey']

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

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

  self.external_key = attributes[:'externalKey'] if attributes[:'externalKey']

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

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

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

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

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

  self.is_nullable = attributes[:'isNullable'] unless attributes[:'isNullable'].nil?

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

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

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

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

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

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

  self.min_collection_count = attributes[:'minCollectionCount'] if attributes[:'minCollectionCount']

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

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

  self.max_collection_count = attributes[:'maxCollectionCount'] if attributes[:'maxCollectionCount']

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

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

  self.datatype_entity_key = attributes[:'datatypeEntityKey'] if attributes[:'datatypeEntityKey']

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

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

  self.external_datatype_entity_key = attributes[:'externalDatatypeEntityKey'] if attributes[:'externalDatatypeEntityKey']

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

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

  self.parent_attribute_key = attributes[:'parentAttributeKey'] if attributes[:'parentAttributeKey']

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

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

  self.external_parent_attribute_key = attributes[:'externalParentAttributeKey'] if attributes[:'externalParentAttributeKey']

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

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

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

  self.custom_property_members = attributes[:'customPropertyMembers'] if attributes[:'customPropertyMembers']

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

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

  self.associated_rule_types = attributes[:'associatedRuleTypes'] if attributes[:'associatedRuleTypes']

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

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

  self.is_derived_attribute = attributes[:'isDerivedAttribute'] unless attributes[:'isDerivedAttribute'].nil?

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

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

  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']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/data_catalog/models/attribute_summary.rb, line 172
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'display_name': :'String',
    'business_name': :'String',
    'description': :'String',
    'entity_key': :'String',
    'external_key': :'String',
    'length': :'Integer',
    'precision': :'Integer',
    'scale': :'Integer',
    'is_nullable': :'BOOLEAN',
    'uri': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'external_data_type': :'String',
    'min_collection_count': :'Integer',
    'max_collection_count': :'Integer',
    'datatype_entity_key': :'String',
    'external_datatype_entity_key': :'String',
    'parent_attribute_key': :'String',
    'external_parent_attribute_key': :'String',
    'path': :'String',
    'custom_property_members': :'Array<OCI::DataCatalog::Models::CustomPropertyGetUsage>',
    'associated_rule_types': :'Array<String>',
    'is_derived_attribute': :'BOOLEAN',
    'time_updated': :'DateTime'
    # 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/attribute_summary.rb, line 404
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    key == other.key &&
    display_name == other.display_name &&
    business_name == other.business_name &&
    description == other.description &&
    entity_key == other.entity_key &&
    external_key == other.external_key &&
    length == other.length &&
    precision == other.precision &&
    scale == other.scale &&
    is_nullable == other.is_nullable &&
    uri == other.uri &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    external_data_type == other.external_data_type &&
    min_collection_count == other.min_collection_count &&
    max_collection_count == other.max_collection_count &&
    datatype_entity_key == other.datatype_entity_key &&
    external_datatype_entity_key == other.external_datatype_entity_key &&
    parent_attribute_key == other.parent_attribute_key &&
    external_parent_attribute_key == other.external_parent_attribute_key &&
    path == other.path &&
    custom_property_members == other.custom_property_members &&
    associated_rule_types == other.associated_rule_types &&
    is_derived_attribute == other.is_derived_attribute &&
    time_updated == other.time_updated
end
associated_rule_types=(associated_rule_types) click to toggle source

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

# File lib/oci/data_catalog/models/attribute_summary.rb, line 381
def associated_rule_types=(associated_rule_types)
  # rubocop:disable Style/ConditionalAssignment
  if associated_rule_types.nil?
    @associated_rule_types = nil
  else
    @associated_rule_types =
      associated_rule_types.collect do |item|
        if ASSOCIATED_RULE_TYPES_ENUM.include?(item)
          item
        else
          OCI.logger.debug("Unknown value for 'associated_rule_types' [#{item}]. Mapping to 'ASSOCIATED_RULE_TYPES_UNKNOWN_ENUM_VALUE'") if OCI.logger
          ASSOCIATED_RULE_TYPES_UNKNOWN_ENUM_VALUE
        end
      end
  end
  # rubocop:enable Style/ConditionalAssignment
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/attribute_summary.rb, line 458
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/attribute_summary.rb, line 438
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/attribute_summary.rb, line 447
def hash
  [key, display_name, business_name, description, entity_key, external_key, length, precision, scale, is_nullable, uri, lifecycle_state, time_created, external_data_type, min_collection_count, max_collection_count, datatype_entity_key, external_datatype_entity_key, parent_attribute_key, external_parent_attribute_key, path, custom_property_members, associated_rule_types, is_derived_attribute, time_updated].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/attribute_summary.rb, line 368
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/attribute_summary.rb, line 491
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/attribute_summary.rb, line 485
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/attribute_summary.rb, line 508
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