Class StageSummary (0.55.0)

public final class StageSummary extends GeneratedMessageV3 implements StageSummaryOrBuilder

Information about a particular execution stage of a job.

Protobuf type google.dataflow.v1beta3.StageSummary

Static Fields

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

METRICS_FIELD_NUMBER

public static final int METRICS_FIELD_NUMBER
Field Value
Type Description
int

PROGRESS_FIELD_NUMBER

public static final int PROGRESS_FIELD_NUMBER
Field Value
Type Description
int

STAGE_ID_FIELD_NUMBER

public static final int STAGE_ID_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static StageSummary getDefaultInstance()
Returns
Type Description
StageSummary

getDescriptor()

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

newBuilder()

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

newBuilder(StageSummary prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public StageSummary getDefaultInstanceForType()
Returns
Type Description
StageSummary

getEndTime()

public Timestamp getEndTime()

End time of this stage.

If the work item is completed, this is the actual end time of the stage. Otherwise, it is the predicted end time.

.google.protobuf.Timestamp end_time = 4;

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

End time of this stage.

If the work item is completed, this is the actual end time of the stage. Otherwise, it is the predicted end time.

.google.protobuf.Timestamp end_time = 4;

Returns
Type Description
TimestampOrBuilder

getMetrics(int index)

public MetricUpdate getMetrics(int index)

Metrics for this stage.

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

Parameter
Name Description
index int
Returns
Type Description
MetricUpdate

getMetricsCount()

public int getMetricsCount()

Metrics for this stage.

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

Returns
Type Description
int

getMetricsList()

public List<MetricUpdate> getMetricsList()

Metrics for this stage.

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

Returns
Type Description
List<MetricUpdate>

getMetricsOrBuilder(int index)

public MetricUpdateOrBuilder getMetricsOrBuilder(int index)

Metrics for this stage.

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

Parameter
Name Description
index int
Returns
Type Description
MetricUpdateOrBuilder

getMetricsOrBuilderList()

public List<? extends MetricUpdateOrBuilder> getMetricsOrBuilderList()

Metrics for this stage.

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

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

getParserForType()

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

getProgress()

public ProgressTimeseries getProgress()

Progress for this stage. Only applicable to Batch jobs.

.google.dataflow.v1beta3.ProgressTimeseries progress = 5;

Returns
Type Description
ProgressTimeseries

The progress.

getProgressOrBuilder()

public ProgressTimeseriesOrBuilder getProgressOrBuilder()

Progress for this stage. Only applicable to Batch jobs.

.google.dataflow.v1beta3.ProgressTimeseries progress = 5;

Returns
Type Description
ProgressTimeseriesOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStageId()

public String getStageId()

ID of this stage

string stage_id = 1;

Returns
Type Description
String

The stageId.

getStageIdBytes()

public ByteString getStageIdBytes()

ID of this stage

string stage_id = 1;

Returns
Type Description
ByteString

The bytes for stageId.

getStartTime()

public Timestamp getStartTime()

Start time of this stage.

.google.protobuf.Timestamp start_time = 3;

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Start time of this stage.

.google.protobuf.Timestamp start_time = 3;

Returns
Type Description
TimestampOrBuilder

getState()

public ExecutionState getState()

State of this stage.

.google.dataflow.v1beta3.ExecutionState state = 2;

Returns
Type Description
ExecutionState

The state.

getStateValue()

public int getStateValue()

State of this stage.

.google.dataflow.v1beta3.ExecutionState state = 2;

Returns
Type Description
int

The enum numeric value on the wire for state.

hasEndTime()

public boolean hasEndTime()

End time of this stage.

If the work item is completed, this is the actual end time of the stage. Otherwise, it is the predicted end time.

.google.protobuf.Timestamp end_time = 4;

Returns
Type Description
boolean

Whether the endTime field is set.

hasProgress()

public boolean hasProgress()

Progress for this stage. Only applicable to Batch jobs.

.google.dataflow.v1beta3.ProgressTimeseries progress = 5;

Returns
Type Description
boolean

Whether the progress field is set.

hasStartTime()

public boolean hasStartTime()

Start time of this stage.

.google.protobuf.Timestamp start_time = 3;

Returns
Type Description
boolean

Whether the startTime 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 StageSummary.Builder newBuilderForType()
Returns
Type Description
StageSummary.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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