public static final class RunnerApi.PTransform extends com.google.protobuf.GeneratedMessageV3 implements RunnerApi.PTransformOrBuilder
An applied PTransform! This does not contain the graph data, but only the fields specific to a graph node that is a Runner API transform between PCollections.Protobuf type
org.apache.beam.runner_api.v1.PTransform| Modifier and Type | Class and Description |
|---|---|
static class |
RunnerApi.PTransform.Builder
An applied PTransform! This does not contain the graph data, but only the
fields specific to a graph node that is a Runner API transform
between PCollections.
|
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| Modifier and Type | Field and Description |
|---|---|
static int |
DISPLAY_DATA_FIELD_NUMBER |
static int |
INPUTS_FIELD_NUMBER |
static int |
OUTPUTS_FIELD_NUMBER |
static int |
SPEC_FIELD_NUMBER |
static int |
SUBTRANSFORMS_FIELD_NUMBER |
static int |
UNIQUE_NAME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsInputs(String key)
(Required) A map from local names of inputs (unique only with this map, and
likely embedded in the transform payload and serialized user code) to
PCollection ids.
|
boolean |
containsOutputs(String key)
(Required) A map from local names of outputs (unique only within this map,
and likely embedded in the transform payload and serialized user code)
to PCollection ids.
|
boolean |
equals(Object obj) |
static RunnerApi.PTransform |
getDefaultInstance() |
RunnerApi.PTransform |
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.
|
Map<String,String> |
getInputs()
Deprecated.
|
int |
getInputsCount()
(Required) A map from local names of inputs (unique only with this map, and
likely embedded in the transform payload and serialized user code) to
PCollection ids.
|
Map<String,String> |
getInputsMap()
(Required) A map from local names of inputs (unique only with this map, and
likely embedded in the transform payload and serialized user code) to
PCollection ids.
|
String |
getInputsOrDefault(String key,
String defaultValue)
(Required) A map from local names of inputs (unique only with this map, and
likely embedded in the transform payload and serialized user code) to
PCollection ids.
|
String |
getInputsOrThrow(String key)
(Required) A map from local names of inputs (unique only with this map, and
likely embedded in the transform payload and serialized user code) to
PCollection ids.
|
Map<String,String> |
getOutputs()
Deprecated.
|
int |
getOutputsCount()
(Required) A map from local names of outputs (unique only within this map,
and likely embedded in the transform payload and serialized user code)
to PCollection ids.
|
Map<String,String> |
getOutputsMap()
(Required) A map from local names of outputs (unique only within this map,
and likely embedded in the transform payload and serialized user code)
to PCollection ids.
|
String |
getOutputsOrDefault(String key,
String defaultValue)
(Required) A map from local names of outputs (unique only within this map,
and likely embedded in the transform payload and serialized user code)
to PCollection ids.
|
String |
getOutputsOrThrow(String key)
(Required) A map from local names of outputs (unique only within this map,
and likely embedded in the transform payload and serialized user code)
to PCollection ids.
|
com.google.protobuf.Parser<RunnerApi.PTransform> |
getParserForType() |
int |
getSerializedSize() |
RunnerApi.FunctionSpec |
getSpec()
(Optional) A URN and payload that, together, fully defined the semantics
of this transform.
|
RunnerApi.FunctionSpecOrBuilder |
getSpecOrBuilder()
(Optional) A URN and payload that, together, fully defined the semantics
of this transform.
|
String |
getSubtransforms(int index)
(Optional) if this node is a composite, a list of the ids of
transforms that it contains.
|
com.google.protobuf.ByteString |
getSubtransformsBytes(int index)
(Optional) if this node is a composite, a list of the ids of
transforms that it contains.
|
int |
getSubtransformsCount()
(Optional) if this node is a composite, a list of the ids of
transforms that it contains.
|
com.google.protobuf.ProtocolStringList |
getSubtransformsList()
(Optional) if this node is a composite, a list of the ids of
transforms that it contains.
|
String |
getUniqueName()
(Required) A unique name for the application node.
|
com.google.protobuf.ByteString |
getUniqueNameBytes()
(Required) A unique name for the application node.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasDisplayData()
(Optional) Static display data for this PTransform application.
|
int |
hashCode() |
boolean |
hasSpec()
(Optional) A URN and payload that, together, fully defined the semantics
of this transform.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static RunnerApi.PTransform.Builder |
newBuilder() |
static RunnerApi.PTransform.Builder |
newBuilder(RunnerApi.PTransform prototype) |
RunnerApi.PTransform.Builder |
newBuilderForType() |
protected RunnerApi.PTransform.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static RunnerApi.PTransform |
parseDelimitedFrom(InputStream input) |
static RunnerApi.PTransform |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RunnerApi.PTransform |
parseFrom(byte[] data) |
static RunnerApi.PTransform |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RunnerApi.PTransform |
parseFrom(com.google.protobuf.ByteString data) |
static RunnerApi.PTransform |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RunnerApi.PTransform |
parseFrom(com.google.protobuf.CodedInputStream input) |
static RunnerApi.PTransform |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RunnerApi.PTransform |
parseFrom(InputStream input) |
static RunnerApi.PTransform |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<RunnerApi.PTransform> |
parser() |
RunnerApi.PTransform.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int UNIQUE_NAME_FIELD_NUMBER
public static final int SPEC_FIELD_NUMBER
public static final int SUBTRANSFORMS_FIELD_NUMBER
public static final int INPUTS_FIELD_NUMBER
public static final int OUTPUTS_FIELD_NUMBER
public static final int DISPLAY_DATA_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getUniqueName()
(Required) A unique name for the application node. 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 and be unique, even if it is autogenerated.
string unique_name = 5;getUniqueName in interface RunnerApi.PTransformOrBuilderpublic com.google.protobuf.ByteString getUniqueNameBytes()
(Required) A unique name for the application node. 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 and be unique, even if it is autogenerated.
string unique_name = 5;getUniqueNameBytes in interface RunnerApi.PTransformOrBuilderpublic boolean hasSpec()
(Optional) A URN and payload that, together, fully defined the semantics of this transform. If absent, this must be an "anonymous" composite transform. For primitive transform in the Runner API, this is required, and the payloads are well-defined messages. When the URN indicates ParDo it is a ParDoPayload, and so on. TODO: document the standardized URNs and payloads TODO: separate standardized payloads into a separate proto file For some special composite transforms, the payload is also officially defined: - when the URN is "urn:beam:transforms:combine" it is a CombinePayload
.org.apache.beam.runner_api.v1.FunctionSpec spec = 1;hasSpec in interface RunnerApi.PTransformOrBuilderpublic RunnerApi.FunctionSpec getSpec()
(Optional) A URN and payload that, together, fully defined the semantics of this transform. If absent, this must be an "anonymous" composite transform. For primitive transform in the Runner API, this is required, and the payloads are well-defined messages. When the URN indicates ParDo it is a ParDoPayload, and so on. TODO: document the standardized URNs and payloads TODO: separate standardized payloads into a separate proto file For some special composite transforms, the payload is also officially defined: - when the URN is "urn:beam:transforms:combine" it is a CombinePayload
.org.apache.beam.runner_api.v1.FunctionSpec spec = 1;getSpec in interface RunnerApi.PTransformOrBuilderpublic RunnerApi.FunctionSpecOrBuilder getSpecOrBuilder()
(Optional) A URN and payload that, together, fully defined the semantics of this transform. If absent, this must be an "anonymous" composite transform. For primitive transform in the Runner API, this is required, and the payloads are well-defined messages. When the URN indicates ParDo it is a ParDoPayload, and so on. TODO: document the standardized URNs and payloads TODO: separate standardized payloads into a separate proto file For some special composite transforms, the payload is also officially defined: - when the URN is "urn:beam:transforms:combine" it is a CombinePayload
.org.apache.beam.runner_api.v1.FunctionSpec spec = 1;getSpecOrBuilder in interface RunnerApi.PTransformOrBuilderpublic com.google.protobuf.ProtocolStringList getSubtransformsList()
(Optional) if this node is a composite, a list of the ids of transforms that it contains.
repeated string subtransforms = 2;getSubtransformsList in interface RunnerApi.PTransformOrBuilderpublic int getSubtransformsCount()
(Optional) if this node is a composite, a list of the ids of transforms that it contains.
repeated string subtransforms = 2;getSubtransformsCount in interface RunnerApi.PTransformOrBuilderpublic String getSubtransforms(int index)
(Optional) if this node is a composite, a list of the ids of transforms that it contains.
repeated string subtransforms = 2;getSubtransforms in interface RunnerApi.PTransformOrBuilderpublic com.google.protobuf.ByteString getSubtransformsBytes(int index)
(Optional) if this node is a composite, a list of the ids of transforms that it contains.
repeated string subtransforms = 2;getSubtransformsBytes in interface RunnerApi.PTransformOrBuilderpublic int getInputsCount()
RunnerApi.PTransformOrBuilder(Required) A map from local names of inputs (unique only with this map, and likely embedded in the transform payload and serialized user code) to PCollection ids. The payload for this transform may clarify the relationship of these inputs. For example: - for a Flatten transform they are merged - for a ParDo transform, some may be side inputs All inputs are recorded here so that the topological ordering of the graph is consistent whether or not the payload is understood.
map<string, string> inputs = 3;getInputsCount in interface RunnerApi.PTransformOrBuilderpublic boolean containsInputs(String key)
(Required) A map from local names of inputs (unique only with this map, and likely embedded in the transform payload and serialized user code) to PCollection ids. The payload for this transform may clarify the relationship of these inputs. For example: - for a Flatten transform they are merged - for a ParDo transform, some may be side inputs All inputs are recorded here so that the topological ordering of the graph is consistent whether or not the payload is understood.
map<string, string> inputs = 3;containsInputs in interface RunnerApi.PTransformOrBuilder@Deprecated public Map<String,String> getInputs()
getInputsMap() instead.getInputs in interface RunnerApi.PTransformOrBuilderpublic Map<String,String> getInputsMap()
(Required) A map from local names of inputs (unique only with this map, and likely embedded in the transform payload and serialized user code) to PCollection ids. The payload for this transform may clarify the relationship of these inputs. For example: - for a Flatten transform they are merged - for a ParDo transform, some may be side inputs All inputs are recorded here so that the topological ordering of the graph is consistent whether or not the payload is understood.
map<string, string> inputs = 3;getInputsMap in interface RunnerApi.PTransformOrBuilderpublic String getInputsOrDefault(String key, String defaultValue)
(Required) A map from local names of inputs (unique only with this map, and likely embedded in the transform payload and serialized user code) to PCollection ids. The payload for this transform may clarify the relationship of these inputs. For example: - for a Flatten transform they are merged - for a ParDo transform, some may be side inputs All inputs are recorded here so that the topological ordering of the graph is consistent whether or not the payload is understood.
map<string, string> inputs = 3;getInputsOrDefault in interface RunnerApi.PTransformOrBuilderpublic String getInputsOrThrow(String key)
(Required) A map from local names of inputs (unique only with this map, and likely embedded in the transform payload and serialized user code) to PCollection ids. The payload for this transform may clarify the relationship of these inputs. For example: - for a Flatten transform they are merged - for a ParDo transform, some may be side inputs All inputs are recorded here so that the topological ordering of the graph is consistent whether or not the payload is understood.
map<string, string> inputs = 3;getInputsOrThrow in interface RunnerApi.PTransformOrBuilderpublic int getOutputsCount()
RunnerApi.PTransformOrBuilder
(Required) A map from local names of outputs (unique only within this map,
and likely embedded in the transform payload and serialized user code)
to PCollection ids.
The URN or payload for this transform node may clarify the type and
relationship of these outputs. For example:
- for a ParDo transform, these are tags on PCollections, which will be
embedded in the DoFn.
map<string, string> outputs = 4;getOutputsCount in interface RunnerApi.PTransformOrBuilderpublic boolean containsOutputs(String key)
(Required) A map from local names of outputs (unique only within this map,
and likely embedded in the transform payload and serialized user code)
to PCollection ids.
The URN or payload for this transform node may clarify the type and
relationship of these outputs. For example:
- for a ParDo transform, these are tags on PCollections, which will be
embedded in the DoFn.
map<string, string> outputs = 4;containsOutputs in interface RunnerApi.PTransformOrBuilder@Deprecated public Map<String,String> getOutputs()
getOutputsMap() instead.getOutputs in interface RunnerApi.PTransformOrBuilderpublic Map<String,String> getOutputsMap()
(Required) A map from local names of outputs (unique only within this map,
and likely embedded in the transform payload and serialized user code)
to PCollection ids.
The URN or payload for this transform node may clarify the type and
relationship of these outputs. For example:
- for a ParDo transform, these are tags on PCollections, which will be
embedded in the DoFn.
map<string, string> outputs = 4;getOutputsMap in interface RunnerApi.PTransformOrBuilderpublic String getOutputsOrDefault(String key, String defaultValue)
(Required) A map from local names of outputs (unique only within this map,
and likely embedded in the transform payload and serialized user code)
to PCollection ids.
The URN or payload for this transform node may clarify the type and
relationship of these outputs. For example:
- for a ParDo transform, these are tags on PCollections, which will be
embedded in the DoFn.
map<string, string> outputs = 4;getOutputsOrDefault in interface RunnerApi.PTransformOrBuilderpublic String getOutputsOrThrow(String key)
(Required) A map from local names of outputs (unique only within this map,
and likely embedded in the transform payload and serialized user code)
to PCollection ids.
The URN or payload for this transform node may clarify the type and
relationship of these outputs. For example:
- for a ParDo transform, these are tags on PCollections, which will be
embedded in the DoFn.
map<string, string> outputs = 4;getOutputsOrThrow in interface RunnerApi.PTransformOrBuilderpublic 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 = 6;hasDisplayData in interface RunnerApi.PTransformOrBuilderpublic 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 = 6;getDisplayData in interface RunnerApi.PTransformOrBuilderpublic 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 = 6;getDisplayDataOrBuilder in interface RunnerApi.PTransformOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static RunnerApi.PTransform parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RunnerApi.PTransform parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RunnerApi.PTransform parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RunnerApi.PTransform parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RunnerApi.PTransform parseFrom(InputStream input) throws IOException
IOExceptionpublic static RunnerApi.PTransform parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RunnerApi.PTransform parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static RunnerApi.PTransform parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RunnerApi.PTransform parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static RunnerApi.PTransform parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic RunnerApi.PTransform.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static RunnerApi.PTransform.Builder newBuilder()
public static RunnerApi.PTransform.Builder newBuilder(RunnerApi.PTransform prototype)
public RunnerApi.PTransform.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected RunnerApi.PTransform.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static RunnerApi.PTransform getDefaultInstance()
public static com.google.protobuf.Parser<RunnerApi.PTransform> parser()
public com.google.protobuf.Parser<RunnerApi.PTransform> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public RunnerApi.PTransform getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2016–2017 The Apache Software Foundation. All rights reserved.