class OCI::UsageApi::Models::Forecast
Forecast
configuration of usage/cost.
Constants
- FORECAST_TYPE_ENUM
Attributes
BASIC uses the exponential smoothing (ETS) model to project future usage/costs based on history data. The basis for projections is a periodic set of equivalent historical days for which the projection is being made. @return [String]
[Required] The forecast end time. @return [DateTime]
The forecast start time. Defaults to UTC-1 if not specified. @return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/usage_api/models/forecast.rb, line 29 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'forecast_type': :'forecastType', 'time_forecast_started': :'timeForecastStarted', 'time_forecast_ended': :'timeForecastEnded' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :forecast_type The value to assign to the {#forecast_type} property @option attributes [DateTime] :time_forecast_started The value to assign to the {#time_forecast_started} property @option attributes [DateTime] :time_forecast_ended The value to assign to the {#time_forecast_ended} property
# File lib/oci/usage_api/models/forecast.rb, line 59 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.forecast_type = attributes[:'forecastType'] if attributes[:'forecastType'] self.forecast_type = "BASIC" if forecast_type.nil? && !attributes.key?(:'forecastType') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :forecastType and :forecast_type' if attributes.key?(:'forecastType') && attributes.key?(:'forecast_type') self.forecast_type = attributes[:'forecast_type'] if attributes[:'forecast_type'] self.forecast_type = "BASIC" if forecast_type.nil? && !attributes.key?(:'forecastType') && !attributes.key?(:'forecast_type') # rubocop:disable Style/StringLiterals self.time_forecast_started = attributes[:'timeForecastStarted'] if attributes[:'timeForecastStarted'] raise 'You cannot provide both :timeForecastStarted and :time_forecast_started' if attributes.key?(:'timeForecastStarted') && attributes.key?(:'time_forecast_started') self.time_forecast_started = attributes[:'time_forecast_started'] if attributes[:'time_forecast_started'] self.time_forecast_ended = attributes[:'timeForecastEnded'] if attributes[:'timeForecastEnded'] raise 'You cannot provide both :timeForecastEnded and :time_forecast_ended' if attributes.key?(:'timeForecastEnded') && attributes.key?(:'time_forecast_ended') self.time_forecast_ended = attributes[:'time_forecast_ended'] if attributes[:'time_forecast_ended'] end
Attribute type mapping.
# File lib/oci/usage_api/models/forecast.rb, line 40 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'forecast_type': :'String', 'time_forecast_started': :'DateTime', 'time_forecast_ended': :'DateTime' # 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/forecast.rb, line 106 def ==(other) return true if equal?(other) self.class == other.class && forecast_type == other.forecast_type && time_forecast_started == other.time_forecast_started && time_forecast_ended == other.time_forecast_ended 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/forecast.rb, line 138 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/usage_api/models/forecast.rb, line 118 def eql?(other) self == other end
Custom attribute writer method checking allowed values (enum). @param [Object] forecast_type
Object
to be assigned
# File lib/oci/usage_api/models/forecast.rb, line 90 def forecast_type=(forecast_type) # rubocop:disable Style/ConditionalAssignment if forecast_type && !FORECAST_TYPE_ENUM.include?(forecast_type) OCI.logger.debug("Unknown value for 'forecast_type' [" + forecast_type + "]. Mapping to 'FORECAST_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @forecast_type = FORECAST_TYPE_UNKNOWN_ENUM_VALUE else @forecast_type = forecast_type end # rubocop:enable Style/ConditionalAssignment end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/usage_api/models/forecast.rb, line 127 def hash [forecast_type, time_forecast_started, time_forecast_ended].hash 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/forecast.rb, line 171 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/forecast.rb, line 165 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/forecast.rb, line 188 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