Class: Google::Apis::ServiceuserV1::MetricDescriptor

Inherits:
Object
  • Object
show all
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

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



3498
3499
3500
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3498

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) 


3496
3497
3498
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3496

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". Corresponds to the JSON property displayName

Returns:

  • (String) 


3491
3492
3493
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3491

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

Returns:



3451
3452
3453
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3451

def labels
  @labels
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) 


3485
3486
3487
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3485

def metric_kind
  @metric_kind
end

#name ⇒ String

The resource name of the metric descriptor. Depending on the implementation, the name typically includes: (1) the parent resource name that defines the scope of the metric type or of its data; and (2) the metric's URL-encoded type, which also appears in the type field of this descriptor. For example, following is the resource name of a custom metric within the GCP project my-project-id: "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice% 2Fpaid%2Famount" Corresponds to the JSON property name

Returns:

  • (String) 


3463
3464
3465
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3463

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

Returns:

  • (String) 


3473
3474
3475
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3473

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 includes the dimensionless unit 1, such as 1/s. 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 ''. Corresponds to the JSON property unit

Returns:

  • (String) 


3441
3442
3443
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3441

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) 


3479
3480
3481
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3479

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 3503

def update!(**args)
  @unit = args[:unit] if args.key?(:unit)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @type = args[:type] if args.key?(:type)
  @value_type = args[:value_type] if args.key?(:value_type)
  @metric_kind = args[:metric_kind] if args.key?(:metric_kind)
  @display_name = args[:display_name] if args.key?(:display_name)
  @description = args[:description] if args.key?(:description)
end