Class StageSummary.Builder (0.46.0)

public static final class StageSummary.Builder extends GeneratedMessageV3.Builder<StageSummary.Builder> implements StageSummaryOrBuilder

Information about a particular execution stage of a job.

Protobuf type google.dataflow.v1beta3.StageSummary

Static Methods

getDescriptor()

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

Methods

addAllMetrics(Iterable<? extends MetricUpdate> values)

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

Metrics for this stage.

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

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

addMetrics(MetricUpdate value)

public StageSummary.Builder addMetrics(MetricUpdate value)

Metrics for this stage.

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

Parameter
Name Description
value MetricUpdate
Returns
Type Description
StageSummary.Builder

addMetrics(MetricUpdate.Builder builderForValue)

public StageSummary.Builder addMetrics(MetricUpdate.Builder builderForValue)

Metrics for this stage.

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

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

addMetrics(int index, MetricUpdate value)

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

Metrics for this stage.

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

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

addMetrics(int index, MetricUpdate.Builder builderForValue)

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

Metrics for this stage.

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

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

addMetricsBuilder()

public MetricUpdate.Builder addMetricsBuilder()

Metrics for this stage.

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

Returns
Type Description
MetricUpdate.Builder

addMetricsBuilder(int index)

public MetricUpdate.Builder addMetricsBuilder(int index)

Metrics for this stage.

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

Parameter
Name Description
index int
Returns
Type Description
MetricUpdate.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public StageSummary build()
Returns
Type Description
StageSummary

buildPartial()

public StageSummary buildPartial()
Returns
Type Description
StageSummary

clear()

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

clearEndTime()

public StageSummary.Builder clearEndTime()

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
StageSummary.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearMetrics()

public StageSummary.Builder clearMetrics()

Metrics for this stage.

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

Returns
Type Description
StageSummary.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearProgress()

public StageSummary.Builder clearProgress()

Progress for this stage. Only applicable to Batch jobs.

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

Returns
Type Description
StageSummary.Builder

clearStageId()

public StageSummary.Builder clearStageId()

ID of this stage

string stage_id = 1;

Returns
Type Description
StageSummary.Builder

This builder for chaining.

clearStartTime()

public StageSummary.Builder clearStartTime()

Start time of this stage.

.google.protobuf.Timestamp start_time = 3;

Returns
Type Description
StageSummary.Builder

clearState()

public StageSummary.Builder clearState()

State of this stage.

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

Returns
Type Description
StageSummary.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public StageSummary getDefaultInstanceForType()
Returns
Type Description
StageSummary

getDescriptorForType()

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

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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

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
Builder

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

getMetricsBuilder(int index)

public MetricUpdate.Builder getMetricsBuilder(int index)

Metrics for this stage.

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

Parameter
Name Description
index int
Returns
Type Description
MetricUpdate.Builder

getMetricsBuilderList()

public List<MetricUpdate.Builder> getMetricsBuilderList()

Metrics for this stage.

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

Returns
Type Description
List<Builder>

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>

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.

getProgressBuilder()

public ProgressTimeseries.Builder getProgressBuilder()

Progress for this stage. Only applicable to Batch jobs.

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

Returns
Type Description
ProgressTimeseries.Builder

getProgressOrBuilder()

public ProgressTimeseriesOrBuilder getProgressOrBuilder()

Progress for this stage. Only applicable to Batch jobs.

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

Returns
Type Description
ProgressTimeseriesOrBuilder

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.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Start time of this stage.

.google.protobuf.Timestamp start_time = 3;

Returns
Type Description
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndTime(Timestamp value)

public StageSummary.Builder mergeEndTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
StageSummary.Builder

mergeFrom(StageSummary other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeProgress(ProgressTimeseries value)

public StageSummary.Builder mergeProgress(ProgressTimeseries value)

Progress for this stage. Only applicable to Batch jobs.

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

Parameter
Name Description
value ProgressTimeseries
Returns
Type Description
StageSummary.Builder

mergeStartTime(Timestamp value)

public StageSummary.Builder mergeStartTime(Timestamp value)

Start time of this stage.

.google.protobuf.Timestamp start_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
StageSummary.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeMetrics(int index)

public StageSummary.Builder removeMetrics(int index)

Metrics for this stage.

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

Parameter
Name Description
index int
Returns
Type Description
StageSummary.Builder

setEndTime(Timestamp value)

public StageSummary.Builder setEndTime(Timestamp value)

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;

Parameter
Name Description
value Timestamp
Returns
Type Description
StageSummary.Builder

setEndTime(Timestamp.Builder builderForValue)

public StageSummary.Builder setEndTime(Timestamp.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
StageSummary.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setMetrics(int index, MetricUpdate value)

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

Metrics for this stage.

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

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

setMetrics(int index, MetricUpdate.Builder builderForValue)

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

Metrics for this stage.

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

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

setProgress(ProgressTimeseries value)

public StageSummary.Builder setProgress(ProgressTimeseries value)

Progress for this stage. Only applicable to Batch jobs.

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

Parameter
Name Description
value ProgressTimeseries
Returns
Type Description
StageSummary.Builder

setProgress(ProgressTimeseries.Builder builderForValue)

public StageSummary.Builder setProgress(ProgressTimeseries.Builder builderForValue)

Progress for this stage. Only applicable to Batch jobs.

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

Parameter
Name Description
builderForValue ProgressTimeseries.Builder
Returns
Type Description
StageSummary.Builder

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

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

setStageId(String value)

public StageSummary.Builder setStageId(String value)

ID of this stage

string stage_id = 1;

Parameter
Name Description
value String

The stageId to set.

Returns
Type Description
StageSummary.Builder

This builder for chaining.

setStageIdBytes(ByteString value)

public StageSummary.Builder setStageIdBytes(ByteString value)

ID of this stage

string stage_id = 1;

Parameter
Name Description
value ByteString

The bytes for stageId to set.

Returns
Type Description
StageSummary.Builder

This builder for chaining.

setStartTime(Timestamp value)

public StageSummary.Builder setStartTime(Timestamp value)

Start time of this stage.

.google.protobuf.Timestamp start_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
StageSummary.Builder

setStartTime(Timestamp.Builder builderForValue)

public StageSummary.Builder setStartTime(Timestamp.Builder builderForValue)

Start time of this stage.

.google.protobuf.Timestamp start_time = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
StageSummary.Builder

setState(ExecutionState value)

public StageSummary.Builder setState(ExecutionState value)

State of this stage.

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

Parameter
Name Description
value ExecutionState

The state to set.

Returns
Type Description
StageSummary.Builder

This builder for chaining.

setStateValue(int value)

public StageSummary.Builder setStateValue(int value)

State of this stage.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
StageSummary.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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