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.

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

  • :key (String)

    The value to assign to the #key property

  • :display_name (String)

    The value to assign to the #display_name property

  • :description (String)

    The value to assign to the #description property

  • :entity_key (String)

    The value to assign to the #entity_key property

  • :external_key (String)

    The value to assign to the #external_key property

  • :length (Integer)

    The value to assign to the #length property

  • :is_nullable (BOOLEAN)

    The value to assign to the #is_nullable property

  • :uri (String)

    The value to assign to the #uri property

  • :lifecycle_state (String)

    The value to assign to the #lifecycle_state property

  • :time_created (DateTime)

    The value to assign to the #time_created property

  • :external_data_type (String)

    The value to assign to the #external_data_type property



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
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
159
160
161
162
163
164
165
166
167
168
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 113

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

Instance Attribute Details

#descriptionString

Detailed description of the attribute.

Returns:

  • (String)


22
23
24
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 22

def description
  @description
end

#display_nameString

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

Returns:

  • (String)


18
19
20
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 18

def display_name
  @display_name
end

#entity_keyString

The unique key of the parent entity.

Returns:

  • (String)


26
27
28
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 26

def entity_key
  @entity_key
end

#external_data_typeString

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

Returns:

  • (String)


56
57
58
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 56

def external_data_type
  @external_data_type
end

#external_keyString

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

Returns:

  • (String)


30
31
32
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 30

def external_key
  @external_key
end

#is_nullableBOOLEAN

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

Returns:

  • (BOOLEAN)


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

def is_nullable
  @is_nullable
end

#keyString

[Required] Unique attribute key that is immutable.

Returns:

  • (String)


12
13
14
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 12

def key
  @key
end

#lengthInteger

Max allowed length of the attribute value.

Returns:

  • (Integer)


34
35
36
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 34

def length
  @length
end

#lifecycle_stateString

State of the attribute.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#time_createdDateTime

The date and time the attribute was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Returns:

  • (DateTime)


52
53
54
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 52

def time_created
  @time_created
end

#uriString

URI to the attribute instance in the API.

Returns:

  • (String)


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

def uri
  @uri
end

Class Method Details

.attribute_mapObject

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 59

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'display_name': :'displayName',
    'description': :'description',
    'entity_key': :'entityKey',
    'external_key': :'externalKey',
    'length': :'length',
    'is_nullable': :'isNullable',
    'uri': :'uri',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'external_data_type': :'externalDataType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 78

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'display_name': :'String',
    'description': :'String',
    'entity_key': :'String',
    'external_key': :'String',
    'length': :'Integer',
    'is_nullable': :'BOOLEAN',
    'uri': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'external_data_type': :'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



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 177

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    key == other.key &&
    display_name == other.display_name &&
    description == other.description &&
    entity_key == other.entity_key &&
    external_key == other.external_key &&
    length == other.length &&
    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
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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 217

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


197
198
199
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 197

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



206
207
208
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 206

def hash
  [key, display_name, description, entity_key, external_key, length, is_nullable, uri, lifecycle_state, time_created, external_data_type].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



250
251
252
253
254
255
256
257
258
259
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 250

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



244
245
246
# File 'lib/oci/data_catalog/models/attribute_summary.rb', line 244

def to_s
  to_hash.to_s
end