Class: Google::Apis::ServiceconsumermanagementV1::MetricDescriptor

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceconsumermanagement_v1/classes.rb,
generated/google/apis/serviceconsumermanagement_v1/representations.rb,
generated/google/apis/serviceconsumermanagement_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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ MetricDescriptor

Returns a new instance of MetricDescriptor



2088
2089
2090
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2088

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#descriptionString

A detailed description of the metric, which can be used in documentation. Corresponds to the JSON property description

Returns:

  • (String)


1980
1981
1982
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 1980

def description
  @description
end

#display_nameString

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

Returns:

  • (String)


1988
1989
1990
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 1988

def display_name
  @display_name
end

#labelsArray<Google::Apis::ServiceconsumermanagementV1::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



1998
1999
2000
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 1998

def labels
  @labels
end

#metadataGoogle::Apis::ServiceconsumermanagementV1::MetricDescriptorMetadata

Additional annotations that can be used to guide the usage of a metric. Corresponds to the JSON property metadata



2003
2004
2005
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2003

def 
  @metadata
end

#metric_kindString

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

Returns:

  • (String)


2009
2010
2011
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2009

def metric_kind
  @metric_kind
end

#nameString

The resource name of the metric descriptor. Corresponds to the JSON property name

Returns:

  • (String)


2014
2015
2016
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2014

def name
  @name
end

#typeString

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

Returns:

  • (String)


2024
2025
2026
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2024

def type
  @type
end

#unitString

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 bit
  • By byte
  • s second
  • min minute
  • h hour
  • d 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 a UNIT and is equivalent to 1 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 in 1/s.
  • % represents dimensionless value 1/100, and annotates values giving a percentage. Corresponds to the JSON property unit

Returns:

  • (String)


2080
2081
2082
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2080

def unit
  @unit
end

#value_typeString

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

Returns:

  • (String)


2086
2087
2088
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2086

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
# File 'generated/google/apis/serviceconsumermanagement_v1/classes.rb', line 2093

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