Class: Azure::Consumption::Mgmt::V2018_06_30::Models::Forecast

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-06-30/generated/azure_mgmt_consumption/models/forecast.rb

Overview

A forecast resource.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #name, #tags, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#charge ⇒ Object

Returns The amount of charge.

Returns:

  • The amount of charge



23
24
25
 
# File 'lib/2018-06-30/generated/azure_mgmt_consumption/models/forecast.rb', line 23

def charge
  @charge
end

#charge_type ⇒ ChargeType

forecast. Possible values include: ‘Actual’, ‘Forecast’

Returns:

  • (ChargeType) —

    The type of the charge. Could be actual or



31
32
33
 
# File 'lib/2018-06-30/generated/azure_mgmt_consumption/models/forecast.rb', line 31

def charge_type
  @charge_type
end

#confidence_levels ⇒ Array<ForecastPropertiesConfidenceLevelsItem>

about the forecast confidence levels. This is populated only when chargeType is Forecast.

Returns:



36
37
38
 
# File 'lib/2018-06-30/generated/azure_mgmt_consumption/models/forecast.rb', line 36

def confidence_levels
  @confidence_levels
end

#currency ⇒ String

example, USD.

Returns:

  • (String) —

    The ISO currency in which the meter is charged, for



27
28
29
 
# File 'lib/2018-06-30/generated/azure_mgmt_consumption/models/forecast.rb', line 27

def currency
  @currency
end

#grain ⇒ Grain

‘Daily’, ‘Monthly’, ‘Yearly’

Returns:

  • (Grain) —

    The granularity of forecast. Possible values include:



20
21
22
 
# File 'lib/2018-06-30/generated/azure_mgmt_consumption/models/forecast.rb', line 20

def grain
  @grain
end

#usage_date ⇒ String

Returns The usage date of the forecast.

Returns:

  • (String) —

    The usage date of the forecast.



16
17
18
 
# File 'lib/2018-06-30/generated/azure_mgmt_consumption/models/forecast.rb', line 16

def usage_date
  @usage_date
end

Class Method Details

.mapper ⇒ Object

Mapper for Forecast class as Ruby Hash. This will be used for serialization/deserialization.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/2018-06-30/generated/azure_mgmt_consumption/models/forecast.rb', line 43

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Forecast',
    type: {
      name: 'Composite',
      class_name: 'Forecast',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        usage_date: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.usageDate',
          type: {
            name: 'String'
          }
        },
        grain: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.grain',
          type: {
            name: 'String'
          }
        },
        charge: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.charge',
          type: {
            name: 'Number'
          }
        },
        currency: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.currency',
          type: {
            name: 'String'
          }
        },
        charge_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.chargeType',
          type: {
            name: 'String'
          }
        },
        confidence_levels: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.confidenceLevels',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ForecastPropertiesConfidenceLevelsItemElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ForecastPropertiesConfidenceLevelsItem'
                }
            }
          }
        }
      }
    }
  }
end