org.apache.beam.fn.v1

Class BeamFnApi.Metrics.PTransform.ActiveElements.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

org.apache.beam.fn.v1.BeamFnApi.Metrics.PTransform.ActiveElements.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder

Enclosing class:

BeamFnApi.Metrics.PTransform.ActiveElements

public static final class BeamFnApi.Metrics.PTransform.ActiveElements.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>
implements BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder

 Metrics for active elements.
 An element is considered active if the SDK has started but not finished
 processing it yet.
 

Protobuf type org.apache.beam.fn.v1.Metrics.PTransform.ActiveElements

Method Summary

Modifier and Type	Method and Description
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
BeamFnApi.Metrics.PTransform.ActiveElements	build()
BeamFnApi.Metrics.PTransform.ActiveElements	buildPartial()
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	clear()
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	clearFractionRemaining() (Optional) Sum of estimated fraction of known work remaining for all active elements, as reported by this transform.
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	clearMeasured() (Required)
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	clearOutputElementsRemaining()
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	clone()
boolean	containsOutputElementsRemaining(String key) (Optional) Map from local output name to sum of estimated number of elements remaining for this output from all active elements, as reported by this transform.
BeamFnApi.Metrics.PTransform.ActiveElements	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
double	getFractionRemaining() (Optional) Sum of estimated fraction of known work remaining for all active elements, as reported by this transform.
BeamFnApi.Metrics.PTransform.Measured	getMeasured() (Required)
BeamFnApi.Metrics.PTransform.Measured.Builder	getMeasuredBuilder() (Required)
BeamFnApi.Metrics.PTransform.MeasuredOrBuilder	getMeasuredOrBuilder() (Required)
Map<String,Long>	getMutableOutputElementsRemaining() Deprecated.
Map<String,Long>	getOutputElementsRemaining() Deprecated.
int	getOutputElementsRemainingCount() (Optional) Map from local output name to sum of estimated number of elements remaining for this output from all active elements, as reported by this transform.
Map<String,Long>	getOutputElementsRemainingMap() (Optional) Map from local output name to sum of estimated number of elements remaining for this output from all active elements, as reported by this transform.
long	getOutputElementsRemainingOrDefault(String key, long defaultValue) (Optional) Map from local output name to sum of estimated number of elements remaining for this output from all active elements, as reported by this transform.
long	getOutputElementsRemainingOrThrow(String key) (Optional) Map from local output name to sum of estimated number of elements remaining for this output from all active elements, as reported by this transform.
boolean	hasMeasured() (Required)
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
protected com.google.protobuf.MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	mergeFrom(BeamFnApi.Metrics.PTransform.ActiveElements other)
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	mergeFrom(com.google.protobuf.Message other)
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	mergeMeasured(BeamFnApi.Metrics.PTransform.Measured value) (Required)
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	putAllOutputElementsRemaining(Map<String,Long> values) (Optional) Map from local output name to sum of estimated number of elements remaining for this output from all active elements, as reported by this transform.
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	putOutputElementsRemaining(String key, long value) (Optional) Map from local output name to sum of estimated number of elements remaining for this output from all active elements, as reported by this transform.
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	removeOutputElementsRemaining(String key) (Optional) Map from local output name to sum of estimated number of elements remaining for this output from all active elements, as reported by this transform.
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	setFractionRemaining(double value) (Optional) Sum of estimated fraction of known work remaining for all active elements, as reported by this transform.
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	setMeasured(BeamFnApi.Metrics.PTransform.Measured.Builder builderForValue) (Required)
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	setMeasured(BeamFnApi.Metrics.PTransform.Measured value) (Required)
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

internalGetMutableMapField

protected com.google.protobuf.MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

clear

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

getDefaultInstanceForType

public BeamFnApi.Metrics.PTransform.ActiveElements getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public BeamFnApi.Metrics.PTransform.ActiveElements build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public BeamFnApi.Metrics.PTransform.ActiveElements buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

setField

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                    Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

clearField

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

clearOneof

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

setRepeatedField

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                            int index,
                                                                            Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

addRepeatedField

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                            Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

mergeFrom

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

mergeFrom

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder mergeFrom(BeamFnApi.Metrics.PTransform.ActiveElements other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

mergeFrom

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                              throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

Throws:

IOException

hasMeasured

public boolean hasMeasured()

 (Required)
 

.org.apache.beam.fn.v1.Metrics.PTransform.Measured measured = 1;

Specified by:

hasMeasured in interface BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder

getMeasured

public BeamFnApi.Metrics.PTransform.Measured getMeasured()

 (Required)
 

.org.apache.beam.fn.v1.Metrics.PTransform.Measured measured = 1;

Specified by:

getMeasured in interface BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder

setMeasured

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder setMeasured(BeamFnApi.Metrics.PTransform.Measured value)

 (Required)
 

.org.apache.beam.fn.v1.Metrics.PTransform.Measured measured = 1;

setMeasured

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder setMeasured(BeamFnApi.Metrics.PTransform.Measured.Builder builderForValue)

 (Required)
 

.org.apache.beam.fn.v1.Metrics.PTransform.Measured measured = 1;

mergeMeasured

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder mergeMeasured(BeamFnApi.Metrics.PTransform.Measured value)

 (Required)
 

.org.apache.beam.fn.v1.Metrics.PTransform.Measured measured = 1;

clearMeasured

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder clearMeasured()

 (Required)
 

.org.apache.beam.fn.v1.Metrics.PTransform.Measured measured = 1;

getMeasuredBuilder

public BeamFnApi.Metrics.PTransform.Measured.Builder getMeasuredBuilder()

 (Required)
 

.org.apache.beam.fn.v1.Metrics.PTransform.Measured measured = 1;

getMeasuredOrBuilder

public BeamFnApi.Metrics.PTransform.MeasuredOrBuilder getMeasuredOrBuilder()

 (Required)
 

.org.apache.beam.fn.v1.Metrics.PTransform.Measured measured = 1;

Specified by:

getMeasuredOrBuilder in interface BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder

getFractionRemaining

public double getFractionRemaining()

 (Optional) Sum of estimated fraction of known work remaining for all
 active elements, as reported by this transform.
 If not reported, a Runner could extrapolate this from the processed
 elements.
 TODO: Handle the case when known work is infinite.
 

double fraction_remaining = 2;

Specified by:

getFractionRemaining in interface BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder

setFractionRemaining

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder setFractionRemaining(double value)

 (Optional) Sum of estimated fraction of known work remaining for all
 active elements, as reported by this transform.
 If not reported, a Runner could extrapolate this from the processed
 elements.
 TODO: Handle the case when known work is infinite.
 

double fraction_remaining = 2;

clearFractionRemaining

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder clearFractionRemaining()

 (Optional) Sum of estimated fraction of known work remaining for all
 active elements, as reported by this transform.
 If not reported, a Runner could extrapolate this from the processed
 elements.
 TODO: Handle the case when known work is infinite.
 

double fraction_remaining = 2;

getOutputElementsRemainingCount

public int getOutputElementsRemainingCount()

Description copied from interface: BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder

 (Optional) Map from local output name to sum of estimated number
 of elements remaining for this output from all active elements,
 as reported by this transform.
 If not reported, a Runner could extrapolate this from the processed
 elements.
 

map<string, int64> output_elements_remaining = 3;

Specified by:

getOutputElementsRemainingCount in interface BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder

containsOutputElementsRemaining

public boolean containsOutputElementsRemaining(String key)

 (Optional) Map from local output name to sum of estimated number
 of elements remaining for this output from all active elements,
 as reported by this transform.
 If not reported, a Runner could extrapolate this from the processed
 elements.
 

map<string, int64> output_elements_remaining = 3;

Specified by:

containsOutputElementsRemaining in interface BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder

getOutputElementsRemaining

@Deprecated
public Map<String,Long> getOutputElementsRemaining()

Deprecated.

Use getOutputElementsRemainingMap() instead.

Specified by:

getOutputElementsRemaining in interface BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder

getOutputElementsRemainingMap

public Map<String,Long> getOutputElementsRemainingMap()

 (Optional) Map from local output name to sum of estimated number
 of elements remaining for this output from all active elements,
 as reported by this transform.
 If not reported, a Runner could extrapolate this from the processed
 elements.
 

map<string, int64> output_elements_remaining = 3;

Specified by:

getOutputElementsRemainingMap in interface BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder

getOutputElementsRemainingOrDefault

public long getOutputElementsRemainingOrDefault(String key,
                                                long defaultValue)

 (Optional) Map from local output name to sum of estimated number
 of elements remaining for this output from all active elements,
 as reported by this transform.
 If not reported, a Runner could extrapolate this from the processed
 elements.
 

map<string, int64> output_elements_remaining = 3;

Specified by:

getOutputElementsRemainingOrDefault in interface BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder

getOutputElementsRemainingOrThrow

public long getOutputElementsRemainingOrThrow(String key)

 (Optional) Map from local output name to sum of estimated number
 of elements remaining for this output from all active elements,
 as reported by this transform.
 If not reported, a Runner could extrapolate this from the processed
 elements.
 

map<string, int64> output_elements_remaining = 3;

Specified by:

getOutputElementsRemainingOrThrow in interface BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder

clearOutputElementsRemaining

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder clearOutputElementsRemaining()

removeOutputElementsRemaining

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder removeOutputElementsRemaining(String key)

 (Optional) Map from local output name to sum of estimated number
 of elements remaining for this output from all active elements,
 as reported by this transform.
 If not reported, a Runner could extrapolate this from the processed
 elements.
 

map<string, int64> output_elements_remaining = 3;

getMutableOutputElementsRemaining

@Deprecated
public Map<String,Long> getMutableOutputElementsRemaining()

Deprecated.

Use alternate mutation accessors instead.

putOutputElementsRemaining

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder putOutputElementsRemaining(String key,
                                                                                      long value)

 (Optional) Map from local output name to sum of estimated number
 of elements remaining for this output from all active elements,
 as reported by this transform.
 If not reported, a Runner could extrapolate this from the processed
 elements.
 

map<string, int64> output_elements_remaining = 3;

putAllOutputElementsRemaining

public BeamFnApi.Metrics.PTransform.ActiveElements.Builder putAllOutputElementsRemaining(Map<String,Long> values)

 (Optional) Map from local output name to sum of estimated number
 of elements remaining for this output from all active elements,
 as reported by this transform.
 If not reported, a Runner could extrapolate this from the processed
 elements.
 

map<string, int64> output_elements_remaining = 3;

setUnknownFields

public final BeamFnApi.Metrics.PTransform.ActiveElements.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>

mergeUnknownFields

public final BeamFnApi.Metrics.PTransform.ActiveElements.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BeamFnApi.Metrics.PTransform.ActiveElements.Builder>