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

MetricDescriptorMetadata

class MetricDescriptorMetadata extends Message

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

Generated from protobuf message google.api.MetricDescriptor.MetricDescriptorMetadata

Methods

__construct(array $data = NULL)

Constructor.

int
getLaunchStage()

Deprecated. Please use the MetricDescriptor.launch_stage instead.

$this
setLaunchStage(int $var)

Deprecated. Please use the MetricDescriptor.launch_stage instead.

Duration
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.

$this
setSamplePeriod(Duration $var)

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.

Duration
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.

$this
setIngestDelay(Duration $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.

Details

at line 63
__construct(array $data = NULL)

Constructor.

Parameters

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

@type int $launch_stage
      Deprecated. Please use the MetricDescriptor.launch_stage instead.
      The launch stage of the metric definition.
@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.

}

at line 75
int getLaunchStage()

Deprecated. Please use the MetricDescriptor.launch_stage instead.

The launch stage of the metric definition.

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

Return Value

int

at line 88
$this setLaunchStage(int $var)

Deprecated. Please use the MetricDescriptor.launch_stage instead.

The launch stage of the metric definition.

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

Parameters

int $var

Return Value

$this

at line 105
Duration 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 Value

Duration

at line 120
$this setSamplePeriod(Duration $var)

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;

Parameters

Duration $var

Return Value

$this

at line 136
Duration 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 Value

Duration

at line 150
$this setIngestDelay(Duration $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;

Parameters

Duration $var

Return Value

$this