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.

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



98
99
100
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
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 98

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. = 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_idString

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

Returns:

  • (String)


31
32
33
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 31

def compartment_id
  @compartment_id
end

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


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

def defined_tags
  @defined_tags
end

#descriptionString

A friendly description.

Returns:

  • (String)


26
27
28
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 26

def description
  @description
end

#display_nameString

Monitored resource type display name.

Returns:

  • (String)


22
23
24
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 22

def display_name
  @display_name
end

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


44
45
46
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 44

def freeform_tags
  @freeform_tags
end

#metadataOCI::StackMonitoring::Models::ResourceTypeMetadataDetails



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

def 
  @metadata
end

#metric_namespaceString

Metric namespace for resource type.

Returns:

  • (String)


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

def metric_namespace
  @metric_namespace
end

#nameString

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

Returns:

  • (String)


18
19
20
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 18

def name
  @name
end

Class Method Details

.attribute_mapObject

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 53

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

.swagger_typesObject

Attribute type mapping.



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

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



148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 148

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 &&
     == other. &&
    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



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

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


165
166
167
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 165

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



174
175
176
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 174

def hash
  [name, display_name, description, compartment_id, metric_namespace, , freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



218
219
220
221
222
223
224
225
226
227
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 218

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



212
213
214
# File 'lib/oci/stack_monitoring/models/create_monitored_resource_type_details.rb', line 212

def to_s
  to_hash.to_s
end