Class: OCI::StackMonitoring::Models::CreateMonitoredResourceTypeDetails

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

Overview

The information about new monitored resource type. The resource type name should be unique across tenancy. A set of resource types are created by the service by default. These resource types are available for all tenancies. Service provided resource types can not be duplicated or overwritten in any tenancy.

Constant Summary collapse

SOURCE_TYPE_ENUM = 
[
  SOURCE_TYPE_SM_MGMT_AGENT_MONITORED = 'SM_MGMT_AGENT_MONITORED'.freeze,
  SOURCE_TYPE_SM_REPO_ONLY = 'SM_REPO_ONLY'.freeze,
  SOURCE_TYPE_OCI_NATIVE = 'OCI_NATIVE'.freeze,
  SOURCE_TYPE_PROMETHEUS = 'PROMETHEUS'.freeze,
  SOURCE_TYPE_TELEGRAF = 'TELEGRAF'.freeze,
  SOURCE_TYPE_COLLECTD = 'COLLECTD'.freeze
].freeze
RESOURCE_CATEGORY_ENUM = 
[
  RESOURCE_CATEGORY_APPLICATION = 'APPLICATION'.freeze,
  RESOURCE_CATEGORY_DATABASE = 'DATABASE'.freeze,
  RESOURCE_CATEGORY_MIDDLEWARE = 'MIDDLEWARE'.freeze,
  RESOURCE_CATEGORY_UNKNOWN = 'UNKNOWN'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateMonitoredResourceTypeDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 130

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

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

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

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

  self.source_type = attributes[:'sourceType'] if attributes[:'sourceType']

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

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

  self.resource_category = attributes[:'resourceCategory'] if attributes[:'resourceCategory']

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

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

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

  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

#compartment_id ⇒ String

[Required] The OCID of the tenancy containing the resource type.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
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>>) 


76
77
78
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 76

def defined_tags
  @defined_tags
end

#description ⇒ String

A friendly description.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 42

def description
  @description
end

#display_name ⇒ String

Monitored resource type display name.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 38

def display_name
  @display_name
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>) 


70
71
72
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 70

def freeform_tags
  @freeform_tags
end

#metadata ⇒ OCI::StackMonitoring::Models::ResourceTypeMetadataDetails

Returns:



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

def metadata
  @metadata
end

#metric_namespace ⇒ String

Metric namespace for resource type.

Returns:

  • (String) 


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

def metric_namespace
  @metric_namespace
end

#name ⇒ String

[Required] A unique monitored resource type name. The name must be unique across tenancy. Name can not be changed.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 34

def name
  @name
end

#resource_category ⇒ String

Resource Category to indicate the kind of resource type.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 61

def resource_category
  @resource_category
end

#source_type ⇒ String

Source type to indicate if the resource is stack monitoring discovered, OCI native resource, etc.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 56

def source_type
  @source_type
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 79

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'metric_namespace': :'metricNamespace',
    'source_type': :'sourceType',
    'resource_category': :'resourceCategory',
    'metadata': :'metadata',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 97

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'metric_namespace': :'String',
    'source_type': :'String',
    'resource_category': :'String',
    'metadata': :'OCI::StackMonitoring::Models::ResourceTypeMetadataDetails',
    '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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 208

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

  self.class == other.class &&
    name == other.name &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    metric_namespace == other.metric_namespace &&
    source_type == other.source_type &&
    resource_category == other.resource_category &&
    metadata == other.metadata &&
    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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 247

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


227
228
229
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 227

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



236
237
238
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 236

def hash
  [name, display_name, description, compartment_id, metric_namespace, source_type, resource_category, metadata, 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



280
281
282
283
284
285
286
287
288
289
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 280

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



274
275
276
 
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 274

def to_s
  to_hash.to_s
end