Class: OCI::DataCatalog::Models::CreateTermDetails

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

Overview

Properties used in term create operations.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateTermDetails

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

  • :is_allowed_to_have_child_terms (BOOLEAN)

    The value to assign to the #is_allowed_to_have_child_terms property

  • :parent_term_key (String)

    The value to assign to the #parent_term_key property

  • :owner (String)

    The value to assign to the #owner property

  • :workflow_status (String)

    The value to assign to the #workflow_status property



76
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
105
106
107
108
109
110
111
# File 'lib/oci/data_catalog/models/create_term_details.rb', line 76

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.is_allowed_to_have_child_terms = attributes[:'isAllowedToHaveChildTerms'] unless attributes[:'isAllowedToHaveChildTerms'].nil?
  self.is_allowed_to_have_child_terms = true if is_allowed_to_have_child_terms.nil? && !attributes.key?(:'isAllowedToHaveChildTerms') # rubocop:disable Style/StringLiterals

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

  self.is_allowed_to_have_child_terms = attributes[:'is_allowed_to_have_child_terms'] unless attributes[:'is_allowed_to_have_child_terms'].nil?
  self.is_allowed_to_have_child_terms = true if is_allowed_to_have_child_terms.nil? && !attributes.key?(:'isAllowedToHaveChildTerms') && !attributes.key?(:'is_allowed_to_have_child_terms') # rubocop:disable Style/StringLiterals

  self.parent_term_key = attributes[:'parentTermKey'] if attributes[:'parentTermKey']

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

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

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

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

Instance Attribute Details

#descriptionString

Detailed description of the term.

Returns:

  • (String)


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

def description
  @description
end

#display_nameString

[Required] A user-friendly display name. Is changeable. The combination of 'displayName' and 'parentTermKey' must be unique. Avoid entering confidential information.

Returns:

  • (String)


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

def display_name
  @display_name
end

#is_allowed_to_have_child_termsBOOLEAN

Indicates whether a term may contain child terms.

Returns:

  • (BOOLEAN)


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

def is_allowed_to_have_child_terms
  @is_allowed_to_have_child_terms
end

#ownerString

OCID of the user who is the owner of this business terminology.

Returns:

  • (String)


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

def owner
  @owner
end

#parent_term_keyString

The terms parent term key. Will be null if the term has no parent term.

Returns:

  • (String)


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

def parent_term_key
  @parent_term_key
end

#workflow_statusString

Status of the approval process workflow for this business term in the glossary.

Returns:

  • (String)


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

def workflow_status
  @workflow_status
end

Class Method Details

.attribute_mapObject

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



37
38
39
40
41
42
43
44
45
46
47
48
# File 'lib/oci/data_catalog/models/create_term_details.rb', line 37

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'is_allowed_to_have_child_terms': :'isAllowedToHaveChildTerms',
    'parent_term_key': :'parentTermKey',
    'owner': :'owner',
    'workflow_status': :'workflowStatus'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'is_allowed_to_have_child_terms': :'BOOLEAN',
    'parent_term_key': :'String',
    'owner': :'String',
    'workflow_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



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

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

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



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_term_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_term_details.rb', line 135

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



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

def hash
  [display_name, description, is_allowed_to_have_child_terms, parent_term_key, owner, workflow_status].hash
end

#to_hashHash

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_term_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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



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

def to_s
  to_hash.to_s
end