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

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 
Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::clear()
    public Google\Protobuf\Internal\Message::discardUnknownFields()
    public getDescription()
     
    A detailed description of the metric, which can be used in documentation.

    Generated from protobuf field string description = 6;

    • return string
    public 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 string
    public 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;

    public getLaunchStage()
     
    Optional. The launch stage of the metric definition.

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

    • return int
    public getMetadata()
     
    Optional. Metadata which can be used to guide usage of the metric.

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

    public 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 int
    public getName()
     
    The resource name of the metric descriptor.

    Generated from protobuf field string name = 1;

    • return string
    public 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 string
    public 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 string
    public 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 int
    public Google\Protobuf\Internal\Message::jsonByteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data)
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input)
     


    • ignore
    public Google\Protobuf\Internal\Message::parseFromStream( $input)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonString()
     
    Serialize the message to json string.

    • return string Serialized json protobuf data.
    public Google\Protobuf\Internal\Message::serializeToStream( $output)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToString()
     
    Serialize the message to string.

    • return string Serialized binary protobuf data.
    public setDescription( $var)
     
    A detailed description of the metric, which can be used in documentation.

    Generated from protobuf field string description = 6;

    • return $this
    public setDisplayName( $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;

    • return $this
    public setLabels( $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;

    • return $this
    public setLaunchStage( $var)
     
    Optional. The launch stage of the metric definition.

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

    • return $this
    public setMetadata( $var)
     
    Optional. Metadata which can be used to guide usage of the metric.

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

    • return $this
    public setMetricKind( $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;

    • return $this
    public setName( $var)
     
    The resource name of the metric descriptor.

    Generated from protobuf field string name = 1;

    • return $this
    public setType( $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;

    • return $this
    public setUnit( $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;

    • return $this
    public setValueType( $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;

    • return $this
    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array)
    protected Google\Protobuf\Internal\Message::readOneof( $number)
    protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
    protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
    protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
    protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
    Properties
    private $description
     
    A detailed description of the metric, which can be used in documentation.

    Generated from protobuf field string description = 6;

    private $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.

    Generated from protobuf field string display_name = 7;

    private $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.

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

    private $launch_stage
     
    Optional. The launch stage of the metric definition.

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

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

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

    private $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.

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

    private $name
     
    The resource name of the metric descriptor.

    Generated from protobuf field string name = 1;

    private $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"

    Generated from protobuf field string type = 8;

    private $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
    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;

    private $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.

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

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     


    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     


    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     
    Tries to normalize the elements in $value into a provided protobuf wrapper type $class. If $value is any type other than array, we do not do any conversion, and instead rely on the existing protobuf type checking. If $value is an array, we process each element and try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       
      Tries to normalize $value into a provided protobuf wrapper type $class.

      If $value is any type other than an object, we attempt to construct an
      instance of $class and assign $value to it using the setValue method
      shared by all wrapper types.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         


        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         


        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         


        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         
        Tries to normalize the elements in $value into a provided protobuf wrapper type $class. If $value is any type other than array, we do not do any conversion, and instead rely on the existing protobuf type checking. If $value is an array, we process each element and try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           
          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             


            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only