Class: OCI::DataIntegration::Models::DetailedDescription

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_integration/models/detailed_description.rb

Overview

The detailed description of an object.

Constant Summary collapse

MODEL_TYPE_ENUM = 
[
  MODEL_TYPE_DETAILED_DESCRIPTION = 'DETAILED_DESCRIPTION'.freeze,
  MODEL_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DetailedDescription

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 114

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

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

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

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

  self.model_version = attributes[:'modelVersion'] if attributes[:'modelVersion']

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

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

  self.parent_ref = attributes[:'parentRef'] if attributes[:'parentRef']

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

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

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

  self.object_version = attributes[:'objectVersion'] if attributes[:'objectVersion']

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

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

  self.object_status = attributes[:'objectStatus'] if attributes[:'objectStatus']

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

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

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

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

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

  self.detailed_description = attributes[:'detailedDescription'] if attributes[:'detailedDescription']

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

  self.detailed_description = attributes[:'detailed_description'] if attributes[:'detailed_description']
end

Instance Attribute Details

#detailed_description ⇒ String

Base64 encoded rich text description of the object.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 57

def detailed_description
  @detailed_description
end

#identifier ⇒ String

Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 46

def identifier
  @identifier
end

#key ⇒ String

Generated key that can be used in API calls to identify task. On scenarios where reference to the task is needed, a value can be passed in create.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 23

def key
  @key
end

#logo ⇒ String

Base64 encoded image to represent logo of the object.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 53

def 
  @logo
end

#metadata ⇒ OCI::DataIntegration::Models::ObjectMetadata

Returns:



49
50
51
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 49

def metadata
  @metadata
end

#model_type ⇒ String

The type of the published object.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 19

def model_type
  @model_type
end

#model_version ⇒ String

The object's model version.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 27

def model_version
  @model_version
end

#name ⇒ String

Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 34

def name
  @name
end

#object_status ⇒ Integer

The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns:

  • (Integer) 


42
43
44
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 42

def object_status
  @object_status
end

#object_version ⇒ Integer

The version of the object that is used to track changes in the object instance.

Returns:

  • (Integer) 


38
39
40
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 38

def object_version
  @object_version
end

#parent_ref ⇒ OCI::DataIntegration::Models::ParentReference

Returns:



30
31
32
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 30

def parent_ref
  @parent_ref
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'key': :'key',
    'model_version': :'modelVersion',
    'parent_ref': :'parentRef',
    'name': :'name',
    'object_version': :'objectVersion',
    'object_status': :'objectStatus',
    'identifier': :'identifier',
    'metadata': :'metadata',
    'logo': :'logo',
    'detailed_description': :'detailedDescription'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'key': :'String',
    'model_version': :'String',
    'parent_ref': :'OCI::DataIntegration::Models::ParentReference',
    'name': :'String',
    'object_version': :'Integer',
    'object_status': :'Integer',
    'identifier': :'String',
    'metadata': :'OCI::DataIntegration::Models::ObjectMetadata',
    'logo': :'String',
    'detailed_description': :'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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 187

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

  self.class == other.class &&
    model_type == other.model_type &&
    key == other.key &&
    model_version == other.model_version &&
    parent_ref == other.parent_ref &&
    name == other.name &&
    object_version == other.object_version &&
    object_status == other.object_status &&
    identifier == other.identifier &&
    metadata == other.metadata &&
     == other. &&
    detailed_description == other.detailed_description
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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 227

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


207
208
209
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 207

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



216
217
218
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 216

def hash
  [model_type, key, model_version, parent_ref, name, object_version, object_status, identifier, metadata, , detailed_description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 260

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



254
255
256
 
# File 'lib/oci/data_integration/models/detailed_description.rb', line 254

def to_s
  to_hash.to_s
end