Class: OCI::LogAnalytics::Models::VariableDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/log_analytics/models/variable_definition.rb

Overview

Defines a variable used in a macro or the initization section of a query.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_NUMBER = 'NUMBER'.freeze,
  TYPE_STRING = 'STRING'.freeze,
  TYPE_TIMESTAMP = 'TIMESTAMP'.freeze,
  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 = {}) ⇒ VariableDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 90

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

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

  self.map_keys = attributes[:'mapKeys'] if attributes[:'mapKeys']

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

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

  self.default_value = attributes[:'defaultValue'] if attributes[:'defaultValue']

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

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

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

Instance Attribute Details

#default_value ⇒ String

Default value of the variable is not already set.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 43

def default_value
  @default_value
end

#description ⇒ String

Descripion of the variable to show the user.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 28

def description
  @description
end

#map_keys ⇒ Array<OCI::LogAnalytics::Models::VariableDefinition>

List of variables if this variable is a map.

Returns:



38
39
40
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 38

def map_keys
  @map_keys
end

#name ⇒ String

[Required] Name of the variable preceded by a $.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 23

def name
  @name
end

#properties ⇒ Array<OCI::LogAnalytics::Models::PropertyDefinition>

Optional list of properties for the variable.

Returns:



48
49
50
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 48

def properties
  @properties
end

#type ⇒ String

Type of the variable to show the user.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 33

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'description': :'description',
    'type': :'type',
    'map_keys': :'mapKeys',
    'default_value': :'defaultValue',
    'properties': :'properties'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 65

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'description': :'String',
    'type': :'String',
    'map_keys': :'Array<OCI::LogAnalytics::Models::VariableDefinition>',
    'default_value': :'String',
    'properties': :'Array<OCI::LogAnalytics::Models::PropertyDefinition>'
    # 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



137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 137

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

  self.class == other.class &&
    name == other.name &&
    description == other.description &&
    type == other.type &&
    map_keys == other.map_keys &&
    default_value == other.default_value &&
    properties == other.properties
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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 172

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


152
153
154
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 152

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



161
162
163
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 161

def hash
  [name, description, type, map_keys, default_value, properties].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 205

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



199
200
201
 
# File 'lib/oci/log_analytics/models/variable_definition.rb', line 199

def to_s
  to_hash.to_s
end