Class: OCI::ResourceSearch::Models::ResourceSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/resource_search/models/resource_summary.rb

Overview

A resource that exists in the user’s cloud network.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResourceSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/oci/resource_search/models/resource_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.resource_type = attributes[:'resourceType'] if attributes[:'resourceType']

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

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

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.search_context = attributes[:'searchContext'] if attributes[:'searchContext']

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

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

Instance Attribute Details

#availability_domain ⇒ String

The availability domain this resource is located in, if applicable.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 31

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains this resource.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 19

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

The defined tags associated with this resource, if any.

Returns:

  • (Hash<String, Hash<String, Object>>) 


43
44
45
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 43

def defined_tags
  @defined_tags
end

#display_name ⇒ String

The display name (or name) of this resource, if one exists.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 27

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

The freeform tags associated with this resource, if any.

Returns:

  • (Hash<String, String>) 


39
40
41
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 39

def freeform_tags
  @freeform_tags
end

#identifier ⇒ String

[Required] The unique identifier for this particular resource, usually an OCID.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 15

def identifier
  @identifier
end

#lifecycle_state ⇒ String

The lifecycle state of this resource, if applicable.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 35

def lifecycle_state
  @lifecycle_state
end

#resource_type ⇒ String

[Required] The resource type name.

Returns:

  • (String) 


11
12
13
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 11

def resource_type
  @resource_type
end

#search_context ⇒ OCI::ResourceSearch::Models::SearchContext

Contains search context, such as highlighting, for found resources.

Returns:



47
48
49
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 47

def search_context
  @search_context
end

#time_created ⇒ DateTime

The time this resource was created.

Returns:

  • (DateTime) 


23
24
25
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 23

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 50

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'resource_type': :'resourceType',
    'identifier': :'identifier',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'display_name': :'displayName',
    'availability_domain': :'availabilityDomain',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'search_context': :'searchContext'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 68

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'resource_type': :'String',
    'identifier': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'display_name': :'String',
    'availability_domain': :'String',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'search_context': :'OCI::ResourceSearch::Models::SearchContext'
    # 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



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 171

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

  self.class == other.class &&
    resource_type == other.resource_type &&
    identifier == other.identifier &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    display_name == other.display_name &&
    availability_domain == other.availability_domain &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    search_context == other.search_context
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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 210

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


190
191
192
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 190

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



199
200
201
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 199

def hash
  [resource_type, identifier, compartment_id, time_created, display_name, availability_domain, lifecycle_state, freeform_tags, defined_tags, search_context].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 243

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



237
238
239
 
# File 'lib/oci/resource_search/models/resource_summary.rb', line 237

def to_s
  to_hash.to_s
end