Class: OCI::Monitoring::Models::PostMetricDataDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/monitoring/models/post_metric_data_details.rb

Overview

An array of metric objects containing raw metric data points to be posted to the Monitoring service.

Constant Summary collapse

BATCH_ATOMICITY_ENUM = 
[
  BATCH_ATOMICITY_ATOMIC = 'ATOMIC'.freeze,
  BATCH_ATOMICITY_NON_ATOMIC = 'NON_ATOMIC'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostMetricDataDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/monitoring/models/post_metric_data_details.rb', line 62

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

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

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

  self.batch_atomicity = attributes[:'batchAtomicity'] if attributes[:'batchAtomicity']
  self.batch_atomicity = "NON_ATOMIC" if batch_atomicity.nil? && !attributes.key?(:'batchAtomicity') # rubocop:disable Style/StringLiterals

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

  self.batch_atomicity = attributes[:'batch_atomicity'] if attributes[:'batch_atomicity']
  self.batch_atomicity = "NON_ATOMIC" if batch_atomicity.nil? && !attributes.key?(:'batchAtomicity') && !attributes.key?(:'batch_atomicity') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#batch_atomicity ⇒ String

Batch atomicity behavior. Requires either partial or full pass of input validation for metric objects in PostMetricData requests. The default value of NON_ATOMIC requires a partial pass: at least one metric object in the request must pass input validation, and any objects that failed validation are identified in the returned summary, along with their error messages. A value of ATOMIC requires a full pass: all metric objects in the request must pass input validation.

Example: NON_ATOMIC

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/monitoring/models/post_metric_data_details.rb', line 32

def batch_atomicity
  @batch_atomicity
end

#metric_data ⇒ Array<OCI::Monitoring::Models::MetricDataDetails>

[Required] A metric object containing raw metric data points to be posted to the Monitoring service.

Returns:



20
21
22
 
# File 'lib/oci/monitoring/models/post_metric_data_details.rb', line 20

def metric_data
  @metric_data
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
 
# File 'lib/oci/monitoring/models/post_metric_data_details.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'metric_data': :'metricData',
    'batch_atomicity': :'batchAtomicity'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
 
# File 'lib/oci/monitoring/models/post_metric_data_details.rb', line 45

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'metric_data': :'Array<OCI::Monitoring::Models::MetricDataDetails>',
    'batch_atomicity': :'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



98
99
100
101
102
103
104
 
# File 'lib/oci/monitoring/models/post_metric_data_details.rb', line 98

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

  self.class == other.class &&
    metric_data == other.metric_data &&
    batch_atomicity == other.batch_atomicity
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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/oci/monitoring/models/post_metric_data_details.rb', line 129

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


109
110
111
 
# File 'lib/oci/monitoring/models/post_metric_data_details.rb', line 109

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



118
119
120
 
# File 'lib/oci/monitoring/models/post_metric_data_details.rb', line 118

def hash
  [metric_data, batch_atomicity].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/oci/monitoring/models/post_metric_data_details.rb', line 162

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



156
157
158
 
# File 'lib/oci/monitoring/models/post_metric_data_details.rb', line 156

def to_s
  to_hash.to_s
end