class OCI::LogAnalytics::Models::FieldsAddRemoveField

Field denoting a field specified in querylanguage FIELDS command.

Constants

OPERATION_ENUM

Attributes

operation[R]

Denotes if field entry in FIELDS command is to show / hide field in results.

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/log_analytics/models/fields_add_remove_field.rb, line 25
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'display_name': :'displayName',
    'is_declared': :'isDeclared',
    'original_display_names': :'originalDisplayNames',
    'internal_name': :'internalName',
    'value_type': :'valueType',
    'is_groupable': :'isGroupable',
    'is_duration': :'isDuration',
    '_alias': :'alias',
    'filter_query_string': :'filterQueryString',
    'unit_type': :'unitType',
    'operation': :'operation'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :display_name The value to assign to the {OCI::LogAnalytics::Models::AbstractField#display_name display_name} proprety @option attributes [BOOLEAN] :is_declared The value to assign to the {OCI::LogAnalytics::Models::AbstractField#is_declared is_declared} proprety @option attributes [Array<String>] :original_display_names The value to assign to the {OCI::LogAnalytics::Models::AbstractField#original_display_names original_display_names} proprety @option attributes [String] :internal_name The value to assign to the {OCI::LogAnalytics::Models::AbstractField#internal_name internal_name} proprety @option attributes [String] :value_type The value to assign to the {OCI::LogAnalytics::Models::AbstractField#value_type value_type} proprety @option attributes [BOOLEAN] :is_groupable The value to assign to the {OCI::LogAnalytics::Models::AbstractField#is_groupable is_groupable} proprety @option attributes [BOOLEAN] :is_duration The value to assign to the {OCI::LogAnalytics::Models::AbstractField#is_duration is_duration} proprety @option attributes [String] :_alias The value to assign to the {OCI::LogAnalytics::Models::AbstractField#_alias #_alias} proprety @option attributes [String] :filter_query_string The value to assign to the {OCI::LogAnalytics::Models::AbstractField#filter_query_string filter_query_string} proprety @option attributes [String] :unit_type The value to assign to the {OCI::LogAnalytics::Models::AbstractField#unit_type unit_type} proprety @option attributes [String] :operation The value to assign to the {#operation} property

# File lib/oci/log_analytics/models/fields_add_remove_field.rb, line 81
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['name'] = 'FIELDS'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.operation = attributes[:'operation'] if attributes[:'operation']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/log_analytics/models/fields_add_remove_field.rb, line 45
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'display_name': :'String',
    'is_declared': :'BOOLEAN',
    'original_display_names': :'Array<String>',
    'internal_name': :'String',
    'value_type': :'String',
    'is_groupable': :'BOOLEAN',
    'is_duration': :'BOOLEAN',
    '_alias': :'String',
    'filter_query_string': :'String',
    'unit_type': :'String',
    'operation': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/log_analytics/models/fields_add_remove_field.rb, line 114
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    display_name == other.display_name &&
    is_declared == other.is_declared &&
    original_display_names == other.original_display_names &&
    internal_name == other.internal_name &&
    value_type == other.value_type &&
    is_groupable == other.is_groupable &&
    is_duration == other.is_duration &&
    _alias == other._alias &&
    filter_query_string == other.filter_query_string &&
    unit_type == other.unit_type &&
    operation == other.operation
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/log_analytics/models/fields_add_remove_field.rb, line 155
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) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/log_analytics/models/fields_add_remove_field.rb, line 135
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/log_analytics/models/fields_add_remove_field.rb, line 144
def hash
  [name, display_name, is_declared, original_display_names, internal_name, value_type, is_groupable, is_duration, _alias, filter_query_string, unit_type, operation].hash
end
operation=(operation) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] operation Object to be assigned

# File lib/oci/log_analytics/models/fields_add_remove_field.rb, line 98
def operation=(operation)
  # rubocop:disable Style/ConditionalAssignment
  if operation && !OPERATION_ENUM.include?(operation)
    OCI.logger.debug("Unknown value for 'operation' [" + operation + "]. Mapping to 'OPERATION_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @operation = OPERATION_UNKNOWN_ENUM_VALUE
  else
    @operation = operation
  end
  # rubocop:enable Style/ConditionalAssignment
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/log_analytics/models/fields_add_remove_field.rb, line 188
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/log_analytics/models/fields_add_remove_field.rb, line 182
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/log_analytics/models/fields_add_remove_field.rb, line 205
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end