Class: OCI::ApmTraces::Models::BulkDeActivationMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/apm_traces/models/bulk_de_activation_metadata.rb

Overview

Metadata about the bulk deactivation operation. The bulk deactivation operation is atomic and binary. If the processing of any of the attributes in the bulk deactivation request results in a processing or validation error, then none of the attributes in the request are deactivated. The bulk deactivation request succeeds only when all the attributes in the bulk deactivation request are processed and they get a successful attributeStatus back.

Constant Summary collapse

OPERATION_STATUS_ENUM = 
[
  OPERATION_STATUS_SUCCESS = 'SUCCESS'.freeze,
  OPERATION_STATUS_EMPTY_ATTRIBUTE_LIST = 'EMPTY_ATTRIBUTE_LIST'.freeze,
  OPERATION_STATUS_NUMERIC_ATTRIBUTE_LIMIT_EXCEEDED = 'NUMERIC_ATTRIBUTE_LIMIT_EXCEEDED'.freeze,
  OPERATION_STATUS_STRING_ATTRIBUTE_LIMIT_EXCEEDED = 'STRING_ATTRIBUTE_LIMIT_EXCEEDED'.freeze,
  OPERATION_STATUS_INVALID_BULK_REQUEST = 'INVALID_BULK_REQUEST'.freeze,
  OPERATION_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
OPERATION_TYPE_ENUM = 
[
  OPERATION_TYPE_DEACTIVATE = 'DEACTIVATE'.freeze,
  OPERATION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BulkDeActivationMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 125

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

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

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

  self.operation_type = attributes[:'operationType'] if attributes[:'operationType']

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

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

  self.attributes_de_activated = attributes[:'attributesDeActivated'] if attributes[:'attributesDeActivated']

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

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

  self.synthetic_attributes_de_activated = attributes[:'syntheticAttributesDeActivated'] if attributes[:'syntheticAttributesDeActivated']

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

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

  self.available_string_attributes = attributes[:'availableStringAttributes'] if attributes[:'availableStringAttributes']

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

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

  self.available_numeric_attributes = attributes[:'availableNumericAttributes'] if attributes[:'availableNumericAttributes']

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

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

  self.available_synthetic_string_attributes = attributes[:'availableSyntheticStringAttributes'] if attributes[:'availableSyntheticStringAttributes']

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

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

  self.available_synthetic_numeric_attributes = attributes[:'availableSyntheticNumericAttributes'] if attributes[:'availableSyntheticNumericAttributes']

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

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

Instance Attribute Details

#attributes_de_activated ⇒ Integer

Total number attributes (both string and numeric) in TRACES namespace that were deactivated.

Returns:

  • (Integer) 


52
53
54
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 52

def attributes_de_activated
  @attributes_de_activated
end

#available_numeric_attributes ⇒ Integer

Total number of free slots available for activation of additional numeric attributes in TRACES namespace in the APM Domain.

Returns:

  • (Integer) 


67
68
69
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 67

def available_numeric_attributes
  @available_numeric_attributes
end

#available_string_attributes ⇒ Integer

Total number of free slots available for activation of additional string attributes in TRACES namespace in the APM Domain.

Returns:

  • (Integer) 


62
63
64
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 62

def available_string_attributes
  @available_string_attributes
end

#available_synthetic_numeric_attributes ⇒ Integer

Total number of free slots available for activation of additional numeric attributes in SYNTHETIC namespace in the APM Domain.

Returns:

  • (Integer) 


77
78
79
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 77

def available_synthetic_numeric_attributes
  @available_synthetic_numeric_attributes
end

#available_synthetic_string_attributes ⇒ Integer

Total number of free slots available for activation of additional string attributes in SYNTHETIC namespace in the APM Domain.

Returns:

  • (Integer) 


72
73
74
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 72

def available_synthetic_string_attributes
  @available_synthetic_string_attributes
end

#operation_status ⇒ String

[Required] Operation status of the bulk deactivation operation. The bulk deactivation operation could have either a success or an error status as defined below. Note that if a bulk operation has not succeeded, we do not deactivate any tags in the request set. SUCCESS - The bulk deactivation operation has succeeded and all the attributes in the bulk deactivation request have been deactivated by this operation or deactivated earlier. The following are error statuses for the bulk deactivation operation. Note that none of the attributes (string or numeric) in the bulk request have been deactivated by this bulk deactivation operation if any of the below statuses are returned. EMPTY_ATTRIBUTE_LIST - The bulk deactivation request object was empty and did not contain any attributes to be deactivated. NUMERIC_ATTRIBUTE_LIMIT_EXCEEDED - The number of numeric attributes in the bulk request exceeded the maximum limit (100) of numeric attributes that could be present in the APM Domain. STRING_ATTRIBUTE_LIMIT_EXCEEDED - The number of string attributes in the bulk request exceeded the maximum limit (700) of string attributes that could be present in the APM Domain. INVALID_BULK_REQUEST - The bulk request contains invalid attribute(s), or attribute(s) that resulted in a validation error, or an attribute that resulted in a processing error.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 42

def operation_status
  @operation_status
end

#operation_type ⇒ String

[Required] Type of operation.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 47

def operation_type
  @operation_type
end

#synthetic_attributes_de_activated ⇒ Integer

Total number attributes (both string and numeric) in SYNTHETIC namespace that were deactivated.

Returns:

  • (Integer) 


57
58
59
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 57

def synthetic_attributes_de_activated
  @synthetic_attributes_de_activated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'operation_status': :'operationStatus',
    'operation_type': :'operationType',
    'attributes_de_activated': :'attributesDeActivated',
    'synthetic_attributes_de_activated': :'syntheticAttributesDeActivated',
    'available_string_attributes': :'availableStringAttributes',
    'available_numeric_attributes': :'availableNumericAttributes',
    'available_synthetic_string_attributes': :'availableSyntheticStringAttributes',
    'available_synthetic_numeric_attributes': :'availableSyntheticNumericAttributes'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 96

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'operation_status': :'String',
    'operation_type': :'String',
    'attributes_de_activated': :'Integer',
    'synthetic_attributes_de_activated': :'Integer',
    'available_string_attributes': :'Integer',
    'available_numeric_attributes': :'Integer',
    'available_synthetic_string_attributes': :'Integer',
    'available_synthetic_numeric_attributes': :'Integer'
    # 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



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 213

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

  self.class == other.class &&
    operation_status == other.operation_status &&
    operation_type == other.operation_type &&
    attributes_de_activated == other.attributes_de_activated &&
    synthetic_attributes_de_activated == other.synthetic_attributes_de_activated &&
    available_string_attributes == other.available_string_attributes &&
    available_numeric_attributes == other.available_numeric_attributes &&
    available_synthetic_string_attributes == other.available_synthetic_string_attributes &&
    available_synthetic_numeric_attributes == other.available_synthetic_numeric_attributes
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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 250

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


230
231
232
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 230

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



239
240
241
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 239

def hash
  [operation_status, operation_type, attributes_de_activated, synthetic_attributes_de_activated, available_string_attributes, available_numeric_attributes, available_synthetic_string_attributes, available_synthetic_numeric_attributes].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



283
284
285
286
287
288
289
290
291
292
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 283

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



277
278
279
 
# File 'lib/oci/apm_traces/models/bulk_de_activation_metadata.rb', line 277

def to_s
  to_hash.to_s
end