Class: OCI::DataCatalog::Models::CreateEntityDetails

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

Overview

Properties used in data entity create operations.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateEntityDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :time_external (DateTime) —

    The value to assign to the #time_external property

  • :is_logical (BOOLEAN) —

    The value to assign to the #is_logical property

  • :is_partition (BOOLEAN) —

    The value to assign to the #is_partition property

  • :folder_key (String) —

    The value to assign to the #folder_key property

  • :harvest_status (String) —

    The value to assign to the #harvest_status property

  • :last_job_key (String) —

    The value to assign to the #last_job_key property

  • :properties (Hash<String, Hash<String, String>>) —

    The value to assign to the #properties property



109
110
111
112
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
 
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 109

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

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

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

  self.is_logical = attributes[:'isLogical'] unless attributes[:'isLogical'].nil?
  self.is_logical = false if is_logical.nil? && !attributes.key?(:'isLogical') # rubocop:disable Style/StringLiterals

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

  self.is_logical = attributes[:'is_logical'] unless attributes[:'is_logical'].nil?
  self.is_logical = false if is_logical.nil? && !attributes.key?(:'isLogical') && !attributes.key?(:'is_logical') # rubocop:disable Style/StringLiterals

  self.is_partition = attributes[:'isPartition'] unless attributes[:'isPartition'].nil?
  self.is_partition = false if is_partition.nil? && !attributes.key?(:'isPartition') # rubocop:disable Style/StringLiterals

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

  self.is_partition = attributes[:'is_partition'] unless attributes[:'is_partition'].nil?
  self.is_partition = false if is_partition.nil? && !attributes.key?(:'isPartition') && !attributes.key?(:'is_partition') # rubocop:disable Style/StringLiterals

  self.folder_key = attributes[:'folderKey'] if attributes[:'folderKey']

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

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

  self.harvest_status = attributes[:'harvestStatus'] if attributes[:'harvestStatus']

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

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

  self.last_job_key = attributes[:'lastJobKey'] if attributes[:'lastJobKey']

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

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

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

Instance Attribute Details

#description ⇒ String

Detailed description of a data entity.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

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

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 14

def display_name
  @display_name
end

#folder_key ⇒ String

Key of the associated folder.

Returns:

  • (String) 


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

def folder_key
  @folder_key
end

#harvest_status ⇒ String

Status of the object as updated by the harvest process. When an entity object is created , it's harvest status will indicate if the entity's metadata has been fully harvested or not. The harvest process can perform shallow harvesting to allow users to browse the metadata and can on-demand deep harvest on any object This requires a harvest status indicator for catalog objects.

Returns:

  • (String) 


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

def harvest_status
  @harvest_status
end

#is_logical ⇒ BOOLEAN

Property to indicate if the object is a physical materialized object or virtual. For example, View.

Returns:

  • (BOOLEAN) 


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

def is_logical
  @is_logical
end

#is_partition ⇒ BOOLEAN

Property to indicate if the object is a sub object of a parent physical object.

Returns:

  • (BOOLEAN) 


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

def is_partition
  @is_partition
end

#last_job_key ⇒ String

Key of the last harvest process to update this object.

Returns:

  • (String) 


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

def last_job_key
  @last_job_key
end

#properties ⇒ Hash<String, Hash<String, String>>

A map of maps that contains the properties which are specific to the entity type. Each entity type definition defines it's set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most entities have required properties within the "default" category. To determine the set of required and optional properties for an entity type, a query can be done on '/types?type=dataEntity' that returns a collection of all entity types. The appropriate entity type, which includes definitions of all of it's properties, can be identified from this collection. Example: {\"properties\": { \"default\": { \"key1\": \"value1\"}}}

Returns:

  • (Hash<String, Hash<String, String>>) 


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

def properties
  @properties
end

#time_external ⇒ DateTime

[Required] Last modified timestamp of the object in the external system.

Returns:

  • (DateTime) 


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

def time_external
  @time_external
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'time_external': :'timeExternal',
    'is_logical': :'isLogical',
    'is_partition': :'isPartition',
    'folder_key': :'folderKey',
    'harvest_status': :'harvestStatus',
    'last_job_key': :'lastJobKey',
    'properties': :'properties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'time_external': :'DateTime',
    'is_logical': :'BOOLEAN',
    'is_partition': :'BOOLEAN',
    'folder_key': :'String',
    'harvest_status': :'String',
    'last_job_key': :'String',
    'properties': :'Hash<String, Hash<String, 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



173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 173

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    time_external == other.time_external &&
    is_logical == other.is_logical &&
    is_partition == other.is_partition &&
    folder_key == other.folder_key &&
    harvest_status == other.harvest_status &&
    last_job_key == other.last_job_key &&
    properties == other.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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 211

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


191
192
193
 
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 191

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



200
201
202
 
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 200

def hash
  [display_name, description, time_external, is_logical, is_partition, folder_key, harvest_status, last_job_key, properties].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 244

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



238
239
240
 
# File 'lib/oci/data_catalog/models/create_entity_details.rb', line 238

def to_s
  to_hash.to_s
end