Class JobMetrics

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

Implements

JobMetricsOrBuilder

Fields

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

METRIC_TIME_FIELD_NUMBER

public static final int METRIC_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstance()

public static JobMetrics getDefaultInstance()
Returns
TypeDescription
JobMetrics

getDefaultInstanceForType()

public JobMetrics getDefaultInstanceForType()
Returns
TypeDescription
JobMetrics

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getMetricTime()

public Timestamp getMetricTime()

Timestamp as of which metric values are current.

.google.protobuf.Timestamp metric_time = 1;

Returns
TypeDescription
Timestamp

The metricTime.

getMetricTimeOrBuilder()

public TimestampOrBuilder getMetricTimeOrBuilder()

Timestamp as of which metric values are current.

.google.protobuf.Timestamp metric_time = 1;

Returns
TypeDescription
TimestampOrBuilder

getMetrics(int index)

public MetricUpdate getMetrics(int index)

All metrics for this job.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
MetricUpdate

getMetricsCount()

public int getMetricsCount()

All metrics for this job.

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

Returns
TypeDescription
int

getMetricsList()

public List<MetricUpdate> getMetricsList()

All metrics for this job.

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

Returns
TypeDescription
List<MetricUpdate>

getMetricsOrBuilder(int index)

public MetricUpdateOrBuilder getMetricsOrBuilder(int index)

All metrics for this job.

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

Parameter
NameDescription
indexint
Returns
TypeDescription
MetricUpdateOrBuilder

getMetricsOrBuilderList()

public List<? extends MetricUpdateOrBuilder> getMetricsOrBuilderList()

All metrics for this job.

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

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

getParserForType()

public Parser<JobMetrics> getParserForType()
Returns
TypeDescription
Parser<JobMetrics>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasMetricTime()

public boolean hasMetricTime()

Timestamp as of which metric values are current.

.google.protobuf.Timestamp metric_time = 1;

Returns
TypeDescription
boolean

Whether the metricTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static JobMetrics.Builder newBuilder()
Returns
TypeDescription
JobMetrics.Builder

newBuilder(JobMetrics prototype)

public static JobMetrics.Builder newBuilder(JobMetrics prototype)
Parameter
NameDescription
prototypeJobMetrics
Returns
TypeDescription
JobMetrics.Builder

newBuilderForType()

public JobMetrics.Builder newBuilderForType()
Returns
TypeDescription
JobMetrics.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected JobMetrics.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
JobMetrics.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static JobMetrics parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
JobMetrics
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JobMetrics parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JobMetrics
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static JobMetrics parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
JobMetrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static JobMetrics parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JobMetrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static JobMetrics parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
JobMetrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static JobMetrics parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JobMetrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static JobMetrics parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
JobMetrics
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static JobMetrics parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JobMetrics
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static JobMetrics parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
JobMetrics
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static JobMetrics parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JobMetrics
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static JobMetrics parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
JobMetrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static JobMetrics parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
JobMetrics
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<JobMetrics> parser()
Returns
TypeDescription
Parser<JobMetrics>

toBuilder()

public JobMetrics.Builder toBuilder()
Returns
TypeDescription
JobMetrics.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException