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

Class RunnerApi.FunctionSpec.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.FunctionSpec.Builder>

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

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, RunnerApi.FunctionSpecOrBuilder

Enclosing class:

RunnerApi.FunctionSpec

public static final class RunnerApi.FunctionSpec.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.FunctionSpec.Builder>
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

Method Summary

Modifier and Type	Method and Description
RunnerApi.FunctionSpec.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RunnerApi.FunctionSpec	build()
RunnerApi.FunctionSpec	buildPartial()
RunnerApi.FunctionSpec.Builder	clear()
RunnerApi.FunctionSpec.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
RunnerApi.FunctionSpec.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
RunnerApi.FunctionSpec.Builder	clearPayload() (Optional) The data specifying any parameters to the URN.
RunnerApi.FunctionSpec.Builder	clearUrn() (Required) A URN that describes the accompanying payload.
RunnerApi.FunctionSpec.Builder	clone()
RunnerApi.FunctionSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
com.google.protobuf.ByteString	getPayload() (Optional) The data specifying any parameters to the URN.
String	getUrn() (Required) A URN that describes the accompanying payload.
com.google.protobuf.ByteString	getUrnBytes() (Required) A URN that describes the accompanying payload.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
RunnerApi.FunctionSpec.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
RunnerApi.FunctionSpec.Builder	mergeFrom(com.google.protobuf.Message other)
RunnerApi.FunctionSpec.Builder	mergeFrom(RunnerApi.FunctionSpec other)
RunnerApi.FunctionSpec.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RunnerApi.FunctionSpec.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
RunnerApi.FunctionSpec.Builder	setPayload(com.google.protobuf.ByteString value) (Optional) The data specifying any parameters to the URN.
RunnerApi.FunctionSpec.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
RunnerApi.FunctionSpec.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
RunnerApi.FunctionSpec.Builder	setUrn(String value) (Required) A URN that describes the accompanying payload.
RunnerApi.FunctionSpec.Builder	setUrnBytes(com.google.protobuf.ByteString value) (Required) A URN that describes the accompanying payload.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, parseUnknownField

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<RunnerApi.FunctionSpec.Builder>

clear

public RunnerApi.FunctionSpec.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.FunctionSpec.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.FunctionSpec.Builder>

getDefaultInstanceForType

public RunnerApi.FunctionSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public RunnerApi.FunctionSpec build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public RunnerApi.FunctionSpec buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public RunnerApi.FunctionSpec.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.FunctionSpec.Builder>

setField

public RunnerApi.FunctionSpec.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                               Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.FunctionSpec.Builder>

clearField

public RunnerApi.FunctionSpec.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.FunctionSpec.Builder>

clearOneof

public RunnerApi.FunctionSpec.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.FunctionSpec.Builder>

setRepeatedField

public RunnerApi.FunctionSpec.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       int index,
                                                       Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.FunctionSpec.Builder>

addRepeatedField

public RunnerApi.FunctionSpec.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.FunctionSpec.Builder>

mergeFrom

public RunnerApi.FunctionSpec.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunnerApi.FunctionSpec.Builder>

mergeFrom

public RunnerApi.FunctionSpec.Builder mergeFrom(RunnerApi.FunctionSpec other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.FunctionSpec.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RunnerApi.FunctionSpec.Builder>

Throws:

IOException

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

setUrn

public RunnerApi.FunctionSpec.Builder setUrn(String value)

 (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;

clearUrn

public RunnerApi.FunctionSpec.Builder clearUrn()

 (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;

setUrnBytes

public RunnerApi.FunctionSpec.Builder setUrnBytes(com.google.protobuf.ByteString value)

 (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;

getPayload

public com.google.protobuf.ByteString getPayload()

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

bytes payload = 3;

Specified by:

getPayload in interface RunnerApi.FunctionSpecOrBuilder

setPayload

public RunnerApi.FunctionSpec.Builder setPayload(com.google.protobuf.ByteString value)

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

bytes payload = 3;

clearPayload

public RunnerApi.FunctionSpec.Builder clearPayload()

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

bytes payload = 3;

setUnknownFields

public final RunnerApi.FunctionSpec.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.FunctionSpec.Builder>

mergeUnknownFields

public final RunnerApi.FunctionSpec.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RunnerApi.FunctionSpec.Builder>