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

Interface RunnerApi.PTransformOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

RunnerApi.PTransform, RunnerApi.PTransform.Builder

Enclosing class:

RunnerApi

public static interface RunnerApi.PTransformOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

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.
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.
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.
List<String>	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.
boolean	hasDisplayData() (Optional) Static display data for this PTransform application.
boolean	hasSpec() (Optional) A URN and payload that, together, fully defined the semantics of this transform.

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

getUniqueName

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;

getUniqueNameBytes

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;

hasSpec

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;

getSpec

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;

getSpecOrBuilder

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;

getSubtransformsList

List<String> getSubtransformsList()

 (Optional) if this node is a composite, a list of the ids of
 transforms that it contains.
 

repeated string subtransforms = 2;

getSubtransformsCount

int getSubtransformsCount()

 (Optional) if this node is a composite, a list of the ids of
 transforms that it contains.
 

repeated string subtransforms = 2;

getSubtransforms

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;

getSubtransformsBytes

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;

getInputsCount

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.
 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

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;

getInputs

@Deprecated
Map<String,String> getInputs()

Deprecated.

Use getInputsMap() instead.

getInputsMap

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;

getInputsOrDefault

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;

getInputsOrThrow

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;

getOutputsCount

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.
 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

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;

getOutputs

@Deprecated
Map<String,String> getOutputs()

Deprecated.

Use getOutputsMap() instead.

getOutputsMap

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;

getOutputsOrDefault

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;

getOutputsOrThrow

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;

hasDisplayData

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;

getDisplayData

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;

getDisplayDataOrBuilder

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;