Class JobMetrics (0.56.0) 

public final class JobMetrics extends GeneratedMessageV3 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > JobMetrics

Implements

JobMetricsOrBuilder

Static Fields

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
Type Description
int

METRIC_TIME_FIELD_NUMBER

public static final int METRIC_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static JobMetrics getDefaultInstance()
Returns
Type Description
JobMetrics

getDescriptor()

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

newBuilder()

public static JobMetrics.Builder newBuilder()
Returns
Type Description
JobMetrics.Builder

newBuilder(JobMetrics prototype)

public static JobMetrics.Builder newBuilder(JobMetrics prototype)
Parameter
Name Description
prototype JobMetrics
Returns
Type Description
JobMetrics.Builder

parseDelimitedFrom(InputStream input)

public static JobMetrics parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
JobMetrics
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JobMetrics parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobMetrics
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static JobMetrics parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
JobMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static JobMetrics parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static JobMetrics parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
JobMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static JobMetrics parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static JobMetrics parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
JobMetrics
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static JobMetrics parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobMetrics
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static JobMetrics parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
JobMetrics
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JobMetrics parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobMetrics
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static JobMetrics parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
JobMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static JobMetrics parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
JobMetrics
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<JobMetrics> parser()
Returns
Type Description
Parser<JobMetrics>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public JobMetrics getDefaultInstanceForType()
Returns
Type Description
JobMetrics

getMetricTime()

public Timestamp getMetricTime()

Timestamp as of which metric values are current.

.google.protobuf.Timestamp metric_time = 1;

Returns
Type Description
Timestamp

The metricTime.

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

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>

getParserForType()

public Parser<JobMetrics> getParserForType()
Returns
Type Description
Parser<JobMetrics>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public JobMetrics.Builder newBuilderForType()
Returns
Type Description
JobMetrics.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected JobMetrics.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
JobMetrics.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public JobMetrics.Builder toBuilder()
Returns
Type Description
JobMetrics.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException