Class: Google::Apis::ServiceuserV1::MetricDescriptor
- Inherits:
-
Object
- Object
- Google::Apis::ServiceuserV1::MetricDescriptor
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/serviceuser_v1/classes.rb,
generated/google/apis/serviceuser_v1/representations.rb,
generated/google/apis/serviceuser_v1/representations.rb
Overview
Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
Instance Attribute Summary collapse
-
#description ⇒ String
A detailed description of the metric, which can be used in documentation.
-
#display_name ⇒ String
A concise name for the metric, which can be displayed in user interfaces.
-
#labels ⇒ Array<Google::Apis::ServiceuserV1::LabelDescriptor>
The set of labels that can be used to describe a specific instance of this metric type.
-
#metadata ⇒ Google::Apis::ServiceuserV1::MetricDescriptorMetadata
Additional annotations that can be used to guide the usage of a metric.
-
#metric_kind ⇒ String
Whether the metric records instantaneous values, changes to a value, etc.
-
#name ⇒ String
The resource name of the metric descriptor.
-
#type ⇒ String
The metric type, including its DNS name prefix.
-
#unit ⇒ String
The unit in which the metric value is reported.
-
#value_type ⇒ String
Whether the measurement is an integer, a floating-point number, etc.
Instance Method Summary collapse
-
#initialize(**args) ⇒ MetricDescriptor
constructor
A new instance of MetricDescriptor.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ MetricDescriptor
Returns a new instance of MetricDescriptor
1891 1892 1893 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1891 def initialize(**args) update!(**args) end |
Instance Attribute Details
#description ⇒ String
A detailed description of the metric, which can be used in documentation.
Corresponds to the JSON property description
1783 1784 1785 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1783 def description @description end |
#display_name ⇒ String
A concise name for the metric, which can be displayed in user interfaces.
Use sentence case without an ending period, for example "Request count".
This field is optional but it is recommended to be set for any metrics
associated with user-visible concepts, such as Quota.
Corresponds to the JSON property displayName
1791 1792 1793 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1791 def display_name @display_name end |
#labels ⇒ Array<Google::Apis::ServiceuserV1::LabelDescriptor>
The set of labels that can be used to describe a specific
instance of this metric type. For example, the
appengine.googleapis.com/http/server/response_latencies
metric
type has a label for the HTTP response code, response_code
, so
you can look at latencies for successful responses or just
for responses that failed.
Corresponds to the JSON property labels
1801 1802 1803 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1801 def labels @labels end |
#metadata ⇒ Google::Apis::ServiceuserV1::MetricDescriptorMetadata
Additional annotations that can be used to guide the usage of a metric.
Corresponds to the JSON property metadata
1806 1807 1808 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1806 def @metadata end |
#metric_kind ⇒ String
Whether the metric records instantaneous values, changes to a value, etc.
Some combinations of metric_kind
and value_type
might not be supported.
Corresponds to the JSON property metricKind
1812 1813 1814 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1812 def metric_kind @metric_kind end |
#name ⇒ String
The resource name of the metric descriptor.
Corresponds to the JSON property name
1817 1818 1819 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1817 def name @name end |
#type ⇒ String
The metric type, including its DNS name prefix. The type is not
URL-encoded. All user-defined custom metric types have the DNS name
custom.googleapis.com
. Metric types should use a natural hierarchical
grouping. For example:
"custom.googleapis.com/invoice/paid/amount"
"appengine.googleapis.com/http/server/response_latencies"
Corresponds to the JSON property type
1827 1828 1829 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1827 def type @type end |
#unit ⇒ String
The unit in which the metric value is reported. It is only applicable
if the value_type
is INT64
, DOUBLE
, or DISTRIBUTION
. The
supported units are a subset of The Unified Code for Units of
Measure standard:
Basic units (UNIT)
bit
bitBy
bytes
secondmin
minuteh
hourd
day Prefixes (PREFIX)k
kilo (10**3)M
mega (10**6)G
giga (10**9)T
tera (10**12)P
peta (10**15)E
exa (10**18)Z
zetta (10**21)Y
yotta (10**24)m
milli (10**-3)u
micro (10**-6)n
nano (10**-9)p
pico (10**-12)f
femto (10**-15)a
atto (10**-18)z
zepto (10**-21)y
yocto (10**-24)Ki
kibi (2**10)Mi
mebi (2**20)Gi
gibi (2**30)Ti
tebi (2*40) **Grammar* The grammar also includes these connectors:/
division (as an infix operator, e.g.1/s
)..
multiplication (as an infix operator, e.g.GBy.d
) The grammar for a unit is as follows: Expression = Component"." Component
"/" Component
; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "" NAME "
" ; Notes:Annotation
is just a comment if it follows aUNIT
and is equivalent to1
if it is used alone. For examples, `requests
/s == 1/s,
Bytransmitted
/s == By/s`.NAME
is a sequence of non-blank printable ASCII characters not containing '' or '
'.1
represents dimensionless value 1, such as in1/s
.%
represents dimensionless value 1/100, and annotates values giving a percentage. Corresponds to the JSON propertyunit
1883 1884 1885 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1883 def unit @unit end |
#value_type ⇒ String
Whether the measurement is an integer, a floating-point number, etc.
Some combinations of metric_kind
and value_type
might not be supported.
Corresponds to the JSON property valueType
1889 1890 1891 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1889 def value_type @value_type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 |
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1896 def update!(**args) @description = args[:description] if args.key?(:description) @display_name = args[:display_name] if args.key?(:display_name) @labels = args[:labels] if args.key?(:labels) @metadata = args[:metadata] if args.key?(:metadata) @metric_kind = args[:metric_kind] if args.key?(:metric_kind) @name = args[:name] if args.key?(:name) @type = args[:type] if args.key?(:type) @unit = args[:unit] if args.key?(:unit) @value_type = args[:value_type] if args.key?(:value_type) end |