Class: OCI::DataCatalog::Models::Type

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_catalog/models/type.rb

Overview

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.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_MOVING = 'MOVING'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Type

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash

Options Hash (attributes):



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# 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

Instance Attribute Details

#catalog_idString

The data catalog's OCID.

Returns:

  • (String)


39
40
41
# File 'lib/oci/data_catalog/models/type.rb', line 39

def catalog_id
  @catalog_id
end

#custom_propertiesArray<OCI::DataCatalog::Models::CustomPropertySummary>

Custom properties associated with this Type.



94
95
96
# File 'lib/oci/data_catalog/models/type.rb', line 94

def custom_properties
  @custom_properties
end

#descriptionString

Detailed description of the type.

Returns:

  • (String)


35
36
37
# File 'lib/oci/data_catalog/models/type.rb', line 35

def description
  @description
end

#external_type_nameString

Mapping type equivalence in the external system.

Returns:

  • (String)


86
87
88
# File 'lib/oci/data_catalog/models/type.rb', line 86

def external_type_name
  @external_type_name
end

#is_approvedBOOLEAN

Indicates whether the type is approved for use as a classifying object.

Returns:

  • (BOOLEAN)


78
79
80
# File 'lib/oci/data_catalog/models/type.rb', line 78

def is_approved
  @is_approved
end

#is_internalBOOLEAN

Indicates whether the type is internal, making it unavailable for use by metadata elements.

Returns:

  • (BOOLEAN)


70
71
72
# File 'lib/oci/data_catalog/models/type.rb', line 70

def is_internal
  @is_internal
end

#is_tagBOOLEAN

Indicates whether the type can be used for tagging metadata elements.

Returns:

  • (BOOLEAN)


74
75
76
# File 'lib/oci/data_catalog/models/type.rb', line 74

def is_tag
  @is_tag
end

#keyString

[Required] Unique type key that is immutable.

Returns:

  • (String)


27
28
29
# File 'lib/oci/data_catalog/models/type.rb', line 27

def key
  @key
end

#lifecycle_stateString

The current state of the type.

Returns:

  • (String)


66
67
68
# File 'lib/oci/data_catalog/models/type.rb', line 66

def lifecycle_state
  @lifecycle_state
end

#nameString

The immutable name of the type.

Returns:

  • (String)


31
32
33
# File 'lib/oci/data_catalog/models/type.rb', line 31

def name
  @name
end

#propertiesHash<String, Array<OCI::DataCatalog::Models::PropertyDefinition>>

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 }, ... ] } } }

Returns:



62
63
64
# File 'lib/oci/data_catalog/models/type.rb', line 62

def properties
  @properties
end

#type_categoryString

Indicates the category this type belongs to. For instance, data assets, connections.

Returns:

  • (String)


82
83
84
# File 'lib/oci/data_catalog/models/type.rb', line 82

def type_category
  @type_category
end

#uriString

URI to the type instance in the API.

Returns:

  • (String)


90
91
92
# File 'lib/oci/data_catalog/models/type.rb', line 90

def uri
  @uri
end

Class Method Details

.attribute_mapObject

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# 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

.swagger_typesObject

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
# 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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
# 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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
# 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) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


264
265
266
# File 'lib/oci/data_catalog/models/type.rb', line 264

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



273
274
275
# 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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



317
318
319
320
321
322
323
324
325
326
# 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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



311
312
313
# File 'lib/oci/data_catalog/models/type.rb', line 311

def to_s
  to_hash.to_s
end