Reference documentation and code samples for the Google Cloud Dataflow V1beta3 Client class MetricStructuredName.
Identifies a metric, by describing the source which generated the metric.
Generated from protobuf message google.dataflow.v1beta3.MetricStructuredName
Namespace
Google \ Cloud \ Dataflow \ V1beta3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ origin |
string
Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK. |
↳ name |
string
Worker-defined metric name. |
↳ context |
array|Google\Protobuf\Internal\MapField
Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection. For example, built-in counters associated with steps will have context['step'] =
|
getOrigin
Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrigin
Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Worker-defined metric name.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Worker-defined metric name.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getContext
Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection.
For example, built-in counters associated with steps will have context['step'] =
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setContext
Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection.
For example, built-in counters associated with steps will have context['step'] =
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|