Class JobMetrics.Builder (0.56.0)

public static final class JobMetrics.Builder extends GeneratedMessageV3.Builder<JobMetrics.Builder> implements JobMetricsOrBuilder

JobMetrics contains a collection of metrics describing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job.

This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.

Protobuf type google.dataflow.v1beta3.JobMetrics

Implements

JobMetricsOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllMetrics(Iterable<? extends MetricUpdate> values)

public JobMetrics.Builder addAllMetrics(Iterable<? extends MetricUpdate> values)

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Parameter
Name Description
values Iterable<? extends com.google.dataflow.v1beta3.MetricUpdate>
Returns
Type Description
JobMetrics.Builder

addMetrics(MetricUpdate value)

public JobMetrics.Builder addMetrics(MetricUpdate value)

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Parameter
Name Description
value MetricUpdate
Returns
Type Description
JobMetrics.Builder

addMetrics(MetricUpdate.Builder builderForValue)

public JobMetrics.Builder addMetrics(MetricUpdate.Builder builderForValue)

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Parameter
Name Description
builderForValue MetricUpdate.Builder
Returns
Type Description
JobMetrics.Builder

addMetrics(int index, MetricUpdate value)

public JobMetrics.Builder addMetrics(int index, MetricUpdate value)

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Parameters
Name Description
index int
value MetricUpdate
Returns
Type Description
JobMetrics.Builder

addMetrics(int index, MetricUpdate.Builder builderForValue)

public JobMetrics.Builder addMetrics(int index, MetricUpdate.Builder builderForValue)

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Parameters
Name Description
index int
builderForValue MetricUpdate.Builder
Returns
Type Description
JobMetrics.Builder

addMetricsBuilder()

public MetricUpdate.Builder addMetricsBuilder()

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Returns
Type Description
MetricUpdate.Builder

addMetricsBuilder(int index)

public MetricUpdate.Builder addMetricsBuilder(int index)

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Parameter
Name Description
index int
Returns
Type Description
MetricUpdate.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public JobMetrics.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
JobMetrics.Builder
Overrides

build()

public JobMetrics build()
Returns
Type Description
JobMetrics

buildPartial()

public JobMetrics buildPartial()
Returns
Type Description
JobMetrics

clear()

public JobMetrics.Builder clear()
Returns
Type Description
JobMetrics.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public JobMetrics.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
JobMetrics.Builder
Overrides

clearMetricTime()

public JobMetrics.Builder clearMetricTime()

Timestamp as of which metric values are current.

.google.protobuf.Timestamp metric_time = 1;

Returns
Type Description
JobMetrics.Builder

clearMetrics()

public JobMetrics.Builder clearMetrics()

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Returns
Type Description
JobMetrics.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public JobMetrics.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
JobMetrics.Builder
Overrides

clone()

public JobMetrics.Builder clone()
Returns
Type Description
JobMetrics.Builder
Overrides

getDefaultInstanceForType()

public JobMetrics getDefaultInstanceForType()
Returns
Type Description
JobMetrics

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMetricTime()

public Timestamp getMetricTime()

Timestamp as of which metric values are current.

.google.protobuf.Timestamp metric_time = 1;

Returns
Type Description
Timestamp

The metricTime.

getMetricTimeBuilder()

public Timestamp.Builder getMetricTimeBuilder()

Timestamp as of which metric values are current.

.google.protobuf.Timestamp metric_time = 1;

Returns
Type Description
Builder

getMetricTimeOrBuilder()

public TimestampOrBuilder getMetricTimeOrBuilder()

Timestamp as of which metric values are current.

.google.protobuf.Timestamp metric_time = 1;

Returns
Type Description
TimestampOrBuilder

getMetrics(int index)

public MetricUpdate getMetrics(int index)

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Parameter
Name Description
index int
Returns
Type Description
MetricUpdate

getMetricsBuilder(int index)

public MetricUpdate.Builder getMetricsBuilder(int index)

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Parameter
Name Description
index int
Returns
Type Description
MetricUpdate.Builder

getMetricsBuilderList()

public List<MetricUpdate.Builder> getMetricsBuilderList()

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Returns
Type Description
List<Builder>

getMetricsCount()

public int getMetricsCount()

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Returns
Type Description
int

getMetricsList()

public List<MetricUpdate> getMetricsList()

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Returns
Type Description
List<MetricUpdate>

getMetricsOrBuilder(int index)

public MetricUpdateOrBuilder getMetricsOrBuilder(int index)

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Parameter
Name Description
index int
Returns
Type Description
MetricUpdateOrBuilder

getMetricsOrBuilderList()

public List<? extends MetricUpdateOrBuilder> getMetricsOrBuilderList()

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Returns
Type Description
List<? extends com.google.dataflow.v1beta3.MetricUpdateOrBuilder>

hasMetricTime()

public boolean hasMetricTime()

Timestamp as of which metric values are current.

.google.protobuf.Timestamp metric_time = 1;

Returns
Type Description
boolean

Whether the metricTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(JobMetrics other)

public JobMetrics.Builder mergeFrom(JobMetrics other)
Parameter
Name Description
other JobMetrics
Returns
Type Description
JobMetrics.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public JobMetrics.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobMetrics.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public JobMetrics.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
JobMetrics.Builder
Overrides

mergeMetricTime(Timestamp value)

public JobMetrics.Builder mergeMetricTime(Timestamp value)

Timestamp as of which metric values are current.

.google.protobuf.Timestamp metric_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
JobMetrics.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final JobMetrics.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
JobMetrics.Builder
Overrides

removeMetrics(int index)

public JobMetrics.Builder removeMetrics(int index)

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Parameter
Name Description
index int
Returns
Type Description
JobMetrics.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public JobMetrics.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
JobMetrics.Builder
Overrides

setMetricTime(Timestamp value)

public JobMetrics.Builder setMetricTime(Timestamp value)

Timestamp as of which metric values are current.

.google.protobuf.Timestamp metric_time = 1;

Parameter
Name Description
value Timestamp
Returns
Type Description
JobMetrics.Builder

setMetricTime(Timestamp.Builder builderForValue)

public JobMetrics.Builder setMetricTime(Timestamp.Builder builderForValue)

Timestamp as of which metric values are current.

.google.protobuf.Timestamp metric_time = 1;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
JobMetrics.Builder

setMetrics(int index, MetricUpdate value)

public JobMetrics.Builder setMetrics(int index, MetricUpdate value)

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Parameters
Name Description
index int
value MetricUpdate
Returns
Type Description
JobMetrics.Builder

setMetrics(int index, MetricUpdate.Builder builderForValue)

public JobMetrics.Builder setMetrics(int index, MetricUpdate.Builder builderForValue)

All metrics for this job.

repeated .google.dataflow.v1beta3.MetricUpdate metrics = 2;

Parameters
Name Description
index int
builderForValue MetricUpdate.Builder
Returns
Type Description
JobMetrics.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public JobMetrics.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
JobMetrics.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final JobMetrics.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
JobMetrics.Builder
Overrides