PHPFUI/InstaDoc

Additional annotations that can be used to guide the usage of a metric.

Generated from protobuf message google.api.MetricDescriptor.MetricDescriptorMetadata

CloneableInstantiable

Extends
Google\Protobuf\Internal\Message

Methods

public __construct( $data = NULL)

Constructor.

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

@type int $launch_stage
      Deprecated. Must use the
      [MetricDescriptor.launch_stage][google.api.MetricDescriptor.launch_stage]
      instead.
@type \Google\Protobuf\Duration $sample_period
      The sampling period of metric data points. For metrics which are written
      periodically, consecutive data points are stored at this time interval,
      excluding data loss due to errors. Metrics with a higher granularity have
      a smaller sampling period.
@type \Google\Protobuf\Duration $ingest_delay
      The delay of data points caused by ingestion. Data points older than this
      age are guaranteed to be ingested and available to be read, excluding
      data loss due to errors.
@type array<int>|\Google\Protobuf\Internal\RepeatedField $time_series_resource_hierarchy_level
      The scope of the timeseries data of the metric.

}

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

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

ignore

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

Clear all containing fields.

return null

public clearIngestDelay()

public clearSamplePeriod()

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

Clear all unknown fields previously parsed.

return null

public getIngestDelay()

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

Generated from protobuf field .google.protobuf.Duration ingest_delay = 3;

return \Google\Protobuf\Duration|null

public getLaunchStage()

Deprecated. Must use the [MetricDescriptor.launch_stage][google.api.MetricDescriptor.launch_stage] instead.

Generated from protobuf field .google.api.LaunchStage launch_stage = 1 [deprecated = true];

return int
deprecated

public getSamplePeriod()

The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.

Generated from protobuf field .google.protobuf.Duration sample_period = 2;

return \Google\Protobuf\Duration|null

public getTimeSeriesResourceHierarchyLevel()

The scope of the timeseries data of the metric.

Generated from protobuf field repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;

return \Google\Protobuf\Internal\RepeatedField

public hasIngestDelay()

public hasSamplePeriod()

public Google\Protobuf\Internal\Message::jsonByteSize( $options = 0)

ignore

public Google\Protobuf\Internal\Message::mergeFrom( $msg)

Merges the contents of the specified message into current message.

This method merges the contents of the specified message into the current message. Singular fields that are set in the specified message overwrite the corresponding fields in the current message. Repeated fields are appended. Map fields key-value pairs are overwritten. Singular/Oneof sub-messages are recursively merged. All overwritten sub-messages are deep-copied.

param object $msg Protobuf message to be merged from.
return null

public Google\Protobuf\Internal\Message::mergeFromJsonString( $data, $ignore_unknown = false)

Parses a json string to protobuf message.

This function takes a string in the json wire format, matching the encoding output by serializeToJsonString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Json protobuf data.
param bool $ignore_unknown
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::mergeFromString( $data)

Parses a protocol buffer contained in a string.

This function takes a string in the (non-human-readable) binary wire format, matching the encoding output by serializeToString(). See mergeFrom() for merging behavior, if the field is already set in the specified message.

param string $data Binary protobuf data.
return null
throws \Exception Invalid data.

public Google\Protobuf\Internal\Message::parseFromJsonStream( $input, $ignore_unknown)

ignore

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

ignore

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

ignore

public Google\Protobuf\Internal\Message::serializeToJsonString( $options = 0)

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 setIngestDelay( $var)

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

Generated from protobuf field .google.protobuf.Duration ingest_delay = 3;

param \Google\Protobuf\Duration $var
return $this

public setLaunchStage( $var)

Deprecated. Must use the [MetricDescriptor.launch_stage][google.api.MetricDescriptor.launch_stage] instead.

Generated from protobuf field .google.api.LaunchStage launch_stage = 1 [deprecated = true];

param int $var
return $this
deprecated

public setSamplePeriod( $var)

Generated from protobuf field .google.protobuf.Duration sample_period = 2;

param \Google\Protobuf\Duration $var
return $this

public setTimeSeriesResourceHierarchyLevel( $var)

The scope of the timeseries data of the metric.

Generated from protobuf field repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;

param int[]|\Google\Protobuf\Internal\RepeatedField $var
return $this

Properties

protected $ingest_delay = NULL

The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.

Generated from protobuf field .google.protobuf.Duration ingest_delay = 3;

protected $launch_stage = 0

Deprecated. Must use the [MetricDescriptor.launch_stage][google.api.MetricDescriptor.launch_stage] instead.

Generated from protobuf field .google.api.LaunchStage launch_stage = 1 [deprecated = true];

deprecated

protected $sample_period = NULL

Generated from protobuf field .google.protobuf.Duration sample_period = 2;

Methods

protected Google\Protobuf\Internal\Message::hasOneof( $number)

protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)

Populates the message from a user-supplied PHP array. Array keys correspond to Message properties and nested message properties.

Example:

$message->mergeFromArray([
    'name' => 'This is a message name',
    'interval' => [
         'startTime' => time() - 60,
         'endTime' => time(),
    ]
]);

This method will trigger an error if it is passed data that cannot be converted to the correct type. For example, a StringValue field must receive data that is either a string or a StringValue object.

param array $array An array containing message properties and values.
return null

protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array, $ignore_unknown)

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 $time_series_resource_hierarchy_level = NULL

The scope of the timeseries data of the metric.

Generated from protobuf field repeated .google.api.MetricDescriptor.MetricDescriptorMetadata.TimeSeriesResourceHierarchyLevel time_series_resource_hierarchy_level = 4;