class OCI::DataCatalog::Models::Type

Full data catalog type definition. Fully defines a type of the data catalog. All types are statically defined in the system and are immutable. It isn't possible to create new types or update existing types via the API.

Constants

LIFECYCLE_STATE_ENUM

Attributes

catalog_id[RW]

The data catalog's OCID. @return [String]

custom_properties[RW]

Custom properties associated with this Type. @return [Array<OCI::DataCatalog::Models::CustomPropertySummary>]

description[RW]

Detailed description of the type. @return [String]

external_type_name[RW]

Mapping type equivalence in the external system. @return [String]

is_approved[RW]

Indicates whether the type is approved for use as a classifying object. @return [BOOLEAN]

is_internal[RW]

Indicates whether the type is internal, making it unavailable for use by metadata elements. @return [BOOLEAN]

is_tag[RW]

Indicates whether the type can be used for tagging metadata elements. @return [BOOLEAN]

key[RW]

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

lifecycle_state[R]

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

name[RW]

The immutable name of the type. @return [String]

properties[RW]

A map of arrays which defines the type specific properties, both required and optional. The map keys are category names and the values are arrays contiaing all property details. Every property is contained inside of a category. Most types have required properties within the "default" category. Example: `{

  \"properties\": {
    \"default\": {
      \"attributes:\": [
        {
          \"name\": \"host\",
          \"type\": \"string\",
          \"isRequired\": true,
          \"isUpdatable\": false
        },
        ...
      ]
    }
  }
}`

@return [Hash<String, Array<OCI::DataCatalog::Models::PropertyDefinition>>]

type_category[RW]

Indicates the category this type belongs to. For instance, data assets, connections. @return [String]

uri[RW]

URI to the type 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/type.rb, line 97
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'name': :'name',
    'description': :'description',
    'catalog_id': :'catalogId',
    'properties': :'properties',
    'lifecycle_state': :'lifecycleState',
    'is_internal': :'isInternal',
    'is_tag': :'isTag',
    'is_approved': :'isApproved',
    'type_category': :'typeCategory',
    'external_type_name': :'externalTypeName',
    'uri': :'uri',
    'custom_properties': :'customProperties'
    # 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] :name The value to assign to the {#name} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [String] :catalog_id The value to assign to the {#catalog_id} property @option attributes [Hash<String, Array<OCI::DataCatalog::Models::PropertyDefinition>>] :properties The value to assign to the {#properties} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [BOOLEAN] :is_internal The value to assign to the {#is_internal} property @option attributes [BOOLEAN] :is_tag The value to assign to the {#is_tag} property @option attributes [BOOLEAN] :is_approved The value to assign to the {#is_approved} property @option attributes [String] :type_category The value to assign to the {#type_category} property @option attributes [String] :external_type_name The value to assign to the {#external_type_name} property @option attributes [String] :uri The value to assign to the {#uri} property @option attributes [Array<OCI::DataCatalog::Models::CustomPropertySummary>] :custom_properties The value to assign to the {#custom_properties} property

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

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

  self.catalog_id = attributes[:'catalogId'] if attributes[:'catalogId']

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

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

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

  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_internal = attributes[:'isInternal'] unless attributes[:'isInternal'].nil?

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

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

  self.is_tag = attributes[:'isTag'] unless attributes[:'isTag'].nil?

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

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

  self.is_approved = attributes[:'isApproved'] unless attributes[:'isApproved'].nil?

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

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

  self.type_category = attributes[:'typeCategory'] if attributes[:'typeCategory']

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

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

  self.external_type_name = attributes[:'externalTypeName'] if attributes[:'externalTypeName']

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

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

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

  self.custom_properties = attributes[:'customProperties'] if attributes[:'customProperties']

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

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

Attribute type mapping.

# File lib/oci/data_catalog/models/type.rb, line 118
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'name': :'String',
    'description': :'String',
    'catalog_id': :'String',
    'properties': :'Hash<String, Array<OCI::DataCatalog::Models::PropertyDefinition>>',
    'lifecycle_state': :'String',
    'is_internal': :'BOOLEAN',
    'is_tag': :'BOOLEAN',
    'is_approved': :'BOOLEAN',
    'type_category': :'String',
    'external_type_name': :'String',
    'uri': :'String',
    'custom_properties': :'Array<OCI::DataCatalog::Models::CustomPropertySummary>'
    # 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/type.rb, line 242
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    key == other.key &&
    name == other.name &&
    description == other.description &&
    catalog_id == other.catalog_id &&
    properties == other.properties &&
    lifecycle_state == other.lifecycle_state &&
    is_internal == other.is_internal &&
    is_tag == other.is_tag &&
    is_approved == other.is_approved &&
    type_category == other.type_category &&
    external_type_name == other.external_type_name &&
    uri == other.uri &&
    custom_properties == other.custom_properties
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/type.rb, line 284
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/type.rb, line 264
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/type.rb, line 273
def hash
  [key, name, description, catalog_id, properties, lifecycle_state, is_internal, is_tag, is_approved, type_category, external_type_name, uri, custom_properties].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/type.rb, line 226
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/type.rb, line 317
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/type.rb, line 311
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/type.rb, line 334
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