org.apache.beam.fn.v1

Interface BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

BeamFnApi.Metrics.PTransform.ActiveElements, BeamFnApi.Metrics.PTransform.ActiveElements.Builder

Enclosing class:

BeamFnApi.Metrics.PTransform

public static interface BeamFnApi.Metrics.PTransform.ActiveElementsOrBuilder
extends com.google.protobuf.MessageOrBuilder

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.
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.
boolean	hasMeasured() (Required)

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasMeasured

boolean hasMeasured()

 (Required)
 

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

getMeasured

BeamFnApi.Metrics.PTransform.Measured getMeasured()

 (Required)
 

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

getMeasuredOrBuilder

BeamFnApi.Metrics.PTransform.MeasuredOrBuilder getMeasuredOrBuilder()

 (Required)
 

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

getFractionRemaining

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;

getOutputElementsRemainingCount

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.
 If not reported, a Runner could extrapolate this from the processed
 elements.
 

map<string, int64> output_elements_remaining = 3;

containsOutputElementsRemaining

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;

getOutputElementsRemaining

@Deprecated
Map<String,Long> getOutputElementsRemaining()

Deprecated.

Use getOutputElementsRemainingMap() instead.

getOutputElementsRemainingMap

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;

getOutputElementsRemainingOrDefault

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;

getOutputElementsRemainingOrThrow

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;