Package org.apache.arrow.flight.sql.impl
Class FlightSql.CommandStatementSubstraitPlan.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
org.apache.arrow.flight.sql.impl.FlightSql.CommandStatementSubstraitPlan.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Cloneable
,FlightSql.CommandStatementSubstraitPlanOrBuilder
- Enclosing class:
- FlightSql.CommandStatementSubstraitPlan
public static final class FlightSql.CommandStatementSubstraitPlan.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
implements FlightSql.CommandStatementSubstraitPlanOrBuilder
Represents a Substrait plan. Used in the command member of FlightDescriptor for the following RPC calls: - GetSchema: return the Arrow schema of the query. Fields on this schema may contain the following metadata: - ARROW:FLIGHT:SQL:CATALOG_NAME - Table's catalog name - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME - Database schema name - ARROW:FLIGHT:SQL:TABLE_NAME - Table name - ARROW:FLIGHT:SQL:TYPE_NAME - The data source-specific name for the data type of the column. - ARROW:FLIGHT:SQL:PRECISION - Column precision/size - ARROW:FLIGHT:SQL:SCALE - Column scale/decimal digits if applicable - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise. - ARROW:FLIGHT:SQL:IS_CASE_SENSITIVE - "1" indicates if the column is case-sensitive, "0" otherwise. - ARROW:FLIGHT:SQL:IS_READ_ONLY - "1" indicates if the column is read only, "0" otherwise. - ARROW:FLIGHT:SQL:IS_SEARCHABLE - "1" indicates if the column is searchable via WHERE clause, "0" otherwise. - GetFlightInfo: execute the query. - DoPut: execute the query.Protobuf type
arrow.flight.protocol.sql.CommandStatementSubstraitPlan
-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()
clear()
clearField
(com.google.protobuf.Descriptors.FieldDescriptor field) clearOneof
(com.google.protobuf.Descriptors.OneofDescriptor oneof) A serialized substrait.PlanInclude the query as part of this transaction (if unset, the query is auto-committed).clone()
static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
getPlan()
A serialized substrait.PlanA serialized substrait.PlanA serialized substrait.Plancom.google.protobuf.ByteString
Include the query as part of this transaction (if unset, the query is auto-committed).boolean
hasPlan()
A serialized substrait.Planboolean
Include the query as part of this transaction (if unset, the query is auto-committed).protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergePlan
(FlightSql.SubstraitPlan value) A serialized substrait.PlanmergeUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) setPlan
(FlightSql.SubstraitPlan value) A serialized substrait.PlansetPlan
(FlightSql.SubstraitPlan.Builder builderForValue) A serialized substrait.PlansetRepeatedField
(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setTransactionId
(com.google.protobuf.ByteString value) Include the query as part of this transaction (if unset, the query is auto-committed).setUnknownFields
(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, 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.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
setField
public FlightSql.CommandStatementSubstraitPlan.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
clearField
public FlightSql.CommandStatementSubstraitPlan.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field) - Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
clearOneof
public FlightSql.CommandStatementSubstraitPlan.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) - Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
setRepeatedField
public FlightSql.CommandStatementSubstraitPlan.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
addRepeatedField
public FlightSql.CommandStatementSubstraitPlan.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
mergeFrom
public FlightSql.CommandStatementSubstraitPlan.Builder mergeFrom(FlightSql.CommandStatementSubstraitPlan other) -
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
mergeFrom
public FlightSql.CommandStatementSubstraitPlan.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
- Throws:
IOException
-
hasPlan
public boolean hasPlan()A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1;
- Specified by:
hasPlan
in interfaceFlightSql.CommandStatementSubstraitPlanOrBuilder
- Returns:
- Whether the plan field is set.
-
getPlan
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1;
- Specified by:
getPlan
in interfaceFlightSql.CommandStatementSubstraitPlanOrBuilder
- Returns:
- The plan.
-
setPlan
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1;
-
setPlan
public FlightSql.CommandStatementSubstraitPlan.Builder setPlan(FlightSql.SubstraitPlan.Builder builderForValue) A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1;
-
mergePlan
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1;
-
clearPlan
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1;
-
getPlanBuilder
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1;
-
getPlanOrBuilder
A serialized substrait.Plan
.arrow.flight.protocol.sql.SubstraitPlan plan = 1;
- Specified by:
getPlanOrBuilder
in interfaceFlightSql.CommandStatementSubstraitPlanOrBuilder
-
hasTransactionId
public boolean hasTransactionId()Include the query as part of this transaction (if unset, the query is auto-committed).
optional bytes transaction_id = 2;
- Specified by:
hasTransactionId
in interfaceFlightSql.CommandStatementSubstraitPlanOrBuilder
- Returns:
- Whether the transactionId field is set.
-
getTransactionId
public com.google.protobuf.ByteString getTransactionId()Include the query as part of this transaction (if unset, the query is auto-committed).
optional bytes transaction_id = 2;
- Specified by:
getTransactionId
in interfaceFlightSql.CommandStatementSubstraitPlanOrBuilder
- Returns:
- The transactionId.
-
setTransactionId
public FlightSql.CommandStatementSubstraitPlan.Builder setTransactionId(com.google.protobuf.ByteString value) Include the query as part of this transaction (if unset, the query is auto-committed).
optional bytes transaction_id = 2;
- Parameters:
value
- The transactionId to set.- Returns:
- This builder for chaining.
-
clearTransactionId
Include the query as part of this transaction (if unset, the query is auto-committed).
optional bytes transaction_id = 2;
- Returns:
- This builder for chaining.
-
setUnknownFields
public final FlightSql.CommandStatementSubstraitPlan.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-
mergeUnknownFields
public final FlightSql.CommandStatementSubstraitPlan.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
-