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

Class RunnerApi.FunctionSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

RunnerApi

public static final class RunnerApi.FunctionSpec
extends com.google.protobuf.GeneratedMessageV3
implements RunnerApi.FunctionSpecOrBuilder

 A URN along with a parameter object whose schema is determined by the
 URN.
 This structure is reused in two distinct, but compatible, ways:
 1. This can be a specification of the function over PCollections
    that a PTransform computes.
 2. This can be a specification of a user-defined function, possibly
    SDK-specific. (external to this message must be adequate context
    to indicate the environment in which the UDF can be understood).
 Though not explicit in this proto, there are two possibilities
 for the relationship of a runner to this specification that
 one should bear in mind:
 1. The runner understands the URN. For example, it might be
    a well-known URN like "urn:beam:transform:Top" or
    "urn:beam:windowfn:FixedWindows" with
    an agreed-upon payload (e.g. a number or duration,
    respectively).
 2. The runner does not understand the URN. It might be an
    SDK specific URN such as "urn:beam:dofn:javasdk:1.0"
    that indicates to the SDK what the payload is,
    such as a serialized Java DoFn from a particular
    version of the Beam Java SDK. The payload will often
    then be an opaque message such as bytes in a
    language-specific serialization format.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RunnerApi.FunctionSpec.Builder A URN along with a parameter object whose schema is determined by the URN.

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	PARAMETER_FIELD_NUMBER
static int	URN_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)
static RunnerApi.FunctionSpec	getDefaultInstance()
RunnerApi.FunctionSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Any	getParameter() (Optional) The data specifying any parameters to the URN.
com.google.protobuf.AnyOrBuilder	getParameterOrBuilder() (Optional) The data specifying any parameters to the URN.
com.google.protobuf.Parser<RunnerApi.FunctionSpec>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
String	getUrn() (Required) A URN that describes the accompanying payload.
com.google.protobuf.ByteString	getUrnBytes() (Required) A URN that describes the accompanying payload.
int	hashCode()
boolean	hasParameter() (Optional) The data specifying any parameters to the URN.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static RunnerApi.FunctionSpec.Builder	newBuilder()
static RunnerApi.FunctionSpec.Builder	newBuilder(RunnerApi.FunctionSpec prototype)
RunnerApi.FunctionSpec.Builder	newBuilderForType()
protected RunnerApi.FunctionSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static RunnerApi.FunctionSpec	parseDelimitedFrom(InputStream input)
static RunnerApi.FunctionSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.FunctionSpec	parseFrom(byte[] data)
static RunnerApi.FunctionSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.FunctionSpec	parseFrom(com.google.protobuf.ByteString data)
static RunnerApi.FunctionSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.FunctionSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static RunnerApi.FunctionSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RunnerApi.FunctionSpec	parseFrom(InputStream input)
static RunnerApi.FunctionSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<RunnerApi.FunctionSpec>	parser()
RunnerApi.FunctionSpec.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

URN_FIELD_NUMBER

public static final int URN_FIELD_NUMBER

See Also:

Constant Field Values

PARAMETER_FIELD_NUMBER

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

getUrn

public String getUrn()

 (Required) A URN that describes the accompanying payload.
 For any URN that is not recognized (by whomever is inspecting
 it) the parameter payload should be treated as opaque and
 passed as-is.
 

string urn = 1;

Specified by:

getUrn in interface RunnerApi.FunctionSpecOrBuilder

getUrnBytes

public com.google.protobuf.ByteString getUrnBytes()

 (Required) A URN that describes the accompanying payload.
 For any URN that is not recognized (by whomever is inspecting
 it) the parameter payload should be treated as opaque and
 passed as-is.
 

string urn = 1;

Specified by:

getUrnBytes in interface RunnerApi.FunctionSpecOrBuilder

hasParameter

public boolean hasParameter()

 (Optional) The data specifying any parameters to the URN. If
 the URN does not require any arguments, this may be omitted.
 

.google.protobuf.Any parameter = 2;

Specified by:

hasParameter in interface RunnerApi.FunctionSpecOrBuilder

getParameter

public com.google.protobuf.Any getParameter()

 (Optional) The data specifying any parameters to the URN. If
 the URN does not require any arguments, this may be omitted.
 

.google.protobuf.Any parameter = 2;

Specified by:

getParameter in interface RunnerApi.FunctionSpecOrBuilder

getParameterOrBuilder

public com.google.protobuf.AnyOrBuilder getParameterOrBuilder()

 (Optional) The data specifying any parameters to the URN. If
 the URN does not require any arguments, this may be omitted.
 

.google.protobuf.Any parameter = 2;

Specified by:

getParameterOrBuilder in interface RunnerApi.FunctionSpecOrBuilder

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public RunnerApi.FunctionSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static RunnerApi.FunctionSpec.Builder newBuilder()

newBuilder

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

toBuilder

public RunnerApi.FunctionSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static RunnerApi.FunctionSpec getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder