Class: OCI::UsageApi::Models::DynamicDateRange

Inherits:
DateRange
  • Object
show all
Defined in:
lib/oci/usage_api/models/dynamic_date_range.rb

Overview

The saved dynamic date range (required when the static date range is missing).

Constant Summary collapse

DYNAMIC_DATE_RANGE_TYPE_ENUM = 
[
  DYNAMIC_DATE_RANGE_TYPE_LAST_7_DAYS = 'LAST_7_DAYS'.freeze,
  DYNAMIC_DATE_RANGE_TYPE_LAST_10_DAYS = 'LAST_10_DAYS'.freeze,
  DYNAMIC_DATE_RANGE_TYPE_LAST_CALENDAR_WEEK = 'LAST_CALENDAR_WEEK'.freeze,
  DYNAMIC_DATE_RANGE_TYPE_LAST_CALENDAR_MONTH = 'LAST_CALENDAR_MONTH'.freeze,
  DYNAMIC_DATE_RANGE_TYPE_LAST_2_CALENDAR_MONTHS = 'LAST_2_CALENDAR_MONTHS'.freeze,
  DYNAMIC_DATE_RANGE_TYPE_LAST_3_CALENDAR_MONTHS = 'LAST_3_CALENDAR_MONTHS'.freeze,
  DYNAMIC_DATE_RANGE_TYPE_LAST_6_CALENDAR_MONTHS = 'LAST_6_CALENDAR_MONTHS'.freeze,
  DYNAMIC_DATE_RANGE_TYPE_LAST_30_DAYS = 'LAST_30_DAYS'.freeze,
  DYNAMIC_DATE_RANGE_TYPE_MONTH_TO_DATE = 'MONTH_TO_DATE'.freeze,
  DYNAMIC_DATE_RANGE_TYPE_LAST_YEAR = 'LAST_YEAR'.freeze,
  DYNAMIC_DATE_RANGE_TYPE_YEAR_TODATE = 'YEAR_TODATE'.freeze,
  DYNAMIC_DATE_RANGE_TYPE_ALL = 'ALL'.freeze,
  DYNAMIC_DATE_RANGE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Constants inherited from DateRange

OCI::UsageApi::Models::DateRange::DATE_RANGE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from DateRange

#date_range_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DateRange

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DynamicDateRange

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/usage_api/models/dynamic_date_range.rb', line 60

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['dateRangeType'] = 'DYNAMIC'

  super(attributes)

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

  self.dynamic_date_range_type = attributes[:'dynamicDateRangeType'] if attributes[:'dynamicDateRangeType']

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

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

Instance Attribute Details

#dynamic_date_range_type ⇒ String

This attribute is required.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/usage_api/models/dynamic_date_range.rb', line 31

def dynamic_date_range_type
  @dynamic_date_range_type
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
 
# File 'lib/oci/usage_api/models/dynamic_date_range.rb', line 34

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'date_range_type': :'dateRangeType',
    'dynamic_date_range_type': :'dynamicDateRangeType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
 
# File 'lib/oci/usage_api/models/dynamic_date_range.rb', line 44

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'date_range_type': :'String',
    'dynamic_date_range_type': :'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



97
98
99
100
101
102
103
 
# File 'lib/oci/usage_api/models/dynamic_date_range.rb', line 97

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

  self.class == other.class &&
    date_range_type == other.date_range_type &&
    dynamic_date_range_type == other.dynamic_date_range_type
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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/usage_api/models/dynamic_date_range.rb', line 128

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


108
109
110
 
# File 'lib/oci/usage_api/models/dynamic_date_range.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/oci/usage_api/models/dynamic_date_range.rb', line 117

def hash
  [date_range_type, dynamic_date_range_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/usage_api/models/dynamic_date_range.rb', line 161

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



155
156
157
 
# File 'lib/oci/usage_api/models/dynamic_date_range.rb', line 155

def to_s
  to_hash.to_s
end