org.apache.arrow.flight.sql.impl

Class FlightSql.SubstraitPlan.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.SubstraitPlan.Builder>

org.apache.arrow.flight.sql.impl.FlightSql.SubstraitPlan.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, FlightSql.SubstraitPlanOrBuilder

Enclosing class:

FlightSql.SubstraitPlan

public static final class FlightSql.SubstraitPlan.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.SubstraitPlan.Builder>
implements FlightSql.SubstraitPlanOrBuilder

 An embedded message describing a Substrait plan to execute.
 

Protobuf type arrow.flight.protocol.sql.SubstraitPlan

Method Summary

Modifier and Type	Method and Description
FlightSql.SubstraitPlan	build()
FlightSql.SubstraitPlan	buildPartial()
FlightSql.SubstraitPlan.Builder	clear()
FlightSql.SubstraitPlan.Builder	clearPlan() The serialized substrait.Plan to create a prepared statement for.
FlightSql.SubstraitPlan.Builder	clearVersion() The Substrait release, e.g.
FlightSql.SubstraitPlan	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
com.google.protobuf.ByteString	getPlan() The serialized substrait.Plan to create a prepared statement for.
String	getVersion() The Substrait release, e.g.
com.google.protobuf.ByteString	getVersionBytes() The Substrait release, e.g.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
FlightSql.SubstraitPlan.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
FlightSql.SubstraitPlan.Builder	mergeFrom(FlightSql.SubstraitPlan other)
FlightSql.SubstraitPlan.Builder	mergeFrom(com.google.protobuf.Message other)
FlightSql.SubstraitPlan.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
FlightSql.SubstraitPlan.Builder	setPlan(com.google.protobuf.ByteString value) The serialized substrait.Plan to create a prepared statement for.
FlightSql.SubstraitPlan.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
FlightSql.SubstraitPlan.Builder	setVersion(String value) The Substrait release, e.g.
FlightSql.SubstraitPlan.Builder	setVersionBytes(com.google.protobuf.ByteString value) The Substrait release, e.g.

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

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

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

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

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

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, 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.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

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<FlightSql.SubstraitPlan.Builder>

clear

public FlightSql.SubstraitPlan.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<FlightSql.SubstraitPlan.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<FlightSql.SubstraitPlan.Builder>

getDefaultInstanceForType

public FlightSql.SubstraitPlan getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public FlightSql.SubstraitPlan build()

Specified by:

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

Specified by:

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

buildPartial

public FlightSql.SubstraitPlan buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

public FlightSql.SubstraitPlan.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<FlightSql.SubstraitPlan.Builder>

mergeFrom

public FlightSql.SubstraitPlan.Builder mergeFrom(FlightSql.SubstraitPlan other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.SubstraitPlan.Builder>

mergeFrom

public FlightSql.SubstraitPlan.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<FlightSql.SubstraitPlan.Builder>

Throws:

IOException

getPlan

public com.google.protobuf.ByteString getPlan()

 The serialized substrait.Plan to create a prepared statement for.
 XXX(ARROW-16902): this is bytes instead of an embedded message
 because Protobuf does not really support one DLL using Protobuf
 definitions from another DLL.
 

bytes plan = 1;

Specified by:

getPlan in interface FlightSql.SubstraitPlanOrBuilder

Returns:

The plan.

setPlan

public FlightSql.SubstraitPlan.Builder setPlan(com.google.protobuf.ByteString value)

 The serialized substrait.Plan to create a prepared statement for.
 XXX(ARROW-16902): this is bytes instead of an embedded message
 because Protobuf does not really support one DLL using Protobuf
 definitions from another DLL.
 

bytes plan = 1;

Parameters:

value - The plan to set.

Returns:

This builder for chaining.

clearPlan

public FlightSql.SubstraitPlan.Builder clearPlan()

 The serialized substrait.Plan to create a prepared statement for.
 XXX(ARROW-16902): this is bytes instead of an embedded message
 because Protobuf does not really support one DLL using Protobuf
 definitions from another DLL.
 

bytes plan = 1;

Returns:

This builder for chaining.

getVersion

public String getVersion()

 The Substrait release, e.g. "0.12.0". This information is not
 tracked in the plan itself, so this is the only way for consumers
 to potentially know if they can handle the plan.
 

string version = 2;

Specified by:

getVersion in interface FlightSql.SubstraitPlanOrBuilder

Returns:

The version.

getVersionBytes

public com.google.protobuf.ByteString getVersionBytes()

 The Substrait release, e.g. "0.12.0". This information is not
 tracked in the plan itself, so this is the only way for consumers
 to potentially know if they can handle the plan.
 

string version = 2;

Specified by:

getVersionBytes in interface FlightSql.SubstraitPlanOrBuilder

Returns:

The bytes for version.

setVersion

public FlightSql.SubstraitPlan.Builder setVersion(String value)

 The Substrait release, e.g. "0.12.0". This information is not
 tracked in the plan itself, so this is the only way for consumers
 to potentially know if they can handle the plan.
 

string version = 2;

Parameters:

value - The version to set.

Returns:

This builder for chaining.

clearVersion

public FlightSql.SubstraitPlan.Builder clearVersion()

 The Substrait release, e.g. "0.12.0". This information is not
 tracked in the plan itself, so this is the only way for consumers
 to potentially know if they can handle the plan.
 

string version = 2;

Returns:

This builder for chaining.

setVersionBytes

public FlightSql.SubstraitPlan.Builder setVersionBytes(com.google.protobuf.ByteString value)

 The Substrait release, e.g. "0.12.0". This information is not
 tracked in the plan itself, so this is the only way for consumers
 to potentially know if they can handle the plan.
 

string version = 2;

Parameters:

value - The bytes for version to set.

Returns:

This builder for chaining.

setUnknownFields

public final FlightSql.SubstraitPlan.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<FlightSql.SubstraitPlan.Builder>

mergeUnknownFields

public final FlightSql.SubstraitPlan.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<FlightSql.SubstraitPlan.Builder>