Class: OCI::DataCatalog::Models::CreateGlossaryDetails

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

Overview

Properties used in glossary create operations.

Constant Summary collapse

WORKFLOW_STATUS_ENUM = 
[
  WORKFLOW_STATUS_NEW = 'NEW'.freeze,
  WORKFLOW_STATUS_APPROVED = 'APPROVED'.freeze,
  WORKFLOW_STATUS_UNDER_REVIEW = 'UNDER_REVIEW'.freeze,
  WORKFLOW_STATUS_ESCALATED = 'ESCALATED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateGlossaryDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/data_catalog/models/create_glossary_details.rb', line 77

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

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

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

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

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

Instance Attribute Details

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

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

Returns:



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

def custom_property_members
  @custom_property_members
end

#description ⇒ String

Detailed description of the glossary.

Returns:

  • (String) 


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

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) 


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

def display_name
  @display_name
end

#owner ⇒ String

OCID of the user who is the owner of the glossary.

Returns:

  • (String) 


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

def owner
  @owner
end

#workflow_status ⇒ String

Status of the approval process workflow for this business glossary.

Returns:

  • (String) 


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

def workflow_status
  @workflow_status
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/data_catalog/models/create_glossary_details.rb', line 41

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'workflow_status': :'workflowStatus',
    'owner': :'owner',
    'custom_property_members': :'customPropertyMembers'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/data_catalog/models/create_glossary_details.rb', line 54

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'workflow_status': :'String',
    'owner': :'String',
    'custom_property_members': :'Array<OCI::DataCatalog::Models::CustomPropertySetUsage>'
    # 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



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/data_catalog/models/create_glossary_details.rb', line 121

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    workflow_status == other.workflow_status &&
    owner == other.owner &&
    custom_property_members == other.custom_property_members
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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/data_catalog/models/create_glossary_details.rb', line 155

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


135
136
137
 
# File 'lib/oci/data_catalog/models/create_glossary_details.rb', line 135

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



144
145
146
 
# File 'lib/oci/data_catalog/models/create_glossary_details.rb', line 144

def hash
  [display_name, description, workflow_status, owner, custom_property_members].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/data_catalog/models/create_glossary_details.rb', line 188

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



182
183
184
 
# File 'lib/oci/data_catalog/models/create_glossary_details.rb', line 182

def to_s
  to_hash.to_s
end