org.apache.beam.fn.v1

Class BeamFnApi.Metrics.PTransform.ActiveElements

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

BeamFnApi.Metrics.PTransform

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BeamFnApi.Metrics.PTransform.ActiveElements.Builder Metrics for active elements.

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	FRACTION_REMAINING_FIELD_NUMBER
static int	MEASURED_FIELD_NUMBER
static int	OUTPUT_ELEMENTS_REMAINING_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	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.
boolean	equals(Object obj)
static BeamFnApi.Metrics.PTransform.ActiveElements	getDefaultInstance()
BeamFnApi.Metrics.PTransform.ActiveElements	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.MeasuredOrBuilder	getMeasuredOrBuilder() (Required)
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.
com.google.protobuf.Parser<BeamFnApi.Metrics.PTransform.ActiveElements>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasMeasured() (Required)
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static BeamFnApi.Metrics.PTransform.ActiveElements.Builder	newBuilder()
static BeamFnApi.Metrics.PTransform.ActiveElements.Builder	newBuilder(BeamFnApi.Metrics.PTransform.ActiveElements prototype)
BeamFnApi.Metrics.PTransform.ActiveElements.Builder	newBuilderForType()
protected BeamFnApi.Metrics.PTransform.ActiveElements.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static BeamFnApi.Metrics.PTransform.ActiveElements	parseDelimitedFrom(InputStream input)
static BeamFnApi.Metrics.PTransform.ActiveElements	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.Metrics.PTransform.ActiveElements	parseFrom(byte[] data)
static BeamFnApi.Metrics.PTransform.ActiveElements	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.Metrics.PTransform.ActiveElements	parseFrom(com.google.protobuf.ByteString data)
static BeamFnApi.Metrics.PTransform.ActiveElements	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.Metrics.PTransform.ActiveElements	parseFrom(com.google.protobuf.CodedInputStream input)
static BeamFnApi.Metrics.PTransform.ActiveElements	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.Metrics.PTransform.ActiveElements	parseFrom(InputStream input)
static BeamFnApi.Metrics.PTransform.ActiveElements	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BeamFnApi.Metrics.PTransform.ActiveElements>	parser()
BeamFnApi.Metrics.PTransform.ActiveElements.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

MEASURED_FIELD_NUMBER

public static final int MEASURED_FIELD_NUMBER

See Also:

Constant Field Values

FRACTION_REMAINING_FIELD_NUMBER

public static final int FRACTION_REMAINING_FIELD_NUMBER

See Also:

Constant Field Values

OUTPUT_ELEMENTS_REMAINING_FIELD_NUMBER

public static final int OUTPUT_ELEMENTS_REMAINING_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

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

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

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

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.ActiveElements parseFrom(com.google.protobuf.ByteString data)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BeamFnApi.Metrics.PTransform.ActiveElements 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.ActiveElements parseFrom(byte[] data)
                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public BeamFnApi.Metrics.PTransform.ActiveElements.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.ActiveElements.Builder newBuilder()

newBuilder

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

toBuilder

public BeamFnApi.Metrics.PTransform.ActiveElements.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.ActiveElements.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BeamFnApi.Metrics.PTransform.ActiveElements getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<BeamFnApi.Metrics.PTransform.ActiveElements> 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.ActiveElements getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder