Class: Azure::CognitiveServices::Mgmt::V2017_04_18::Models::Usage

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-04-18/generated/azure_mgmt_cognitive_services/models/usage.rb

Overview

The usage data for a usage request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#current_value ⇒ Float

Returns Current value for this metric.

Returns:

  • (Float) —

    Current value for this metric.



30
31
32
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/models/usage.rb', line 30

def current_value
  @current_value
end

#limit ⇒ Float

Returns Maximum value for this metric.

Returns:

  • (Float) —

    Maximum value for this metric.



27
28
29
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/models/usage.rb', line 27

def limit
  @limit
end

#name ⇒ MetricName

Returns The name information for the metric.

Returns:

  • (MetricName) —

    The name information for the metric.



21
22
23
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/models/usage.rb', line 21

def name
  @name
end

#next_reset_time ⇒ String

Returns Next reset time for current quota.

Returns:

  • (String) —

    Next reset time for current quota.



33
34
35
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/models/usage.rb', line 33

def next_reset_time
  @next_reset_time
end

#quota_period ⇒ String

Returns The quota period used to summarize the usage values.

Returns:

  • (String) —

    The quota period used to summarize the usage values.



24
25
26
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/models/usage.rb', line 24

def quota_period
  @quota_period
end

#status ⇒ QuotaUsageStatus

status. Possible values include: ‘Included’, ‘Blocked’, ‘InOverage’, ‘Unknown’

Returns:



38
39
40
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/models/usage.rb', line 38

def status
  @status
end

#unit ⇒ UnitType

‘Count’, ‘Bytes’, ‘Seconds’, ‘Percent’, ‘CountPerSecond’, ‘BytesPerSecond’, ‘Milliseconds’

Returns:

  • (UnitType) —

    The unit of the metric. Possible values include:



18
19
20
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/models/usage.rb', line 18

def unit
  @unit
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2017-04-18/generated/azure_mgmt_cognitive_services/models/usage.rb', line 45

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'Usage',
    type: {
      name: 'Composite',
      class_name: 'Usage',
      model_properties: {
        unit: {
          client_side_validation: true,
          required: false,
          serialized_name: 'unit',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'Composite',
            class_name: 'MetricName'
          }
        },
        quota_period: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'quotaPeriod',
          type: {
            name: 'String'
          }
        },
        limit: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'limit',
          type: {
            name: 'Double'
          }
        },
        current_value: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'currentValue',
          type: {
            name: 'Double'
          }
        },
        next_reset_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'nextResetTime',
          type: {
            name: 'String'
          }
        },
        status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'status',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end