org.apache.beam.fn.v1

Class BeamFnApi.Metrics.PTransform.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

org.apache.beam.fn.v1.BeamFnApi.Metrics.PTransform.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.PTransformOrBuilder

Enclosing class:

BeamFnApi.Metrics.PTransform

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

 PTransform level metrics.
 These metrics are split into processed and active element groups for
 progress reporting purposes. This allows a Runner to see what is measured,
 what is estimated and what can be extrapolated to be able to accurately
 estimate the backlog of remaining work.
 

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

Method Summary

Modifier and Type	Method and Description
BeamFnApi.Metrics.PTransform.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
BeamFnApi.Metrics.PTransform	build()
BeamFnApi.Metrics.PTransform	buildPartial()
BeamFnApi.Metrics.PTransform.Builder	clear()
BeamFnApi.Metrics.PTransform.Builder	clearActiveElements() (Required): Metrics for active elements.
BeamFnApi.Metrics.PTransform.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
BeamFnApi.Metrics.PTransform.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
BeamFnApi.Metrics.PTransform.Builder	clearProcessedElements() (Required): Metrics for processed elements.
BeamFnApi.Metrics.PTransform.Builder	clearWatermarks()
BeamFnApi.Metrics.PTransform.Builder	clone()
boolean	containsWatermarks(String key) (Optional): Map from local output name to its watermark.
BeamFnApi.Metrics.PTransform.ActiveElements	getActiveElements() (Required): Metrics for active elements.
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	getActiveElementsBuilder() (Required): Metrics for active elements.
BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder	getActiveElementsOrBuilder() (Required): Metrics for active elements.
BeamFnApi.Metrics.PTransform	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Map<String,Long>	getMutableWatermarks() Deprecated.
BeamFnApi.Metrics.PTransform.ProcessedElements	getProcessedElements() (Required): Metrics for processed elements.
BeamFnApi.Metrics.PTransform.ProcessedElements.Builder	getProcessedElementsBuilder() (Required): Metrics for processed elements.
BeamFnApi.Metrics.PTransform.ProcessedElementsOrBuilder	getProcessedElementsOrBuilder() (Required): Metrics for processed elements.
Map<String,Long>	getWatermarks() Deprecated.
int	getWatermarksCount() (Optional): Map from local output name to its watermark.
Map<String,Long>	getWatermarksMap() (Optional): Map from local output name to its watermark.
long	getWatermarksOrDefault(String key, long defaultValue) (Optional): Map from local output name to its watermark.
long	getWatermarksOrThrow(String key) (Optional): Map from local output name to its watermark.
boolean	hasActiveElements() (Required): Metrics for active elements.
boolean	hasProcessedElements() (Required): Metrics for processed elements.
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.Builder	mergeActiveElements(BeamFnApi.Metrics.PTransform.ActiveElements value) (Required): Metrics for active elements.
BeamFnApi.Metrics.PTransform.Builder	mergeFrom(BeamFnApi.Metrics.PTransform other)
BeamFnApi.Metrics.PTransform.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
BeamFnApi.Metrics.PTransform.Builder	mergeFrom(com.google.protobuf.Message other)
BeamFnApi.Metrics.PTransform.Builder	mergeProcessedElements(BeamFnApi.Metrics.PTransform.ProcessedElements value) (Required): Metrics for processed elements.
BeamFnApi.Metrics.PTransform.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
BeamFnApi.Metrics.PTransform.Builder	putAllWatermarks(Map<String,Long> values) (Optional): Map from local output name to its watermark.
BeamFnApi.Metrics.PTransform.Builder	putWatermarks(String key, long value) (Optional): Map from local output name to its watermark.
BeamFnApi.Metrics.PTransform.Builder	removeWatermarks(String key) (Optional): Map from local output name to its watermark.
BeamFnApi.Metrics.PTransform.Builder	setActiveElements(BeamFnApi.Metrics.PTransform.ActiveElements.Builder builderForValue) (Required): Metrics for active elements.
BeamFnApi.Metrics.PTransform.Builder	setActiveElements(BeamFnApi.Metrics.PTransform.ActiveElements value) (Required): Metrics for active elements.
BeamFnApi.Metrics.PTransform.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
BeamFnApi.Metrics.PTransform.Builder	setProcessedElements(BeamFnApi.Metrics.PTransform.ProcessedElements.Builder builderForValue) (Required): Metrics for processed elements.
BeamFnApi.Metrics.PTransform.Builder	setProcessedElements(BeamFnApi.Metrics.PTransform.ProcessedElements value) (Required): Metrics for processed elements.
BeamFnApi.Metrics.PTransform.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
BeamFnApi.Metrics.PTransform.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.Builder>

internalGetMutableMapField

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

Overrides:

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

internalGetFieldAccessorTable

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

Specified by:

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

clear

public BeamFnApi.Metrics.PTransform.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.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.Builder>

getDefaultInstanceForType

public BeamFnApi.Metrics.PTransform getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public BeamFnApi.Metrics.PTransform 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 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.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.Builder>

setField

public BeamFnApi.Metrics.PTransform.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.Builder>

clearField

public BeamFnApi.Metrics.PTransform.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.Builder>

clearOneof

public BeamFnApi.Metrics.PTransform.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.Builder>

setRepeatedField

public BeamFnApi.Metrics.PTransform.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.Builder>

addRepeatedField

public BeamFnApi.Metrics.PTransform.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.Builder>

mergeFrom

public BeamFnApi.Metrics.PTransform.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.Builder>

mergeFrom

public BeamFnApi.Metrics.PTransform.Builder mergeFrom(BeamFnApi.Metrics.PTransform 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.Builder>

mergeFrom

public BeamFnApi.Metrics.PTransform.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.Builder>

Throws:

IOException

hasProcessedElements

public boolean hasProcessedElements()

 (Required): Metrics for processed elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ProcessedElements processed_elements = 1;

Specified by:

hasProcessedElements in interface BeamFnApi.Metrics.PTransformOrBuilder

getProcessedElements

public BeamFnApi.Metrics.PTransform.ProcessedElements getProcessedElements()

 (Required): Metrics for processed elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ProcessedElements processed_elements = 1;

Specified by:

getProcessedElements in interface BeamFnApi.Metrics.PTransformOrBuilder

setProcessedElements

public BeamFnApi.Metrics.PTransform.Builder setProcessedElements(BeamFnApi.Metrics.PTransform.ProcessedElements value)

 (Required): Metrics for processed elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ProcessedElements processed_elements = 1;

setProcessedElements

public BeamFnApi.Metrics.PTransform.Builder setProcessedElements(BeamFnApi.Metrics.PTransform.ProcessedElements.Builder builderForValue)

 (Required): Metrics for processed elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ProcessedElements processed_elements = 1;

mergeProcessedElements

public BeamFnApi.Metrics.PTransform.Builder mergeProcessedElements(BeamFnApi.Metrics.PTransform.ProcessedElements value)

 (Required): Metrics for processed elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ProcessedElements processed_elements = 1;

clearProcessedElements

public BeamFnApi.Metrics.PTransform.Builder clearProcessedElements()

 (Required): Metrics for processed elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ProcessedElements processed_elements = 1;

getProcessedElementsBuilder

public BeamFnApi.Metrics.PTransform.ProcessedElements.Builder getProcessedElementsBuilder()

 (Required): Metrics for processed elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ProcessedElements processed_elements = 1;

getProcessedElementsOrBuilder

public BeamFnApi.Metrics.PTransform.ProcessedElementsOrBuilder getProcessedElementsOrBuilder()

 (Required): Metrics for processed elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ProcessedElements processed_elements = 1;

Specified by:

getProcessedElementsOrBuilder in interface BeamFnApi.Metrics.PTransformOrBuilder

hasActiveElements

public boolean hasActiveElements()

 (Required): Metrics for active elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ActiveElements active_elements = 2;

Specified by:

hasActiveElements in interface BeamFnApi.Metrics.PTransformOrBuilder

getActiveElements

public BeamFnApi.Metrics.PTransform.ActiveElements getActiveElements()

 (Required): Metrics for active elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ActiveElements active_elements = 2;

Specified by:

getActiveElements in interface BeamFnApi.Metrics.PTransformOrBuilder

setActiveElements

public BeamFnApi.Metrics.PTransform.Builder setActiveElements(BeamFnApi.Metrics.PTransform.ActiveElements value)

 (Required): Metrics for active elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ActiveElements active_elements = 2;

setActiveElements

public BeamFnApi.Metrics.PTransform.Builder setActiveElements(BeamFnApi.Metrics.PTransform.ActiveElements.Builder builderForValue)

 (Required): Metrics for active elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ActiveElements active_elements = 2;

mergeActiveElements

public BeamFnApi.Metrics.PTransform.Builder mergeActiveElements(BeamFnApi.Metrics.PTransform.ActiveElements value)

 (Required): Metrics for active elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ActiveElements active_elements = 2;

clearActiveElements

public BeamFnApi.Metrics.PTransform.Builder clearActiveElements()

 (Required): Metrics for active elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ActiveElements active_elements = 2;

getActiveElementsBuilder

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

 (Required): Metrics for active elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ActiveElements active_elements = 2;

getActiveElementsOrBuilder

public BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder getActiveElementsOrBuilder()

 (Required): Metrics for active elements.
 

.org.apache.beam.fn.v1.Metrics.PTransform.ActiveElements active_elements = 2;

Specified by:

getActiveElementsOrBuilder in interface BeamFnApi.Metrics.PTransformOrBuilder

getWatermarksCount

public int getWatermarksCount()

Description copied from interface: BeamFnApi.Metrics.PTransformOrBuilder

 (Optional): Map from local output name to its watermark.
 The watermarks reported are tentative, to get a better sense of progress
 while processing a bundle but before it is committed. At bundle commit
 time, a Runner needs to also take into account the timers set to compute
 the actual watermarks.
 

map<string, int64> watermarks = 3;

Specified by:

getWatermarksCount in interface BeamFnApi.Metrics.PTransformOrBuilder

containsWatermarks

public boolean containsWatermarks(String key)

 (Optional): Map from local output name to its watermark.
 The watermarks reported are tentative, to get a better sense of progress
 while processing a bundle but before it is committed. At bundle commit
 time, a Runner needs to also take into account the timers set to compute
 the actual watermarks.
 

map<string, int64> watermarks = 3;

Specified by:

containsWatermarks in interface BeamFnApi.Metrics.PTransformOrBuilder

getWatermarks

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

Deprecated.

Use getWatermarksMap() instead.

Specified by:

getWatermarks in interface BeamFnApi.Metrics.PTransformOrBuilder

getWatermarksMap

public Map<String,Long> getWatermarksMap()

 (Optional): Map from local output name to its watermark.
 The watermarks reported are tentative, to get a better sense of progress
 while processing a bundle but before it is committed. At bundle commit
 time, a Runner needs to also take into account the timers set to compute
 the actual watermarks.
 

map<string, int64> watermarks = 3;

Specified by:

getWatermarksMap in interface BeamFnApi.Metrics.PTransformOrBuilder

getWatermarksOrDefault

public long getWatermarksOrDefault(String key,
                                   long defaultValue)

 (Optional): Map from local output name to its watermark.
 The watermarks reported are tentative, to get a better sense of progress
 while processing a bundle but before it is committed. At bundle commit
 time, a Runner needs to also take into account the timers set to compute
 the actual watermarks.
 

map<string, int64> watermarks = 3;

Specified by:

getWatermarksOrDefault in interface BeamFnApi.Metrics.PTransformOrBuilder

getWatermarksOrThrow

public long getWatermarksOrThrow(String key)

 (Optional): Map from local output name to its watermark.
 The watermarks reported are tentative, to get a better sense of progress
 while processing a bundle but before it is committed. At bundle commit
 time, a Runner needs to also take into account the timers set to compute
 the actual watermarks.
 

map<string, int64> watermarks = 3;

Specified by:

getWatermarksOrThrow in interface BeamFnApi.Metrics.PTransformOrBuilder

clearWatermarks

public BeamFnApi.Metrics.PTransform.Builder clearWatermarks()

removeWatermarks

public BeamFnApi.Metrics.PTransform.Builder removeWatermarks(String key)

 (Optional): Map from local output name to its watermark.
 The watermarks reported are tentative, to get a better sense of progress
 while processing a bundle but before it is committed. At bundle commit
 time, a Runner needs to also take into account the timers set to compute
 the actual watermarks.
 

map<string, int64> watermarks = 3;

getMutableWatermarks

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

Deprecated.

Use alternate mutation accessors instead.

putWatermarks

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

 (Optional): Map from local output name to its watermark.
 The watermarks reported are tentative, to get a better sense of progress
 while processing a bundle but before it is committed. At bundle commit
 time, a Runner needs to also take into account the timers set to compute
 the actual watermarks.
 

map<string, int64> watermarks = 3;

putAllWatermarks

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

 (Optional): Map from local output name to its watermark.
 The watermarks reported are tentative, to get a better sense of progress
 while processing a bundle but before it is committed. At bundle commit
 time, a Runner needs to also take into account the timers set to compute
 the actual watermarks.
 

map<string, int64> watermarks = 3;

setUnknownFields

public final BeamFnApi.Metrics.PTransform.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.Builder>

mergeUnknownFields

public final BeamFnApi.Metrics.PTransform.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.Builder>