org.apache.beam.fn.v1

Class BeamFnApi.PrimitiveTransformSplit

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.beam.fn.v1.BeamFnApi.PrimitiveTransformSplit

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, BeamFnApi.PrimitiveTransformSplitOrBuilder

Enclosing class:

BeamFnApi

public static final class BeamFnApi.PrimitiveTransformSplit
extends com.google.protobuf.GeneratedMessageV3
implements BeamFnApi.PrimitiveTransformSplitOrBuilder

 Each primitive transform that is splittable is defined by a restriction
 it is currently processing. During splitting, that currently active
 restriction (R_initial) is split into 2 components:
   * a restriction (R_done) representing all elements that will be fully
     processed
   * a restriction (R_todo) representing all elements that will not be fully
     processed
 where:
   R_initial = R_done ⋃ R_todo
 

Protobuf type org.apache.beam.fn.v1.PrimitiveTransformSplit

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BeamFnApi.PrimitiveTransformSplit.Builder Each primitive transform that is splittable is defined by a restriction it is currently processing.

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	COMPLETED_RESTRICTION_FIELD_NUMBER
static int	PRIMITIVE_TRANSFORM_REFERENCE_FIELD_NUMBER
static int	REMAINING_RESTRICTION_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	equals(Object obj)
RunnerApi.FunctionSpec	getCompletedRestriction() (Required) A function specification describing the restriction that has been completed by the primitive transform.
RunnerApi.FunctionSpecOrBuilder	getCompletedRestrictionOrBuilder() (Required) A function specification describing the restriction that has been completed by the primitive transform.
static BeamFnApi.PrimitiveTransformSplit	getDefaultInstance()
BeamFnApi.PrimitiveTransformSplit	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<BeamFnApi.PrimitiveTransformSplit>	getParserForType()
String	getPrimitiveTransformReference() (Required) A reference to a primitive transform with the given id that is part of the active process bundle request with the given instruction id.
com.google.protobuf.ByteString	getPrimitiveTransformReferenceBytes() (Required) A reference to a primitive transform with the given id that is part of the active process bundle request with the given instruction id.
RunnerApi.FunctionSpec	getRemainingRestriction() (Required) A function specification describing the restriction representing the remainder of work for the primitive transform.
RunnerApi.FunctionSpecOrBuilder	getRemainingRestrictionOrBuilder() (Required) A function specification describing the restriction representing the remainder of work for the primitive transform.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCompletedRestriction() (Required) A function specification describing the restriction that has been completed by the primitive transform.
int	hashCode()
boolean	hasRemainingRestriction() (Required) A function specification describing the restriction representing the remainder of work for the primitive transform.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static BeamFnApi.PrimitiveTransformSplit.Builder	newBuilder()
static BeamFnApi.PrimitiveTransformSplit.Builder	newBuilder(BeamFnApi.PrimitiveTransformSplit prototype)
BeamFnApi.PrimitiveTransformSplit.Builder	newBuilderForType()
protected BeamFnApi.PrimitiveTransformSplit.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static BeamFnApi.PrimitiveTransformSplit	parseDelimitedFrom(InputStream input)
static BeamFnApi.PrimitiveTransformSplit	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.PrimitiveTransformSplit	parseFrom(byte[] data)
static BeamFnApi.PrimitiveTransformSplit	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.PrimitiveTransformSplit	parseFrom(com.google.protobuf.ByteString data)
static BeamFnApi.PrimitiveTransformSplit	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.PrimitiveTransformSplit	parseFrom(com.google.protobuf.CodedInputStream input)
static BeamFnApi.PrimitiveTransformSplit	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static BeamFnApi.PrimitiveTransformSplit	parseFrom(InputStream input)
static BeamFnApi.PrimitiveTransformSplit	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<BeamFnApi.PrimitiveTransformSplit>	parser()
BeamFnApi.PrimitiveTransformSplit.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, internalGetMapField, 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

PRIMITIVE_TRANSFORM_REFERENCE_FIELD_NUMBER

public static final int PRIMITIVE_TRANSFORM_REFERENCE_FIELD_NUMBER

See Also:

Constant Field Values

COMPLETED_RESTRICTION_FIELD_NUMBER

public static final int COMPLETED_RESTRICTION_FIELD_NUMBER

See Also:

Constant Field Values

REMAINING_RESTRICTION_FIELD_NUMBER

public static final int REMAINING_RESTRICTION_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()

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getPrimitiveTransformReference

public String getPrimitiveTransformReference()

 (Required) A reference to a primitive transform with the given id that
 is part of the active process bundle request with the given instruction
 id.
 

string primitive_transform_reference = 1;

Specified by:

getPrimitiveTransformReference in interface BeamFnApi.PrimitiveTransformSplitOrBuilder

getPrimitiveTransformReferenceBytes

public com.google.protobuf.ByteString getPrimitiveTransformReferenceBytes()

 (Required) A reference to a primitive transform with the given id that
 is part of the active process bundle request with the given instruction
 id.
 

string primitive_transform_reference = 1;

Specified by:

getPrimitiveTransformReferenceBytes in interface BeamFnApi.PrimitiveTransformSplitOrBuilder

hasCompletedRestriction

public boolean hasCompletedRestriction()

 (Required) A function specification describing the restriction
 that has been completed by the primitive transform.
 For example, a remote GRPC source will have a specific urn and data
 block containing an ElementCountRestriction.
 

.org.apache.beam.runner_api.v1.FunctionSpec completed_restriction = 2;

Specified by:

hasCompletedRestriction in interface BeamFnApi.PrimitiveTransformSplitOrBuilder

getCompletedRestriction

public RunnerApi.FunctionSpec getCompletedRestriction()

 (Required) A function specification describing the restriction
 that has been completed by the primitive transform.
 For example, a remote GRPC source will have a specific urn and data
 block containing an ElementCountRestriction.
 

.org.apache.beam.runner_api.v1.FunctionSpec completed_restriction = 2;

Specified by:

getCompletedRestriction in interface BeamFnApi.PrimitiveTransformSplitOrBuilder

getCompletedRestrictionOrBuilder

public RunnerApi.FunctionSpecOrBuilder getCompletedRestrictionOrBuilder()

 (Required) A function specification describing the restriction
 that has been completed by the primitive transform.
 For example, a remote GRPC source will have a specific urn and data
 block containing an ElementCountRestriction.
 

.org.apache.beam.runner_api.v1.FunctionSpec completed_restriction = 2;

Specified by:

getCompletedRestrictionOrBuilder in interface BeamFnApi.PrimitiveTransformSplitOrBuilder

hasRemainingRestriction

public boolean hasRemainingRestriction()

 (Required) A function specification describing the restriction
 representing the remainder of work for the primitive transform.
 FOr example, a remote GRPC source will have a specific urn and data
 block contain an ElemntCountSkipRestriction.
 

.org.apache.beam.runner_api.v1.FunctionSpec remaining_restriction = 3;

Specified by:

hasRemainingRestriction in interface BeamFnApi.PrimitiveTransformSplitOrBuilder

getRemainingRestriction

public RunnerApi.FunctionSpec getRemainingRestriction()

 (Required) A function specification describing the restriction
 representing the remainder of work for the primitive transform.
 FOr example, a remote GRPC source will have a specific urn and data
 block contain an ElemntCountSkipRestriction.
 

.org.apache.beam.runner_api.v1.FunctionSpec remaining_restriction = 3;

Specified by:

getRemainingRestriction in interface BeamFnApi.PrimitiveTransformSplitOrBuilder

getRemainingRestrictionOrBuilder

public RunnerApi.FunctionSpecOrBuilder getRemainingRestrictionOrBuilder()

 (Required) A function specification describing the restriction
 representing the remainder of work for the primitive transform.
 FOr example, a remote GRPC source will have a specific urn and data
 block contain an ElemntCountSkipRestriction.
 

.org.apache.beam.runner_api.v1.FunctionSpec remaining_restriction = 3;

Specified by:

getRemainingRestrictionOrBuilder in interface BeamFnApi.PrimitiveTransformSplitOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static BeamFnApi.PrimitiveTransformSplit parseFrom(InputStream input)
                                                   throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static BeamFnApi.PrimitiveTransformSplit parseDelimitedFrom(InputStream input)
                                                            throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public BeamFnApi.PrimitiveTransformSplit.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static BeamFnApi.PrimitiveTransformSplit.Builder newBuilder()

newBuilder

public static BeamFnApi.PrimitiveTransformSplit.Builder newBuilder(BeamFnApi.PrimitiveTransformSplit prototype)

toBuilder

public BeamFnApi.PrimitiveTransformSplit.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static BeamFnApi.PrimitiveTransformSplit getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder