FlightSql.CommandStatementSubstraitPlan.Builder (Apache Arrow Java Root POM 16.1.0 API)

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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FlightSql.CommandStatementSubstraitPlan`	`build()`
`FlightSql.CommandStatementSubstraitPlan`	`buildPartial()`
`FlightSql.CommandStatementSubstraitPlan.Builder`	`clear()`
`FlightSql.CommandStatementSubstraitPlan.Builder`	`clearPlan()` A serialized substrait.Plan
`FlightSql.CommandStatementSubstraitPlan.Builder`	`clearTransactionId()` Include the query as part of this transaction (if unset, the query is auto-committed).
`FlightSql.CommandStatementSubstraitPlan`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`FlightSql.SubstraitPlan`	`getPlan()` A serialized substrait.Plan
`FlightSql.SubstraitPlan.Builder`	`getPlanBuilder()` A serialized substrait.Plan
`FlightSql.SubstraitPlanOrBuilder`	`getPlanOrBuilder()` A serialized substrait.Plan
`com.google.protobuf.ByteString`	`getTransactionId()` Include the query as part of this transaction (if unset, the query is auto-committed).
`boolean`	`hasPlan()` A serialized substrait.Plan
`boolean`	`hasTransactionId()` Include the query as part of this transaction (if unset, the query is auto-committed).
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`FlightSql.CommandStatementSubstraitPlan.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`FlightSql.CommandStatementSubstraitPlan.Builder`	`mergeFrom(FlightSql.CommandStatementSubstraitPlan other)`
`FlightSql.CommandStatementSubstraitPlan.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`FlightSql.CommandStatementSubstraitPlan.Builder`	`mergePlan(FlightSql.SubstraitPlan value)` A serialized substrait.Plan
`FlightSql.CommandStatementSubstraitPlan.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`FlightSql.CommandStatementSubstraitPlan.Builder`	`setPlan(FlightSql.SubstraitPlan.Builder builderForValue)` A serialized substrait.Plan
`FlightSql.CommandStatementSubstraitPlan.Builder`	`setPlan(FlightSql.SubstraitPlan value)` A serialized substrait.Plan
`FlightSql.CommandStatementSubstraitPlan.Builder`	`setTransactionId(com.google.protobuf.ByteString value)` Include the query as part of this transaction (if unset, the query is auto-committed).
`FlightSql.CommandStatementSubstraitPlan.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

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.CommandStatementSubstraitPlan.Builder>
  - clear
```
public FlightSql.CommandStatementSubstraitPlan.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.CommandStatementSubstraitPlan.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.CommandStatementSubstraitPlan.Builder>
  - getDefaultInstanceForType
```
public FlightSql.CommandStatementSubstraitPlan getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public FlightSql.CommandStatementSubstraitPlan build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public FlightSql.CommandStatementSubstraitPlan buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - mergeFrom
```
public FlightSql.CommandStatementSubstraitPlan.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.CommandStatementSubstraitPlan.Builder>
  - mergeFrom
```
public FlightSql.CommandStatementSubstraitPlan.Builder mergeFrom(FlightSql.CommandStatementSubstraitPlan 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.CommandStatementSubstraitPlan.Builder>
  - mergeFrom
```
public FlightSql.CommandStatementSubstraitPlan.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.CommandStatementSubstraitPlan.Builder>
    
    Throws:
    
    IOException
  - hasPlan
```
public boolean hasPlan()
```
```
 A serialized substrait.Plan
 
```
    .arrow.flight.protocol.sql.SubstraitPlan plan = 1;
    Specified by:
    
    hasPlan in interface FlightSql.CommandStatementSubstraitPlanOrBuilder
    
    Returns:
    
    Whether the plan field is set.
  - getPlan
```
public FlightSql.SubstraitPlan getPlan()
```
```
 A serialized substrait.Plan
 
```
    .arrow.flight.protocol.sql.SubstraitPlan plan = 1;
    Specified by:
    
    getPlan in interface FlightSql.CommandStatementSubstraitPlanOrBuilder
    
    Returns:
    
    The plan.
  - setPlan
```
public FlightSql.CommandStatementSubstraitPlan.Builder setPlan(FlightSql.SubstraitPlan value)
```
```
 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
```
public FlightSql.CommandStatementSubstraitPlan.Builder mergePlan(FlightSql.SubstraitPlan value)
```
```
 A serialized substrait.Plan
 
```
    .arrow.flight.protocol.sql.SubstraitPlan plan = 1;
  - clearPlan
```
public FlightSql.CommandStatementSubstraitPlan.Builder clearPlan()
```
```
 A serialized substrait.Plan
 
```
    .arrow.flight.protocol.sql.SubstraitPlan plan = 1;
  - getPlanBuilder
```
public FlightSql.SubstraitPlan.Builder getPlanBuilder()
```
```
 A serialized substrait.Plan
 
```
    .arrow.flight.protocol.sql.SubstraitPlan plan = 1;
  - getPlanOrBuilder
```
public FlightSql.SubstraitPlanOrBuilder getPlanOrBuilder()
```
```
 A serialized substrait.Plan
 
```
    .arrow.flight.protocol.sql.SubstraitPlan plan = 1;
    Specified by:
    
    getPlanOrBuilder in interface FlightSql.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 interface FlightSql.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 interface FlightSql.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
```
public FlightSql.CommandStatementSubstraitPlan.Builder 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 interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.CommandStatementSubstraitPlan.Builder>
  - mergeUnknownFields
```
public final FlightSql.CommandStatementSubstraitPlan.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.CommandStatementSubstraitPlan.Builder>

Class FlightSql.CommandStatementSubstraitPlan.Builder

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

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

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasPlan

getPlan

setPlan

setPlan

mergePlan

clearPlan

getPlanBuilder

getPlanOrBuilder

hasTransactionId

getTransactionId

setTransactionId

clearTransactionId

setUnknownFields

mergeUnknownFields