Class: OCI::Opsi::Models::OpsiDataObjectSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opsi/models/opsi_data_object_summary.rb

Overview

Summary of an OPSI data object. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

DATA_OBJECT_TYPE_ENUM = 
[
  DATA_OBJECT_TYPE_DATABASE_INSIGHTS_DATA_OBJECT = 'DATABASE_INSIGHTS_DATA_OBJECT'.freeze,
  DATA_OBJECT_TYPE_HOST_INSIGHTS_DATA_OBJECT = 'HOST_INSIGHTS_DATA_OBJECT'.freeze,
  DATA_OBJECT_TYPE_EXADATA_INSIGHTS_DATA_OBJECT = 'EXADATA_INSIGHTS_DATA_OBJECT'.freeze,
  DATA_OBJECT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OpsiDataObjectSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :identifier (String) —

    The value to assign to the #identifier property

  • :data_object_type (String) —

    The value to assign to the #data_object_type property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :name (String) —

    The value to assign to the #name property

  • :group_names (Array<String>) —

    The value to assign to the #group_names property



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/opsi/models/opsi_data_object_summary.rb', line 101

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

  self.data_object_type = attributes[:'dataObjectType'] if attributes[:'dataObjectType']

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

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

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

  self.group_names = attributes[:'groupNames'] if attributes[:'groupNames']

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

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

Instance Attribute Details

#data_object_type ⇒ String

[Required] Type of OPSI data object.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 26

def data_object_type
  @data_object_type
end

#description ⇒ String

Description of OPSI data object.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 34

def description
  @description
end

#display_name ⇒ String

[Required] User-friendly name of OPSI data object.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 30

def display_name
  @display_name
end

#group_names ⇒ Array<String>

Names of all the groups to which the data object belongs to.

Returns:

  • (Array<String>) 


42
43
44
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 42

def group_names
  @group_names
end

#identifier ⇒ String

[Required] Unique identifier of OPSI data object.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 22

def identifier
  @identifier
end

#name ⇒ String

Name of the data object, which can be used in data object queries just like how view names are used in a query.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 38

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 45

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'identifier': :'identifier',
    'data_object_type': :'dataObjectType',
    'display_name': :'displayName',
    'description': :'description',
    'name': :'name',
    'group_names': :'groupNames'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 77

def self.get_subtype(object_hash)
  type = object_hash[:'dataObjectType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Opsi::Models::HostInsightsDataObjectSummary' if type == 'HOST_INSIGHTS_DATA_OBJECT'
  return 'OCI::Opsi::Models::DatabaseInsightsDataObjectSummary' if type == 'DATABASE_INSIGHTS_DATA_OBJECT'
  return 'OCI::Opsi::Models::ExadataInsightsDataObjectSummary' if type == 'EXADATA_INSIGHTS_DATA_OBJECT'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Opsi::Models::OpsiDataObjectSummary'
end

.swagger_types ⇒ Object

Attribute type mapping.



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 59

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'identifier': :'String',
    'data_object_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'name': :'String',
    'group_names': :'Array<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



152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 152

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

  self.class == other.class &&
    identifier == other.identifier &&
    data_object_type == other.data_object_type &&
    display_name == other.display_name &&
    description == other.description &&
    name == other.name &&
    group_names == other.group_names
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



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 187

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


167
168
169
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 167

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



176
177
178
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 176

def hash
  [identifier, data_object_type, display_name, description, name, group_names].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



220
221
222
223
224
225
226
227
228
229
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 220

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



214
215
216
 
# File 'lib/oci/opsi/models/opsi_data_object_summary.rb', line 214

def to_s
  to_hash.to_s
end