Class: OCI::StackMonitoring::Models::CreateMonitoredResourceDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/stack_monitoring/models/create_monitored_resource_details.rb

Overview

The information about new monitored resource to be created. The combination of monitored resource name and type should be unique across tenancy.

Constant Summary collapse

LICENSE_ENUM = 
[
  LICENSE_STANDARD_EDITION = 'STANDARD_EDITION'.freeze,
  LICENSE_ENTERPRISE_EDITION = 'ENTERPRISE_EDITION'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateMonitoredResourceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 185

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

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

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

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

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

  self.external_id = attributes[:'externalId'] if attributes[:'externalId']

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

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

  self.management_agent_id = attributes[:'managementAgentId'] if attributes[:'managementAgentId']

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

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

  self.resource_time_zone = attributes[:'resourceTimeZone'] if attributes[:'resourceTimeZone']
  self.resource_time_zone = "Etc/UTC" if resource_time_zone.nil? && !attributes.key?(:'resourceTimeZone') # rubocop:disable Style/StringLiterals

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

  self.resource_time_zone = attributes[:'resource_time_zone'] if attributes[:'resource_time_zone']
  self.resource_time_zone = "Etc/UTC" if resource_time_zone.nil? && !attributes.key?(:'resourceTimeZone') && !attributes.key?(:'resource_time_zone') # rubocop:disable Style/StringLiterals

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

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

  self.database_connection_details = attributes[:'databaseConnectionDetails'] if attributes[:'databaseConnectionDetails']

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

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

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

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

  self.additional_credentials = attributes[:'additionalCredentials'] if attributes[:'additionalCredentials']

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

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

  self.additional_aliases = attributes[:'additionalAliases'] if attributes[:'additionalAliases']

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

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

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

Instance Attribute Details

#additional_aliases ⇒ Array<OCI::StackMonitoring::Models::MonitoredResourceAliasCredential>

List of MonitoredResourceAliasCredentials. This property complements the existing "aliases" property by allowing user to specify more than one credential alias. If both "aliases" and "additionalAliases" are specified, union of the values is used as list of aliases applicable for this resource. If any duplicate found in the combined list of "alias" and "additionalAliases", an error will be thrown.

Returns:



98
99
100
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 98

def additional_aliases
  @additional_aliases
end

#additional_credentials ⇒ Array<OCI::StackMonitoring::Models::MonitoredResourceCredential>

List of MonitoredResourceCredentials. This property complements the existing "credentials" property by allowing user to specify more than one credential. If both "credential" and "additionalCredentials" are specified, union of the values is used as list of credentials applicable for this resource. If any duplicate found in the combined list of "credentials" and "additionalCredentials", an error will be thrown.

Returns:



88
89
90
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 88

def additional_credentials
  @additional_credentials
end

#aliases ⇒ OCI::StackMonitoring::Models::MonitoredResourceAliasCredential

Returns:



78
79
80
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 78

def aliases
  @aliases
end

#compartment_id ⇒ String

[Required] Compartment Identifier OCID.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 35

def compartment_id
  @compartment_id
end

#credentials ⇒ OCI::StackMonitoring::Models::MonitoredResourceCredential

Returns:



75
76
77
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 75

def credentials
  @credentials
end

#database_connection_details ⇒ OCI::StackMonitoring::Models::ConnectionDetails

Returns:



72
73
74
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 72

def database_connection_details
  @database_connection_details
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


110
111
112
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 110

def defined_tags
  @defined_tags
end

#display_name ⇒ String

Monitored resource display name.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 25

def display_name
  @display_name
end

#external_id ⇒ String

External resource is any OCI resource identifier OCID which is not a Stack Monitoring service resource. Currently supports only OCI compute instance.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 47

def external_id
  @external_id
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


104
105
106
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 104

def freeform_tags
  @freeform_tags
end

#host_name ⇒ String

Host name of the monitored resource.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 40

def host_name
  @host_name
end

#license ⇒ String

License edition of the monitored resource. If not provided the default license type for the compartment will be used.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 64

def license
  @license
end

#management_agent_id ⇒ String

Management Agent Identifier OCID.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 51

def management_agent_id
  @management_agent_id
end

#name ⇒ String

[Required] Monitored Resource Name.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 21

def name
  @name
end

#properties ⇒ Array<OCI::StackMonitoring::Models::MonitoredResourceProperty>

List of monitored resource properties.

Returns:



69
70
71
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 69

def properties
  @properties
end

#resource_time_zone ⇒ String

Time zone in the form of tz database canonical zone ID. Specifies the preference with a value that uses the IANA Time Zone Database format (x-obmcs-time-zone). For example - America/Los_Angeles

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 58

def resource_time_zone
  @resource_time_zone
end

#type ⇒ String

[Required] Monitored Resource Type.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 30

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 113

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'display_name': :'displayName',
    'type': :'type',
    'compartment_id': :'compartmentId',
    'host_name': :'hostName',
    'external_id': :'externalId',
    'management_agent_id': :'managementAgentId',
    'resource_time_zone': :'resourceTimeZone',
    'license': :'license',
    'properties': :'properties',
    'database_connection_details': :'databaseConnectionDetails',
    'credentials': :'credentials',
    'aliases': :'aliases',
    'additional_credentials': :'additionalCredentials',
    'additional_aliases': :'additionalAliases',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 138

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'display_name': :'String',
    'type': :'String',
    'compartment_id': :'String',
    'host_name': :'String',
    'external_id': :'String',
    'management_agent_id': :'String',
    'resource_time_zone': :'String',
    'license': :'String',
    'properties': :'Array<OCI::StackMonitoring::Models::MonitoredResourceProperty>',
    'database_connection_details': :'OCI::StackMonitoring::Models::ConnectionDetails',
    'credentials': :'OCI::StackMonitoring::Models::MonitoredResourceCredential',
    'aliases': :'OCI::StackMonitoring::Models::MonitoredResourceAliasCredential',
    'additional_credentials': :'Array<OCI::StackMonitoring::Models::MonitoredResourceCredential>',
    'additional_aliases': :'Array<OCI::StackMonitoring::Models::MonitoredResourceAliasCredential>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 287

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

  self.class == other.class &&
    name == other.name &&
    display_name == other.display_name &&
    type == other.type &&
    compartment_id == other.compartment_id &&
    host_name == other.host_name &&
    external_id == other.external_id &&
    management_agent_id == other.management_agent_id &&
    resource_time_zone == other.resource_time_zone &&
    license == other.license &&
    properties == other.properties &&
    database_connection_details == other.database_connection_details &&
    credentials == other.credentials &&
    aliases == other.aliases &&
    additional_credentials == other.additional_credentials &&
    additional_aliases == other.additional_aliases &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 333

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


313
314
315
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 313

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



322
323
324
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 322

def hash
  [name, display_name, type, compartment_id, host_name, external_id, management_agent_id, resource_time_zone, license, properties, database_connection_details, credentials, aliases, additional_credentials, additional_aliases, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



366
367
368
369
370
371
372
373
374
375
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 366

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



360
361
362
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_details.rb', line 360

def to_s
  to_hash.to_s
end