Class: OCI::DataCatalog::Models::AttributeSummary

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

Overview

Summary of an entity attribute.

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
ASSOCIATED_RULE_TYPES_ENUM = 
[
  ASSOCIATED_RULE_TYPES_PRIMARYKEY = 'PRIMARYKEY'.freeze,
  ASSOCIATED_RULE_TYPES_FOREIGNKEY = 'FOREIGNKEY'.freeze,
  ASSOCIATED_RULE_TYPES_UNIQUEKEY = 'UNIQUEKEY'.freeze,
  ASSOCIATED_RULE_TYPES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AttributeSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 220

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']
end

Instance Attribute Details

#associated_rule_types ⇒ Array<String>

Rule types associated with attribute.

Returns:

  • (Array<String>) 


127
128
129
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 127

def associated_rule_types
  @associated_rule_types
end

#business_name ⇒ String

Optional user friendly business name of the attribute. If set, this supplements the harvested display name of the object.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 42

def business_name
  @business_name
end

#custom_property_members ⇒ Array<OCI::DataCatalog::Models::CustomPropertyGetUsage>

The list of customized properties along with the values for this object

Returns:



123
124
125
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 123

def custom_property_members
  @custom_property_members
end

#datatype_entity_key ⇒ String

Entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 103

def datatype_entity_key
  @datatype_entity_key
end

#description ⇒ String

Detailed description of the attribute.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 46

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 38

def display_name
  @display_name
end

#entity_key ⇒ String

The unique key of the parent entity.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 50

def entity_key
  @entity_key
end

#external_data_type ⇒ String

Data type of the attribute as defined in the external source system.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 88

def external_data_type
  @external_data_type
end

#external_datatype_entity_key ⇒ String

External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.

Returns:

  • (String) 


107
108
109
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 107

def external_datatype_entity_key
  @external_datatype_entity_key
end

#external_key ⇒ String

Unique external key of this attribute in the external source system.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 54

def external_key
  @external_key
end

#external_parent_attribute_key ⇒ String

External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type.

Returns:

  • (String) 


115
116
117
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 115

def external_parent_attribute_key
  @external_parent_attribute_key
end

#is_nullable ⇒ BOOLEAN

Property that identifies if this attribute can be assigned null values.

Returns:

  • (BOOLEAN) 


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

def is_nullable
  @is_nullable
end

#key ⇒ String

[Required] Unique attribute key that is immutable.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 32

def key
  @key
end

#length ⇒ Integer

Max allowed length of the attribute value.

Returns:

  • (Integer) 


58
59
60
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 58

def length
  @length
end

#lifecycle_state ⇒ String

State of the attribute.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#max_collection_count ⇒ Integer

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

Returns:

  • (Integer) 


99
100
101
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 99

def max_collection_count
  @max_collection_count
end

#min_collection_count ⇒ Integer

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.

Returns:

  • (Integer) 


92
93
94
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 92

def min_collection_count
  @min_collection_count
end

#parent_attribute_key ⇒ String

Attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex datatype.

Returns:

  • (String) 


111
112
113
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 111

def parent_attribute_key
  @parent_attribute_key
end

#path ⇒ String

Full path of the attribute.

Returns:

  • (String) 


119
120
121
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 119

def path
  @path
end

#precision ⇒ Integer

Precision of the attribute value usually applies to float data type.

Returns:

  • (Integer) 


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

def precision
  @precision
end

#scale ⇒ Integer

Scale of the attribute value usually applies to float data type.

Returns:

  • (Integer) 


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

def scale
  @scale
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


84
85
86
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 84

def time_created
  @time_created
end

#uri ⇒ String

URI to the attribute instance in the API.

Returns:

  • (String) 


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

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 130

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 161

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>'
    # 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



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 377

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
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



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 429

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


409
410
411
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 409

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



418
419
420
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 418

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].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



462
463
464
465
466
467
468
469
470
471
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 462

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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



456
457
458
 
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 456

def to_s
  to_hash.to_s
end