Class: OCI::DataCatalog::Models::CreateFolderDetails

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

Overview

Properties used in folder create operations.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateFolderDetails

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

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

    The value to assign to the #properties property

  • :parent_folder_key (String) —

    The value to assign to the #parent_folder_key property

  • :time_external (DateTime) —

    The value to assign to the #time_external property

  • :last_job_key (String) —

    The value to assign to the #last_job_key property

  • :harvest_status (String) —

    The value to assign to the #harvest_status property



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/data_catalog/models/create_folder_details.rb', line 91

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

  self.parent_folder_key = attributes[:'parentFolderKey'] if attributes[:'parentFolderKey']

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

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

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

Instance Attribute Details

#description ⇒ String

Detailed description of a folder.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/data_catalog/models/create_folder_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_folder_details.rb', line 14

def display_name
  @display_name
end

#harvest_status ⇒ String

Folder harvesting status.

Returns:

  • (String) 


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

def harvest_status
  @harvest_status
end

#last_job_key ⇒ String

The job key of the harvest process that updated the folder definition from the source system.

Returns:

  • (String) 


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

def last_job_key
  @last_job_key
end

#parent_folder_key ⇒ String

The key of the containing folder or null if there isn't a parent folder.

Returns:

  • (String) 


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

def parent_folder_key
  @parent_folder_key
end

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

A map of maps that contains the properties which are specific to the folder type. Each folder 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 folders have required properties within the "default" category. To determine the set of optional and required properties for a folder type, a query can be done on '/types?type=folder' that returns a collection of all folder types. The appropriate folder 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>>) 


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

def properties
  @properties
end

#time_external ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_external
  @time_external
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/data_catalog/models/create_folder_details.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'properties': :'properties',
    'parent_folder_key': :'parentFolderKey',
    'time_external': :'timeExternal',
    'last_job_key': :'lastJobKey',
    'harvest_status': :'harvestStatus'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/data_catalog/models/create_folder_details.rb', line 139

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

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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/data_catalog/models/create_folder_details.rb', line 175

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


155
156
157
 
# File 'lib/oci/data_catalog/models/create_folder_details.rb', line 155

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



164
165
166
 
# File 'lib/oci/data_catalog/models/create_folder_details.rb', line 164

def hash
  [display_name, description, properties, parent_folder_key, time_external, last_job_key, harvest_status].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
217
 
# File 'lib/oci/data_catalog/models/create_folder_details.rb', line 208

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



202
203
204
 
# File 'lib/oci/data_catalog/models/create_folder_details.rb', line 202

def to_s
  to_hash.to_s
end