Class: OCI::FleetAppsManagement::Models::ReportDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_apps_management/models/report_details.rb

Overview

fetch reports for FAM based on filter.

Constant Summary collapse

GRANULARITY_ENUM = 
[
  GRANULARITY_DAY = 'DAY'.freeze,
  GRANULARITY_WEEK = 'WEEK'.freeze,
  GRANULARITY_MONTH = 'MONTH'.freeze,
  GRANULARITY_QUARTER = 'QUARTER'.freeze,
  GRANULARITY_YEAR = 'YEAR'.freeze
].freeze
CONDITION_ENUM = 
[
  CONDITION_ALL = 'ALL'.freeze,
  CONDITION_ANY = 'ANY'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ReportDetails

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/fleet_apps_management/models/report_details.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.granularity = attributes[:'granularity'] if attributes[:'granularity']

  self.report_time_range = attributes[:'reportTimeRange'] if attributes[:'reportTimeRange']

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

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

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

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

  self.order_clause = attributes[:'orderClause'] if attributes[:'orderClause']

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

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

Instance Attribute Details

#condition ⇒ String

Condition.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/fleet_apps_management/models/report_details.rb', line 40

def condition
  @condition
end

#filters ⇒ Array<OCI::FleetAppsManagement::Models::Filter>

Filters for reports.

Returns:



44
45
46
 
# File 'lib/oci/fleet_apps_management/models/report_details.rb', line 44

def filters
  @filters
end

#granularity ⇒ String

Granularity.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/fleet_apps_management/models/report_details.rb', line 32

def granularity
  @granularity
end

#name ⇒ String

[Required] Name of report.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/fleet_apps_management/models/report_details.rb', line 27

def name
  @name
end

#order_clause ⇒ Array<OCI::FleetAppsManagement::Models::OrderClause>

order clauses for reports.

Returns:



48
49
50
 
# File 'lib/oci/fleet_apps_management/models/report_details.rb', line 48

def order_clause
  @order_clause
end

#report_time_range ⇒ OCI::FleetAppsManagement::Models::ReportTimeRange

Returns:



35
36
37
 
# File 'lib/oci/fleet_apps_management/models/report_details.rb', line 35

def report_time_range
  @report_time_range
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/fleet_apps_management/models/report_details.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'granularity': :'granularity',
    'report_time_range': :'reportTimeRange',
    'condition': :'condition',
    'filters': :'filters',
    'order_clause': :'orderClause'
    # 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/fleet_apps_management/models/report_details.rb', line 65

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'granularity': :'String',
    'report_time_range': :'OCI::FleetAppsManagement::Models::ReportTimeRange',
    'condition': :'String',
    'filters': :'Array<OCI::FleetAppsManagement::Models::Filter>',
    'order_clause': :'Array<OCI::FleetAppsManagement::Models::OrderClause>'
    # 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



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/fleet_apps_management/models/report_details.rb', line 140

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

  self.class == other.class &&
    name == other.name &&
    granularity == other.granularity &&
    report_time_range == other.report_time_range &&
    condition == other.condition &&
    filters == other.filters &&
    order_clause == other.order_clause
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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/fleet_apps_management/models/report_details.rb', line 175

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


155
156
157
 
# File 'lib/oci/fleet_apps_management/models/report_details.rb', line 155

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



164
165
166
 
# File 'lib/oci/fleet_apps_management/models/report_details.rb', line 164

def hash
  [name, granularity, report_time_range, condition, filters, order_clause].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



208
209
210
211
212
213
214
215
216
217
 
# File 'lib/oci/fleet_apps_management/models/report_details.rb', line 208

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



202
203
204
 
# File 'lib/oci/fleet_apps_management/models/report_details.rb', line 202

def to_s
  to_hash.to_s
end