Class: OCI::Opsi::Models::ReportPropertyDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opsi/models/report_property_details.rb

Overview

Chargeback plan report properties.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportPropertyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/opsi/models/report_property_details.rb', line 64

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

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

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

  self.time_interval_start = attributes[:'timeIntervalStart'] if attributes[:'timeIntervalStart']

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

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

  self.time_interval_end = attributes[:'timeIntervalEnd'] if attributes[:'timeIntervalEnd']

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

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

  self.group_by = attributes[:'groupBy'] if attributes[:'groupBy']

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

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

Instance Attribute Details

#analysis_time_interval ⇒ String

[Required] Specify time period in ISO 8601 format with respect to current time. If timeInterval is specified, then timeIntervalStart and timeIntervalEnd will be ignored. Examples P90D (last 90 days), P4W (last 4 weeks), P2M (last 2 months), P1Y (last 12 months), . Maximum value allowed is 25 months prior to current time (P25M).

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/opsi/models/report_property_details.rb', line 16

def analysis_time_interval
  @analysis_time_interval
end

#group_by ⇒ Object

[Required] Report filters used in grouping

Returns:

  • (Object) 


28
29
30
 
# File 'lib/oci/opsi/models/report_property_details.rb', line 28

def group_by
  @group_by
end

#time_interval_end ⇒ DateTime

[Required] The end timestamp that was passed into the request.

Returns:

  • (DateTime) 


24
25
26
 
# File 'lib/oci/opsi/models/report_property_details.rb', line 24

def time_interval_end
  @time_interval_end
end

#time_interval_start ⇒ DateTime

[Required] The start timestamp that was passed into the request.

Returns:

  • (DateTime) 


20
21
22
 
# File 'lib/oci/opsi/models/report_property_details.rb', line 20

def time_interval_start
  @time_interval_start
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
 
# File 'lib/oci/opsi/models/report_property_details.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'analysis_time_interval': :'analysisTimeInterval',
    'time_interval_start': :'timeIntervalStart',
    'time_interval_end': :'timeIntervalEnd',
    'group_by': :'groupBy'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
 
# File 'lib/oci/opsi/models/report_property_details.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'analysis_time_interval': :'String',
    'time_interval_start': :'DateTime',
    'time_interval_end': :'DateTime',
    'group_by': :'Object'
    # 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



102
103
104
105
106
107
108
109
110
 
# File 'lib/oci/opsi/models/report_property_details.rb', line 102

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

  self.class == other.class &&
    analysis_time_interval == other.analysis_time_interval &&
    time_interval_start == other.time_interval_start &&
    time_interval_end == other.time_interval_end &&
    group_by == other.group_by
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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/opsi/models/report_property_details.rb', line 135

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


115
116
117
 
# File 'lib/oci/opsi/models/report_property_details.rb', line 115

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/oci/opsi/models/report_property_details.rb', line 124

def hash
  [analysis_time_interval, time_interval_start, time_interval_end, group_by].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/opsi/models/report_property_details.rb', line 168

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



162
163
164
 
# File 'lib/oci/opsi/models/report_property_details.rb', line 162

def to_s
  to_hash.to_s
end