1. class
  2. Google
  3. \
  4. Api
  5. \
  6. MetricDescriptor

MetricDescriptor

class MetricDescriptor extends Message

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.

Generated from protobuf message google.api.MetricDescriptor

Methods

__construct(array $data = NULL)

Constructor.

string
getName()

The resource name of the metric descriptor.

$this
setName(string $var)

The resource name of the metric descriptor.

string
getType()

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"

$this
setType(string $var)

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"

RepeatedField
getLabels()

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.

$this
setLabels(LabelDescriptor[]|RepeatedField $var)

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.

int
getMetricKind()

Whether the metric records instantaneous values, changes to a value, etc.

$this
setMetricKind(int $var)

Whether the metric records instantaneous values, changes to a value, etc.

int
getValueType()

Whether the measurement is an integer, a floating-point number, etc.

$this
setValueType(int $var)

Whether the measurement is an integer, a floating-point number, etc.

string
getUnit()

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.

$this
setUnit(string $var)

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.

string
getDescription()

A detailed description of the metric, which can be used in documentation.

$this
setDescription(string $var)

A detailed description of the metric, which can be used in documentation.

string
getDisplayName()

A concise name for the metric, which can be displayed in user interfaces.

$this
setDisplayName(string $var)

A concise name for the metric, which can be displayed in user interfaces.

MetricDescriptorMetadata
getMetadata()

Optional. Metadata which can be used to guide usage of the metric.

$this
setMetadata(MetricDescriptorMetadata $var)

Optional. Metadata which can be used to guide usage of the metric.

int
getLaunchStage()

Optional. The launch stage of the metric definition.

$this
setLaunchStage(int $var)

Optional. The launch stage of the metric definition.

Details

at line 303
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type string $name
      The resource name of the metric descriptor.
@type string $type
      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"
@type \Google\Api\LabelDescriptor[]|\Google\Protobuf\Internal\RepeatedField $labels
      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.
@type int $metric_kind
      Whether the metric records instantaneous values, changes to a value, etc.
      Some combinations of `metric_kind` and `value_type` might not be supported.
@type int $value_type
      Whether the measurement is an integer, a floating-point number, etc.
      Some combinations of `metric_kind` and `value_type` might not be supported.
@type string $unit
      The units in which the metric value is reported. It is only applicable
      if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit`
      defines the representation of the stored metric values.
      Different systems may scale the values to be more easily displayed (so a
      value of `0.02KBy` _might_ be displayed as `20By`, and a value of
      `3523KBy` _might_ be displayed as `3.5MBy`). However, if the `unit` is
      `KBy`, then the value of the metric is always in thousands of bytes, no
      matter how it may be displayed..
      If you want a custom metric to record the exact number of CPU-seconds used
      by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is
      `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the job uses 12,005
      CPU-seconds, then the value is written as `12005`.
      Alternatively, if you want a custome metric to record data in a more
      granular way, you can create a `DOUBLE CUMULATIVE` metric whose `unit` is
      `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`),
      or use `Kis{CPU}` and write `11.723` (which is `12005/1024`).
      The supported units are a subset of [The Unified Code for Units of
      Measure](http://unitsofmeasure.org/ucum.html) 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)
      * `Pi`    pebi    (2^50)
      **Grammar**
      The grammar also includes these connectors:
      * `/`    division or ratio (as an infix operator). For examples,
               `kBy/{email}` or `MiBy/10ms` (although you should almost never
               have `/s` in a metric `unit`; rates should always be computed at
               query time from the underlying cumulative or delta value).
      * `.`    multiplication or composition (as an infix operator). For
               examples, `GBy.d` or `k{watt}.h`.
      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`. If the annotation
         is used alone, then the unit is equivalent to `1`. For examples,
         `{request}/s == 1/s`, `By{transmitted}/s == By/s`.
      * `NAME` is a sequence of non-blank printable ASCII characters not
         containing `{` or `}`.
      * `1` represents a unitary [dimensionless
         unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such
         as in `1/s`. It is typically used when none of the basic units are
         appropriate. For example, "new users per day" can be represented as
         `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new
         users). Alternatively, "thousands of page views per day" would be
         represented as `1000/d` or `k1/d` or `k{page_views}/d` (and a metric
         value of `5.3` would mean "5300 page views per day").
      * `%` represents dimensionless value of 1/100, and annotates values giving
         a percentage (so the metric values are typically in the range of 0..100,
         and a metric value `3` means "3 percent").
      * `10^2.%` indicates a metric contains a ratio, typically in the range
         0..1, that will be multiplied by 100 and displayed as a percentage
         (so a metric value `0.03` means "3 percent").
@type string $description
      A detailed description of the metric, which can be used in documentation.
@type string $display_name
      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.
@type \Google\Api\MetricDescriptor\MetricDescriptorMetadata $metadata
      Optional. Metadata which can be used to guide usage of the metric.
@type int $launch_stage
      Optional. The launch stage of the metric definition.

}

at line 314
string getName()

The resource name of the metric descriptor.

Generated from protobuf field string name = 1;

Return Value

string

at line 326
$this setName(string $var)

The resource name of the metric descriptor.

Generated from protobuf field string name = 1;

Parameters

string $var

Return Value

$this

at line 346
string getType()

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"

Generated from protobuf field string type = 8;

Return Value

string

at line 364
$this setType(string $var)

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"

Generated from protobuf field string type = 8;

Parameters

string $var

Return Value

$this

at line 383
RepeatedField getLabels()

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.

Generated from protobuf field repeated .google.api.LabelDescriptor labels = 2;

Return Value

RepeatedField

at line 400
$this setLabels(LabelDescriptor[]|RepeatedField $var)

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.

Generated from protobuf field repeated .google.api.LabelDescriptor labels = 2;

Parameters

LabelDescriptor[]|RepeatedField $var

Return Value

$this

at line 415
int getMetricKind()

Whether the metric records instantaneous values, changes to a value, etc.

Some combinations of metric_kind and value_type might not be supported.

Generated from protobuf field .google.api.MetricDescriptor.MetricKind metric_kind = 3;

Return Value

int

at line 428
$this setMetricKind(int $var)

Whether the metric records instantaneous values, changes to a value, etc.

Some combinations of metric_kind and value_type might not be supported.

Generated from protobuf field .google.api.MetricDescriptor.MetricKind metric_kind = 3;

Parameters

int $var

Return Value

$this

at line 443
int getValueType()

Whether the measurement is an integer, a floating-point number, etc.

Some combinations of metric_kind and value_type might not be supported.

Generated from protobuf field .google.api.MetricDescriptor.ValueType value_type = 4;

Return Value

int

at line 456
$this setValueType(int $var)

Whether the measurement is an integer, a floating-point number, etc.

Some combinations of metric_kind and value_type might not be supported.

Generated from protobuf field .google.api.MetricDescriptor.ValueType value_type = 4;

Parameters

int $var

Return Value

$this

at line 551
string getUnit()

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.

Different systems may scale the values to be more easily displayed (so a value of 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as 3.5MBy). However, if the unit is KBy, then the value of the metric is always in thousands of bytes, no matter how it may be displayed.. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custome metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). 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) * Pi pebi (2^50) Grammar The grammar also includes these connectors: * / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). * . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. 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. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). * 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").

Generated from protobuf field string unit = 5;

Return Value

string

at line 644
$this setUnit(string $var)

The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.

Different systems may scale the values to be more easily displayed (so a value of 0.02KBy might be displayed as 20By, and a value of 3523KBy might be displayed as 3.5MBy). However, if the unit is KBy, then the value of the metric is always in thousands of bytes, no matter how it may be displayed.. If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005. Alternatively, if you want a custome metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024). 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) * Pi pebi (2^50) Grammar The grammar also includes these connectors: * / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). * . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h. 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. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. * NAME is a sequence of non-blank printable ASCII characters not containing { or }. * 1 represents a unitary dimensionless unit of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). * 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").

Generated from protobuf field string unit = 5;

Parameters

string $var

Return Value

$this

at line 658
string getDescription()

A detailed description of the metric, which can be used in documentation.

Generated from protobuf field string description = 6;

Return Value

string

at line 670
$this setDescription(string $var)

A detailed description of the metric, which can be used in documentation.

Generated from protobuf field string description = 6;

Parameters

string $var

Return Value

$this

at line 687
string getDisplayName()

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.

Generated from protobuf field string display_name = 7;

Return Value

string

at line 702
$this setDisplayName(string $var)

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.

Generated from protobuf field string display_name = 7;

Parameters

string $var

Return Value

$this

at line 716
MetricDescriptorMetadata getMetadata()

Optional. Metadata which can be used to guide usage of the metric.

Generated from protobuf field .google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;

Return Value

MetricDescriptorMetadata

at line 728
$this setMetadata(MetricDescriptorMetadata $var)

Optional. Metadata which can be used to guide usage of the metric.

Generated from protobuf field .google.api.MetricDescriptor.MetricDescriptorMetadata metadata = 10;

Parameters

MetricDescriptorMetadata $var

Return Value

$this

at line 742
int getLaunchStage()

Optional. The launch stage of the metric definition.

Generated from protobuf field .google.api.LaunchStage launch_stage = 12;

Return Value

int

at line 754
$this setLaunchStage(int $var)

Optional. The launch stage of the metric definition.

Generated from protobuf field .google.api.LaunchStage launch_stage = 12;

Parameters

int $var

Return Value

$this