Class: OCI::ApmTraces::Models::BulkActivateAttributeDetail

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

Overview

Object that contains the details about a single attribute in the bulk request to be activated. The attributeNameSpace and unit are optional parameters, and the attributeNameSpace will default to TRACES if it is not passed in.

Constant Summary collapse

ATTRIBUTE_TYPE_ENUM =
[
  ATTRIBUTE_TYPE_NUMERIC = 'NUMERIC'.freeze,
  ATTRIBUTE_TYPE_STRING = 'STRING'.freeze,
  ATTRIBUTE_TYPE_NONE = 'NONE'.freeze
].freeze
UNIT_ENUM =
[
  UNIT_NONE = 'NONE'.freeze,
  UNIT_EPOCH_TIME_MS = 'EPOCH_TIME_MS'.freeze,
  UNIT_BYTES = 'BYTES'.freeze,
  UNIT_COUNT = 'COUNT'.freeze,
  UNIT_DURATION_MS = 'DURATION_MS'.freeze,
  UNIT_TRACE_STATUS = 'TRACE_STATUS'.freeze,
  UNIT_PERCENTAGE = 'PERCENTAGE'.freeze
].freeze
ATTRIBUTE_NAME_SPACE_ENUM =
[
  ATTRIBUTE_NAME_SPACE_TRACES = 'TRACES'.freeze,
  ATTRIBUTE_NAME_SPACE_SYNTHETIC = 'SYNTHETIC'.freeze,
  ATTRIBUTE_NAME_SPACE_LOGS = 'LOGS'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BulkActivateAttributeDetail

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :attribute_name (String)

    The value to assign to the #attribute_name property

  • :attribute_type (String)

    The value to assign to the #attribute_type property

  • :attribute_expression (String)

    The value to assign to the #attribute_expression property

  • :unit (String)

    The value to assign to the #unit property

  • :attribute_name_space (String)

    The value to assign to the #attribute_name_space property



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
# File 'lib/oci/apm_traces/models/bulk_activate_attribute_detail.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.attribute_name = attributes[:'attributeName'] if attributes[:'attributeName']

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

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

  self.attribute_type = attributes[:'attributeType'] if attributes[:'attributeType']

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

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

  self.attribute_expression = attributes[:'attributeExpression'] if attributes[:'attributeExpression']

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

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

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

  self.attribute_name_space = attributes[:'attributeNameSpace'] if attributes[:'attributeNameSpace']
  self.attribute_name_space = "TRACES" if attribute_name_space.nil? && !attributes.key?(:'attributeNameSpace') # rubocop:disable Style/StringLiterals

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

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

Instance Attribute Details

#attribute_expressionString

Attribute expression if this attribute is an alias

Returns:

  • (String)


48
49
50
# File 'lib/oci/apm_traces/models/bulk_activate_attribute_detail.rb', line 48

def attribute_expression
  @attribute_expression
end

#attribute_nameString

[Required] Name of the attribute to be activated.

Returns:

  • (String)


38
39
40
# File 'lib/oci/apm_traces/models/bulk_activate_attribute_detail.rb', line 38

def attribute_name
  @attribute_name
end

#attribute_name_spaceString

Namespace of the attribute to be activated. The attributeNameSpace will default to TRACES if it is not passed in.

Returns:

  • (String)


59
60
61
# File 'lib/oci/apm_traces/models/bulk_activate_attribute_detail.rb', line 59

def attribute_name_space
  @attribute_name_space
end

#attribute_typeString

[Required] Type of the attribute to be activated.

Returns:

  • (String)


43
44
45
# File 'lib/oci/apm_traces/models/bulk_activate_attribute_detail.rb', line 43

def attribute_type
  @attribute_type
end

#unitString

Unit of the attribute to be updated. If unit is not specified, it defaults to NONE.

Returns:

  • (String)


53
54
55
# File 'lib/oci/apm_traces/models/bulk_activate_attribute_detail.rb', line 53

def unit
  @unit
end

Class Method Details

.attribute_mapObject

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



62
63
64
65
66
67
68
69
70
71
72
# File 'lib/oci/apm_traces/models/bulk_activate_attribute_detail.rb', line 62

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'attribute_name': :'attributeName',
    'attribute_type': :'attributeType',
    'attribute_expression': :'attributeExpression',
    'unit': :'unit',
    'attribute_name_space': :'attributeNameSpace'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
# File 'lib/oci/apm_traces/models/bulk_activate_attribute_detail.rb', line 75

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'attribute_name': :'String',
    'attribute_type': :'String',
    'attribute_expression': :'String',
    'unit': :'String',
    'attribute_name_space': :'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



164
165
166
167
168
169
170
171
172
173
# File 'lib/oci/apm_traces/models/bulk_activate_attribute_detail.rb', line 164

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

  self.class == other.class &&
    attribute_name == other.attribute_name &&
    attribute_type == other.attribute_type &&
    attribute_expression == other.attribute_expression &&
    unit == other.unit &&
    attribute_name_space == other.attribute_name_space
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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
# File 'lib/oci/apm_traces/models/bulk_activate_attribute_detail.rb', line 198

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


178
179
180
# File 'lib/oci/apm_traces/models/bulk_activate_attribute_detail.rb', line 178

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



187
188
189
# File 'lib/oci/apm_traces/models/bulk_activate_attribute_detail.rb', line 187

def hash
  [attribute_name, attribute_type, attribute_expression, unit, attribute_name_space].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



231
232
233
234
235
236
237
238
239
240
# File 'lib/oci/apm_traces/models/bulk_activate_attribute_detail.rb', line 231

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



225
226
227
# File 'lib/oci/apm_traces/models/bulk_activate_attribute_detail.rb', line 225

def to_s
  to_hash.to_s
end