org.apache.beam.fn.v1

Class BeamFnApi.Metrics.PTransform

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, BeamFnApi.Metrics.PTransformOrBuilder

Enclosing class:

BeamFnApi.Metrics

public static final class BeamFnApi.Metrics.PTransform
extends com.google.protobuf.GeneratedMessageV3
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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BeamFnApi.Metrics.PTransform.ActiveElements Metrics for active elements.
static interface	BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder
static class	BeamFnApi.Metrics.PTransform.Builder PTransform level metrics.
static class	BeamFnApi.Metrics.PTransform.Measured Metrics that are measured for processed and active element groups.
static interface	BeamFnApi.Metrics.PTransform.MeasuredOrBuilder
static class	BeamFnApi.Metrics.PTransform.ProcessedElements Metrics for fully processed elements.
static interface	BeamFnApi.Metrics.PTransform.ProcessedElementsOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACTIVE_ELEMENTS_FIELD_NUMBER
static int	PROCESSED_ELEMENTS_FIELD_NUMBER
static int	WATERMARKS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsWatermarks(String key) (Optional): Map from local output name to its watermark.
boolean	equals(Object obj)
BeamFnApi.Metrics.PTransform.ActiveElements	getActiveElements() (Required): Metrics for active elements.
BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder	getActiveElementsOrBuilder() (Required): Metrics for active elements.
static BeamFnApi.Metrics.PTransform	getDefaultInstance()
BeamFnApi.Metrics.PTransform	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<BeamFnApi.Metrics.PTransform>	getParserForType()
BeamFnApi.Metrics.PTransform.ProcessedElements	getProcessedElements() (Required): Metrics for processed elements.
BeamFnApi.Metrics.PTransform.ProcessedElementsOrBuilder	getProcessedElementsOrBuilder() (Required): Metrics for processed elements.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
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.
int	hashCode()
boolean	hasProcessedElements() (Required): Metrics for processed elements.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static BeamFnApi.Metrics.PTransform.Builder	newBuilder()
static BeamFnApi.Metrics.PTransform.Builder	newBuilder(BeamFnApi.Metrics.PTransform prototype)
BeamFnApi.Metrics.PTransform.Builder	newBuilderForType()
protected BeamFnApi.Metrics.PTransform.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static BeamFnApi.Metrics.PTransform	parseDelimitedFrom(InputStream input)
static BeamFnApi.Metrics.PTransform	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.Metrics.PTransform	parseFrom(byte[] data)
static BeamFnApi.Metrics.PTransform	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.Metrics.PTransform	parseFrom(com.google.protobuf.ByteString data)
static BeamFnApi.Metrics.PTransform	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.Metrics.PTransform	parseFrom(com.google.protobuf.CodedInputStream input)
static BeamFnApi.Metrics.PTransform	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.Metrics.PTransform	parseFrom(InputStream input)
static BeamFnApi.Metrics.PTransform	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BeamFnApi.Metrics.PTransform>	parser()
BeamFnApi.Metrics.PTransform.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PROCESSED_ELEMENTS_FIELD_NUMBER

public static final int PROCESSED_ELEMENTS_FIELD_NUMBER

See Also:

Constant Field Values

ACTIVE_ELEMENTS_FIELD_NUMBER

public static final int ACTIVE_ELEMENTS_FIELD_NUMBER

See Also:

Constant Field Values

WATERMARKS_FIELD_NUMBER

public static final int WATERMARKS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

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

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static BeamFnApi.Metrics.PTransform parseFrom(com.google.protobuf.ByteString data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BeamFnApi.Metrics.PTransform parseFrom(com.google.protobuf.ByteString data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BeamFnApi.Metrics.PTransform parseFrom(byte[] data)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BeamFnApi.Metrics.PTransform parseFrom(byte[] data,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BeamFnApi.Metrics.PTransform parseFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

public static BeamFnApi.Metrics.PTransform parseFrom(InputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static BeamFnApi.Metrics.PTransform parseDelimitedFrom(InputStream input)
                                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static BeamFnApi.Metrics.PTransform parseDelimitedFrom(InputStream input,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws IOException

Throws:

IOException

parseFrom

public static BeamFnApi.Metrics.PTransform parseFrom(com.google.protobuf.CodedInputStream input)
                                              throws IOException

Throws:

IOException

parseFrom

public static BeamFnApi.Metrics.PTransform parseFrom(com.google.protobuf.CodedInputStream input,
                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                              throws IOException

Throws:

IOException

newBuilderForType

public BeamFnApi.Metrics.PTransform.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BeamFnApi.Metrics.PTransform.Builder newBuilder()

newBuilder

public static BeamFnApi.Metrics.PTransform.Builder newBuilder(BeamFnApi.Metrics.PTransform prototype)

toBuilder

public BeamFnApi.Metrics.PTransform.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected BeamFnApi.Metrics.PTransform.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BeamFnApi.Metrics.PTransform getDefaultInstance()

parser

public static com.google.protobuf.Parser<BeamFnApi.Metrics.PTransform> parser()

getParserForType

public com.google.protobuf.Parser<BeamFnApi.Metrics.PTransform> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public BeamFnApi.Metrics.PTransform getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder