Google\Api\MetricDescriptor | Google ApiCore

at line 225
`__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 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"
@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 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](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)
      **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`, `By{transmitted}/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.
@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.

}

at line 236
`string getName()`

The resource name of the metric descriptor.

Generated from protobuf field string name = 1;

Return Value

string

at line 248
`$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 267
`string getType()`

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"

Generated from protobuf field string type = 8;

Return Value

string

at line 284
`$this setType(string $var)`

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"

Generated from protobuf field string type = 8;

Parameters

string

$var

Return Value

$this

at line 303
`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 320
`$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 335
`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 348
`$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 363
`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 376
`$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 441
`string getUnit()`

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 (103) * M mega (106) * G giga (109) * T tera (1012) * P peta (1015) * E exa (1018) * Z zetta (1021) * Y yotta (1024) * 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 (210) * Mi mebi (220) * Gi gibi (230) * Ti tebi (240) 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, By{transmitted}/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.

Generated from protobuf field string unit = 5;

Return Value

string

at line 504
`$this setUnit(string $var)`

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 (103) * M mega (106) * G giga (109) * T tera (1012) * P peta (1015) * E exa (1018) * Z zetta (1021) * Y yotta (1024) * 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 (210) * Mi mebi (220) * Gi gibi (230) * Ti tebi (240) 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, By{transmitted}/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.

Generated from protobuf field string unit = 5;

Parameters

string

$var

Return Value

$this

at line 518
`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 530
`$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 547
`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 562
`$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

MetricDescriptor

Methods

Details

at line 225 __construct(array $data = NULL)

Parameters

at line 236 string getName()

Return Value

at line 248 $this setName(string $var)

Parameters

Return Value

at line 267 string getType()

Return Value

at line 284 $this setType(string $var)

Parameters

Return Value

at line 303 RepeatedField getLabels()

Return Value

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

Parameters

Return Value

at line 335 int getMetricKind()

Return Value

at line 348 $this setMetricKind(int $var)

Parameters

Return Value

at line 363 int getValueType()

Return Value

at line 376 $this setValueType(int $var)

Parameters

Return Value

at line 441 string getUnit()

Return Value

at line 504 $this setUnit(string $var)

Parameters

Return Value

at line 518 string getDescription()

Return Value

at line 530 $this setDescription(string $var)

Parameters

Return Value

at line 547 string getDisplayName()

Return Value

at line 562 $this setDisplayName(string $var)

Parameters

Return Value

at line 225
`__construct(array $data = NULL)`

at line 236
`string getName()`

at line 248
`$this setName(string $var)`

at line 267
`string getType()`

at line 284
`$this setType(string $var)`

at line 303
`RepeatedField getLabels()`

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

at line 335
`int getMetricKind()`

at line 348
`$this setMetricKind(int $var)`

at line 363
`int getValueType()`

at line 376
`$this setValueType(int $var)`

at line 441
`string getUnit()`

at line 504
`$this setUnit(string $var)`

at line 518
`string getDescription()`

at line 530
`$this setDescription(string $var)`

at line 547
`string getDisplayName()`

at line 562
`$this setDisplayName(string $var)`