Class: Azure::Signalr::Mgmt::V2018_10_01::Models::MetricSpecification

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2018-10-01/generated/azure_mgmt_signalr/models/metric_specification.rb

Overview

Specifications of the Metrics for Azure Monitoring.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#aggregation_type ⇒ String

Average, Minimum, Maximum, Total, Count.

Returns:

  • (String) —

    Only provide one value for this field. Valid values:



29
30
31
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/metric_specification.rb', line 29

def aggregation_type
  @aggregation_type
end

#category ⇒ String

belongs to. A metric can only belong to a single category.

Returns:

  • (String) —

    The name of the metric category that the metric



41
42
43
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/metric_specification.rb', line 41

def category
  @category
end

#dimensions ⇒ Array<Dimension>

Returns The dimensions of the metrics.

Returns:

  • (Array<Dimension>) —

    The dimensions of the metrics.



44
45
46
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/metric_specification.rb', line 44

def dimensions
  @dimensions
end

#display_description ⇒ String

Returns Localized friendly description of the metric.

Returns:

  • (String) —

    Localized friendly description of the metric.



22
23
24
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/metric_specification.rb', line 22

def display_description
  @display_description
end

#display_name ⇒ String

Returns Localized friendly display name of the metric.

Returns:

  • (String) —

    Localized friendly display name of the metric.



19
20
21
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/metric_specification.rb', line 19

def display_name
  @display_name
end

#fill_gap_with_zero ⇒ String

for time duration where no metric is emitted/published. Ex. a metric that returns the number of times a particular error code was emitted. The error code may not appear often, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.

Returns:

  • (String) —

    Optional. If set to true, then zero will be returned



37
38
39
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/metric_specification.rb', line 37

def fill_gap_with_zero
  @fill_gap_with_zero
end

#name ⇒ String

Returns Name of the metric.

Returns:

  • (String) —

    Name of the metric.



16
17
18
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/metric_specification.rb', line 16

def name
  @name
end

#unit ⇒ String

Returns The unit that makes sense for the metric.

Returns:

  • (String) —

    The unit that makes sense for the metric.



25
26
27
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/metric_specification.rb', line 25

def unit
  @unit
end

Class Method Details

.mapper ⇒ Object

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



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
 
# File 'lib/2018-10-01/generated/azure_mgmt_signalr/models/metric_specification.rb', line 51

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'MetricSpecification',
    type: {
      name: 'Composite',
      class_name: 'MetricSpecification',
      model_properties: {
        name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        display_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'displayName',
          type: {
            name: 'String'
          }
        },
        display_description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'displayDescription',
          type: {
            name: 'String'
          }
        },
        unit: {
          client_side_validation: true,
          required: false,
          serialized_name: 'unit',
          type: {
            name: 'String'
          }
        },
        aggregation_type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'aggregationType',
          type: {
            name: 'String'
          }
        },
        fill_gap_with_zero: {
          client_side_validation: true,
          required: false,
          serialized_name: 'fillGapWithZero',
          type: {
            name: 'String'
          }
        },
        category: {
          client_side_validation: true,
          required: false,
          serialized_name: 'category',
          type: {
            name: 'String'
          }
        },
        dimensions: {
          client_side_validation: true,
          required: false,
          serialized_name: 'dimensions',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'DimensionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Dimension'
                }
            }
          }
        }
      }
    }
  }
end