class OCI::UsageApi::Models::ReportQuery
The request of the generated Cost Analysis report.
Constants
- DATE_RANGE_NAME_ENUM
- GRANULARITY_ENUM
- QUERY_TYPE_ENUM
Attributes
The compartment depth level. @return [Float]
The UI date range, for example, LAST_THREE_MONTHS. Conflicts with timeUsageStarted and timeUsageEnded. @return [String]
@return [OCI::UsageApi::Models::Filter]
@return [OCI::UsageApi::Models::Forecast]
[Required] The usage granularity. HOURLY - Hourly data aggregation. DAILY - Daily data aggregation. MONTHLY - Monthly data aggregation. TOTAL - Not yet supported.
@return [String]
Aggregate the result by. example:
`[\"tagNamespace\", \"tagKey\", \"tagValue\", \"service\", \"skuName\", \"skuPartNumber\", \"unit\",
\"compartmentName\", \"compartmentPath\", \"compartmentId\", \"platform\", \"region\", \"logicalAd\",
\"resourceId\", \"tenantId\", \"tenantName\"]`
@return [Array<String>]
GroupBy a specific tagKey. Provide the tagNamespace and tagKey in the tag object. Only supports one tag in the list. For example:
`[{\"namespace\":\"oracle\", \"key\":\"createdBy\"]`
@return [Array<OCI::UsageApi::Models::Tag>]
Whether aggregated by time. If isAggregateByTime is true, all usage/cost over the query time period will be added up. @return [BOOLEAN]
The query usage type. COST by default if it is missing. Usage - Query the usage data. Cost - Query the cost/billing data. Credit - Query the credit adjustments data. ExpiredCredit - Query the expired credits data AllCredit - Query the credit adjustments and expired credit
@return [String]
[Required] Tenant ID. @return [String]
The usage end time. @return [DateTime]
The usage start time. @return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/usage_api/models/report_query.rb, line 108 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'tenant_id': :'tenantId', 'time_usage_started': :'timeUsageStarted', 'time_usage_ended': :'timeUsageEnded', 'granularity': :'granularity', 'is_aggregate_by_time': :'isAggregateByTime', 'forecast': :'forecast', 'query_type': :'queryType', 'group_by': :'groupBy', 'group_by_tag': :'groupByTag', 'compartment_depth': :'compartmentDepth', 'filter': :'filter', 'date_range_name': :'dateRangeName' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :tenant_id The value to assign to the {#tenant_id} property @option attributes [DateTime] :time_usage_started The value to assign to the {#time_usage_started} property @option attributes [DateTime] :time_usage_ended The value to assign to the {#time_usage_ended} property @option attributes [String] :granularity The value to assign to the {#granularity} property @option attributes [BOOLEAN] :is_aggregate_by_time The value to assign to the {#is_aggregate_by_time} property @option attributes [OCI::UsageApi::Models::Forecast] :forecast The value to assign to the {#forecast} property @option attributes [String] :query_type The value to assign to the {#query_type} property @option attributes [Array<String>] :group_by The value to assign to the {#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 [OCI::UsageApi::Models::Filter] :filter The value to assign to the {#filter} property @option attributes [String] :date_range_name The value to assign to the {#date_range_name} property
# File lib/oci/usage_api/models/report_query.rb, line 165 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.tenant_id = attributes[:'tenantId'] if attributes[:'tenantId'] raise 'You cannot provide both :tenantId and :tenant_id' if attributes.key?(:'tenantId') && attributes.key?(:'tenant_id') self.tenant_id = attributes[:'tenant_id'] if attributes[:'tenant_id'] self.time_usage_started = attributes[:'timeUsageStarted'] if attributes[:'timeUsageStarted'] raise 'You cannot provide both :timeUsageStarted and :time_usage_started' if attributes.key?(:'timeUsageStarted') && attributes.key?(:'time_usage_started') self.time_usage_started = attributes[:'time_usage_started'] if attributes[:'time_usage_started'] self.time_usage_ended = attributes[:'timeUsageEnded'] if attributes[:'timeUsageEnded'] raise 'You cannot provide both :timeUsageEnded and :time_usage_ended' if attributes.key?(:'timeUsageEnded') && attributes.key?(:'time_usage_ended') self.time_usage_ended = attributes[:'time_usage_ended'] if attributes[:'time_usage_ended'] self.granularity = attributes[:'granularity'] if attributes[:'granularity'] self.is_aggregate_by_time = attributes[:'isAggregateByTime'] unless attributes[:'isAggregateByTime'].nil? self.is_aggregate_by_time = false if is_aggregate_by_time.nil? && !attributes.key?(:'isAggregateByTime') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isAggregateByTime and :is_aggregate_by_time' if attributes.key?(:'isAggregateByTime') && attributes.key?(:'is_aggregate_by_time') self.is_aggregate_by_time = attributes[:'is_aggregate_by_time'] unless attributes[:'is_aggregate_by_time'].nil? self.is_aggregate_by_time = false if is_aggregate_by_time.nil? && !attributes.key?(:'isAggregateByTime') && !attributes.key?(:'is_aggregate_by_time') # rubocop:disable Style/StringLiterals self.forecast = attributes[:'forecast'] if attributes[:'forecast'] self.query_type = attributes[:'queryType'] if attributes[:'queryType'] raise 'You cannot provide both :queryType and :query_type' if attributes.key?(:'queryType') && attributes.key?(:'query_type') self.query_type = attributes[:'query_type'] if attributes[:'query_type'] 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'] 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.filter = attributes[:'filter'] if attributes[:'filter'] self.date_range_name = attributes[:'dateRangeName'] if attributes[:'dateRangeName'] raise 'You cannot provide both :dateRangeName and :date_range_name' if attributes.key?(:'dateRangeName') && attributes.key?(:'date_range_name') self.date_range_name = attributes[:'date_range_name'] if attributes[:'date_range_name'] end
Attribute type mapping.
# File lib/oci/usage_api/models/report_query.rb, line 128 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'tenant_id': :'String', 'time_usage_started': :'DateTime', 'time_usage_ended': :'DateTime', 'granularity': :'String', 'is_aggregate_by_time': :'BOOLEAN', 'forecast': :'OCI::UsageApi::Models::Forecast', 'query_type': :'String', 'group_by': :'Array<String>', 'group_by_tag': :'Array<OCI::UsageApi::Models::Tag>', 'compartment_depth': :'Float', 'filter': :'OCI::UsageApi::Models::Filter', 'date_range_name': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/usage_api/models/report_query.rb, line 280 def ==(other) return true if equal?(other) self.class == other.class && tenant_id == other.tenant_id && time_usage_started == other.time_usage_started && time_usage_ended == other.time_usage_ended && granularity == other.granularity && is_aggregate_by_time == other.is_aggregate_by_time && forecast == other.forecast && query_type == other.query_type && group_by == other.group_by && group_by_tag == other.group_by_tag && compartment_depth == other.compartment_depth && filter == other.filter && date_range_name == other.date_range_name end
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/report_query.rb, line 321 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
Custom attribute writer method checking allowed values (enum). @param [Object] date_range_name
Object
to be assigned
# File lib/oci/usage_api/models/report_query.rb, line 264 def date_range_name=(date_range_name) # rubocop:disable Style/ConditionalAssignment if date_range_name && !DATE_RANGE_NAME_ENUM.include?(date_range_name) OCI.logger.debug("Unknown value for 'date_range_name' [" + date_range_name + "]. Mapping to 'DATE_RANGE_NAME_UNKNOWN_ENUM_VALUE'") if OCI.logger @date_range_name = DATE_RANGE_NAME_UNKNOWN_ENUM_VALUE else @date_range_name = date_range_name end # rubocop:enable Style/ConditionalAssignment end
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/usage_api/models/report_query.rb, line 301 def eql?(other) self == other end
Custom attribute writer method checking allowed values (enum). @param [Object] granularity Object
to be assigned
# File lib/oci/usage_api/models/report_query.rb, line 238 def granularity=(granularity) # rubocop:disable Style/ConditionalAssignment if granularity && !GRANULARITY_ENUM.include?(granularity) OCI.logger.debug("Unknown value for 'granularity' [" + granularity + "]. Mapping to 'GRANULARITY_UNKNOWN_ENUM_VALUE'") if OCI.logger @granularity = GRANULARITY_UNKNOWN_ENUM_VALUE else @granularity = granularity end # rubocop:enable Style/ConditionalAssignment end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/usage_api/models/report_query.rb, line 310 def hash [tenant_id, time_usage_started, time_usage_ended, granularity, is_aggregate_by_time, forecast, query_type, group_by, group_by_tag, compartment_depth, filter, date_range_name].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] query_type
Object
to be assigned
# File lib/oci/usage_api/models/report_query.rb, line 251 def query_type=(query_type) # rubocop:disable Style/ConditionalAssignment if query_type && !QUERY_TYPE_ENUM.include?(query_type) OCI.logger.debug("Unknown value for 'query_type' [" + query_type + "]. Mapping to 'QUERY_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @query_type = QUERY_TYPE_UNKNOWN_ENUM_VALUE else @query_type = query_type end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/usage_api/models/report_query.rb, line 354 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/usage_api/models/report_query.rb, line 348 def to_s to_hash.to_s end
Private Instance Methods
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/report_query.rb, line 371 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