Class: Google::Apis::ServicemanagementV1::MetricDescriptor

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



2466
2467
2468
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2466

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

Returns:

  • (String) 


2357
2358
2359
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2357

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

Returns:

  • (String) 


2365
2366
2367
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2365

def display_name
  @display_name
end

#labels ⇒ Array<Google::Apis::ServicemanagementV1::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

Returns:



2375
2376
2377
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2375

def labels
  @labels
end

#metadata ⇒ Google::Apis::ServicemanagementV1::MetricDescriptorMetadata

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

Returns:



2380
2381
2382
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2380

def metadata
  @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

Returns:

  • (String) 


2386
2387
2388
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2386

def metric_kind
  @metric_kind
end

#name ⇒ String

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

Returns:

  • (String) 


2391
2392
2393
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2391

def name
  @name
end

#type ⇒ String

The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" Corresponds to the JSON property type

Returns:

  • (String) 


2402
2403
2404
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2402

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 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) 


2458
2459
2460
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2458

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

Returns:

  • (String) 


2464
2465
2466
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2464

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
 
# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2471

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