class OCI::UsageApi::Models::SavedCustomTable

The custom table for Cost Analysis UI rendering.

Attributes

column_group_by[RW]

The column groupBy key list. example:

`[\"tagNamespace\", \"tagKey\", \"tagValue\", \"service\", \"skuName\", \"skuPartNumber\", \"unit\",
  \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\",
  \"resourceId\", \"tenantId\", \"tenantName\"]`

@return [Array<String>]

compartment_depth[RW]

The compartment depth level. @return [Float]

display_name[RW]

[Required] The name of the custom table. @return [String]

group_by_tag[RW]

GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only one tag in the list is supported. For example:

`[{\"namespace\":\"oracle\", \"key\":\"createdBy\"]`

@return [Array<OCI::UsageApi::Models::Tag>]

row_group_by[RW]

The row groupBy key list. example:

`[\"tagNamespace\", \"tagKey\", \"tagValue\", \"service\", \"skuName\", \"skuPartNumber\", \"unit\",
  \"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\",
  \"resourceId\", \"tenantId\", \"tenantName\"]`

@return [Array<String>]

version[RW]

The version of the custom table. @return [Float]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/usage_api/models/saved_custom_table.rb, line 48
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'row_group_by': :'rowGroupBy',
    'column_group_by': :'columnGroupBy',
    'group_by_tag': :'groupByTag',
    'compartment_depth': :'compartmentDepth',
    'version': :'version'
    # 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 {#display_name} property @option attributes [Array<String>] :row_group_by The value to assign to the {#row_group_by} property @option attributes [Array<String>] :column_group_by The value to assign to the {#column_group_by} property @option attributes [Array<OCI::UsageApi::Models::Tag>] :group_by_tag The value to assign to the {#group_by_tag} property @option attributes [Float] :compartment_depth The value to assign to the {#compartment_depth} property @option attributes [Float] :version The value to assign to the {#version} property

# File lib/oci/usage_api/models/saved_custom_table.rb, line 87
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.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

  self.row_group_by = attributes[:'rowGroupBy'] if attributes[:'rowGroupBy']

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

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

  self.column_group_by = attributes[:'columnGroupBy'] if attributes[:'columnGroupBy']

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

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

  self.group_by_tag = attributes[:'groupByTag'] if attributes[:'groupByTag']

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

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

  self.compartment_depth = attributes[:'compartmentDepth'] if attributes[:'compartmentDepth']

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

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

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

Attribute type mapping.

# File lib/oci/usage_api/models/saved_custom_table.rb, line 62
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'row_group_by': :'Array<String>',
    'column_group_by': :'Array<String>',
    'group_by_tag': :'Array<OCI::UsageApi::Models::Tag>',
    'compartment_depth': :'Float',
    'version': :'Float'
    # 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/usage_api/models/saved_custom_table.rb, line 133
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    display_name == other.display_name &&
    row_group_by == other.row_group_by &&
    column_group_by == other.column_group_by &&
    group_by_tag == other.group_by_tag &&
    compartment_depth == other.compartment_depth &&
    version == other.version
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/usage_api/models/saved_custom_table.rb, line 168
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/usage_api/models/saved_custom_table.rb, line 148
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/usage_api/models/saved_custom_table.rb, line 157
def hash
  [display_name, row_group_by, column_group_by, group_by_tag, compartment_depth, version].hash
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/usage_api/models/saved_custom_table.rb, line 201
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/usage_api/models/saved_custom_table.rb, line 195
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/usage_api/models/saved_custom_table.rb, line 218
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