org.apache.beam.sdk.common.runner.v1

Class RunnerApi.PCollection

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.beam.sdk.common.runner.v1.RunnerApi.PCollection

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, RunnerApi.PCollectionOrBuilder

Enclosing class:

RunnerApi

public static final class RunnerApi.PCollection
extends com.google.protobuf.GeneratedMessageV3
implements RunnerApi.PCollectionOrBuilder

 A PCollection!
 

Protobuf type org.apache.beam.runner_api.v1.PCollection

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RunnerApi.PCollection.Builder A PCollection!

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	CODER_ID_FIELD_NUMBER
static int	DISPLAY_DATA_FIELD_NUMBER
static int	IS_BOUNDED_FIELD_NUMBER
static int	UNIQUE_NAME_FIELD_NUMBER
static int	WINDOWING_STRATEGY_ID_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)
String	getCoderId() (Required) The id of the Coder for this PCollection.
com.google.protobuf.ByteString	getCoderIdBytes() (Required) The id of the Coder for this PCollection.
static RunnerApi.PCollection	getDefaultInstance()
RunnerApi.PCollection	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
RunnerApi.DisplayData	getDisplayData() (Optional) Static display data for this PTransform application.
RunnerApi.DisplayDataOrBuilder	getDisplayDataOrBuilder() (Optional) Static display data for this PTransform application.
RunnerApi.IsBounded.Enum	getIsBounded() (Required) Whether this PCollection is bounded or unbounded
int	getIsBoundedValue() (Required) Whether this PCollection is bounded or unbounded
com.google.protobuf.Parser<RunnerApi.PCollection>	getParserForType()
int	getSerializedSize()
String	getUniqueName() (Required) A unique name for the PCollection.
com.google.protobuf.ByteString	getUniqueNameBytes() (Required) A unique name for the PCollection.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
String	getWindowingStrategyId() (Required) The id of the windowing strategy for this PCollection.
com.google.protobuf.ByteString	getWindowingStrategyIdBytes() (Required) The id of the windowing strategy for this PCollection.
boolean	hasDisplayData() (Optional) Static display data for this PTransform application.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RunnerApi.PCollection.Builder	newBuilder()
static RunnerApi.PCollection.Builder	newBuilder(RunnerApi.PCollection prototype)
RunnerApi.PCollection.Builder	newBuilderForType()
protected RunnerApi.PCollection.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static RunnerApi.PCollection	parseDelimitedFrom(InputStream input)
static RunnerApi.PCollection	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.PCollection	parseFrom(byte[] data)
static RunnerApi.PCollection	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.PCollection	parseFrom(com.google.protobuf.ByteString data)
static RunnerApi.PCollection	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.PCollection	parseFrom(com.google.protobuf.CodedInputStream input)
static RunnerApi.PCollection	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.PCollection	parseFrom(InputStream input)
static RunnerApi.PCollection	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RunnerApi.PCollection>	parser()
RunnerApi.PCollection.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

UNIQUE_NAME_FIELD_NUMBER

public static final int UNIQUE_NAME_FIELD_NUMBER

See Also:

Constant Field Values

CODER_ID_FIELD_NUMBER

public static final int CODER_ID_FIELD_NUMBER

See Also:

Constant Field Values

IS_BOUNDED_FIELD_NUMBER

public static final int IS_BOUNDED_FIELD_NUMBER

See Also:

Constant Field Values

WINDOWING_STRATEGY_ID_FIELD_NUMBER

public static final int WINDOWING_STRATEGY_ID_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_DATA_FIELD_NUMBER

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

getUniqueName

public String getUniqueName()

 (Required) A unique name for the PCollection.
 Ideally, this should be stable over multiple evolutions of a pipeline
 for the purposes of logging and associating pipeline state with a node,
 etc.
 If it is not stable, then the runner decides what will happen. But, most
 importantly, it must always be here, even if it is autogenerated.
 

string unique_name = 1;

Specified by:

getUniqueName in interface RunnerApi.PCollectionOrBuilder

getUniqueNameBytes

public com.google.protobuf.ByteString getUniqueNameBytes()

 (Required) A unique name for the PCollection.
 Ideally, this should be stable over multiple evolutions of a pipeline
 for the purposes of logging and associating pipeline state with a node,
 etc.
 If it is not stable, then the runner decides what will happen. But, most
 importantly, it must always be here, even if it is autogenerated.
 

string unique_name = 1;

Specified by:

getUniqueNameBytes in interface RunnerApi.PCollectionOrBuilder

getCoderId

public String getCoderId()

 (Required) The id of the Coder for this PCollection.
 

string coder_id = 2;

Specified by:

getCoderId in interface RunnerApi.PCollectionOrBuilder

getCoderIdBytes

public com.google.protobuf.ByteString getCoderIdBytes()

 (Required) The id of the Coder for this PCollection.
 

string coder_id = 2;

Specified by:

getCoderIdBytes in interface RunnerApi.PCollectionOrBuilder

getIsBoundedValue

public int getIsBoundedValue()

 (Required) Whether this PCollection is bounded or unbounded
 

.org.apache.beam.runner_api.v1.IsBounded.Enum is_bounded = 3;

Specified by:

getIsBoundedValue in interface RunnerApi.PCollectionOrBuilder

getIsBounded

public RunnerApi.IsBounded.Enum getIsBounded()

 (Required) Whether this PCollection is bounded or unbounded
 

.org.apache.beam.runner_api.v1.IsBounded.Enum is_bounded = 3;

Specified by:

getIsBounded in interface RunnerApi.PCollectionOrBuilder

getWindowingStrategyId

public String getWindowingStrategyId()

 (Required) The id of the windowing strategy for this PCollection.
 

string windowing_strategy_id = 4;

Specified by:

getWindowingStrategyId in interface RunnerApi.PCollectionOrBuilder

getWindowingStrategyIdBytes

public com.google.protobuf.ByteString getWindowingStrategyIdBytes()

 (Required) The id of the windowing strategy for this PCollection.
 

string windowing_strategy_id = 4;

Specified by:

getWindowingStrategyIdBytes in interface RunnerApi.PCollectionOrBuilder

hasDisplayData

public boolean hasDisplayData()

 (Optional) Static display data for this PTransform application. If
 there is none, or it is not relevant (such as use by the Fn API)
 then it may be omitted.
 

.org.apache.beam.runner_api.v1.DisplayData display_data = 5;

Specified by:

hasDisplayData in interface RunnerApi.PCollectionOrBuilder

getDisplayData

public RunnerApi.DisplayData getDisplayData()

 (Optional) Static display data for this PTransform application. If
 there is none, or it is not relevant (such as use by the Fn API)
 then it may be omitted.
 

.org.apache.beam.runner_api.v1.DisplayData display_data = 5;

Specified by:

getDisplayData in interface RunnerApi.PCollectionOrBuilder

getDisplayDataOrBuilder

public RunnerApi.DisplayDataOrBuilder getDisplayDataOrBuilder()

 (Optional) Static display data for this PTransform application. If
 there is none, or it is not relevant (such as use by the Fn API)
 then it may be omitted.
 

.org.apache.beam.runner_api.v1.DisplayData display_data = 5;

Specified by:

getDisplayDataOrBuilder in interface RunnerApi.PCollectionOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunnerApi.PCollection parseFrom(com.google.protobuf.ByteString data,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunnerApi.PCollection parseFrom(byte[] data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static RunnerApi.PCollection parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static RunnerApi.PCollection parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static RunnerApi.PCollection parseFrom(com.google.protobuf.CodedInputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RunnerApi.PCollection.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RunnerApi.PCollection.Builder newBuilder()

newBuilder

public static RunnerApi.PCollection.Builder newBuilder(RunnerApi.PCollection prototype)

toBuilder

public RunnerApi.PCollection.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected RunnerApi.PCollection.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RunnerApi.PCollection getDefaultInstance()

parser

public static com.google.protobuf.Parser<RunnerApi.PCollection> parser()

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder