Class: OCI::DataCatalog::Models::SearchTermSummary

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

Overview

Summary of a term associated with an object. This is a brief summary returned as part of the search result.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchTermSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :key (String) —

    The value to assign to the #key property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :glossary_key (String) —

    The value to assign to the #glossary_key property

  • :glossary_name (String) —

    The value to assign to the #glossary_name property

  • :parent_term_key (String) —

    The value to assign to the #parent_term_key property

  • :parent_term_name (String) —

    The value to assign to the #parent_term_name property

[View source]

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
112
113
114
115
 
# File 'lib/oci/data_catalog/models/search_term_summary.rb', line 78

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

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

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

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

  self.glossary_name = attributes[:'glossaryName'] if attributes[:'glossaryName']

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

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

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

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

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

Instance Attribute Details

#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) 

20
21
22
 
# File 'lib/oci/data_catalog/models/search_term_summary.rb', line 20

def display_name
  @display_name
end

#glossary_key ⇒ String

Unique id of the parent glossary.

Returns:

  • (String) 

24
25
26
 
# File 'lib/oci/data_catalog/models/search_term_summary.rb', line 24

def glossary_key
  @glossary_key
end

#glossary_name ⇒ String

Name of the parent glossary.

Returns:

  • (String) 

28
29
30
 
# File 'lib/oci/data_catalog/models/search_term_summary.rb', line 28

def glossary_name
  @glossary_name
end

#key ⇒ String

Unique term key that is immutable.

Returns:

  • (String) 

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

def key
  @key
end

#parent_term_key ⇒ String

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

Returns:

  • (String) 

32
33
34
 
# File 'lib/oci/data_catalog/models/search_term_summary.rb', line 32

def parent_term_key
  @parent_term_key
end

#parent_term_name ⇒ String

Name of the parent term key. Will be null if the term has no parent term.

Returns:

  • (String) 

36
37
38
 
# File 'lib/oci/data_catalog/models/search_term_summary.rb', line 36

def parent_term_name
  @parent_term_name
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'display_name': :'displayName',
    'glossary_key': :'glossaryKey',
    'glossary_name': :'glossaryName',
    'parent_term_key': :'parentTermKey',
    'parent_term_name': :'parentTermName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'display_name': :'String',
    'glossary_key': :'String',
    'glossary_name': :'String',
    'parent_term_key': :'String',
    'parent_term_name': :'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

[View source]

124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/data_catalog/models/search_term_summary.rb', line 124

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

  self.class == other.class &&
    key == other.key &&
    display_name == other.display_name &&
    glossary_key == other.glossary_key &&
    glossary_name == other.glossary_name &&
    parent_term_key == other.parent_term_key &&
    parent_term_name == other.parent_term_name
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

[View source]

159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/data_catalog/models/search_term_summary.rb', line 159

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
[View source]

139
140
141
 
# File 'lib/oci/data_catalog/models/search_term_summary.rb', line 139

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

148
149
150
 
# File 'lib/oci/data_catalog/models/search_term_summary.rb', line 148

def hash
  [key, display_name, glossary_key, glossary_name, parent_term_key, parent_term_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/data_catalog/models/search_term_summary.rb', line 192

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

[View source]

186
187
188
 
# File 'lib/oci/data_catalog/models/search_term_summary.rb', line 186

def to_s
  to_hash.to_s
end