Reference documentation and code samples for the Google API Common Protos Client class MetricDescriptorMetadata.
Additional annotations that can be used to guide the usage of a metric.
Generated from protobuf message google.api.MetricDescriptor.MetricDescriptorMetadata
Namespace
Google \ Api \ MetricDescriptorMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ launch_stage |
int
Deprecated. Must use the MetricDescriptor.launch_stage instead. |
↳ sample_period |
Google\Protobuf\Duration
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. |
↳ ingest_delay |
Google\Protobuf\Duration
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. |
getLaunchStage
Deprecated. Must use the MetricDescriptor.launch_stage instead.
| Returns | |
|---|---|
| Type | Description |
int |
|
setLaunchStage
Deprecated. Must use the MetricDescriptor.launch_stage instead.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasSamplePeriod
clearSamplePeriod
setSamplePeriod
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasIngestDelay
clearIngestDelay
setIngestDelay
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|