org.apache.arrow.flight.sql.impl

Class FlightSql.ActionCreatePreparedStatementResult.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

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

All Implemented Interfaces:

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

Enclosing class:

FlightSql.ActionCreatePreparedStatementResult

public static final class FlightSql.ActionCreatePreparedStatementResult.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<FlightSql.ActionCreatePreparedStatementResult.Builder>
implements FlightSql.ActionCreatePreparedStatementResultOrBuilder

 Wrap the result of a "CreatePreparedStatement" or "CreatePreparedSubstraitPlan" action.

 The resultant PreparedStatement can be closed either:
 - Manually, through the "ClosePreparedStatement" action;
 - Automatically, by a server timeout.

 The result should be wrapped in a google.protobuf.Any message.
 

Protobuf type arrow.flight.protocol.sql.ActionCreatePreparedStatementResult

Method Summary

Modifier and Type	Method and Description
FlightSql.ActionCreatePreparedStatementResult	build()
FlightSql.ActionCreatePreparedStatementResult	buildPartial()
FlightSql.ActionCreatePreparedStatementResult.Builder	clear()
FlightSql.ActionCreatePreparedStatementResult.Builder	clearDatasetSchema() If a result set generating query was provided, dataset_schema contains the schema of the result set.
FlightSql.ActionCreatePreparedStatementResult.Builder	clearParameterSchema() If the query provided contained parameters, parameter_schema contains the schema of the expected parameters.
FlightSql.ActionCreatePreparedStatementResult.Builder	clearPreparedStatementHandle() Opaque handle for the prepared statement on the server.
com.google.protobuf.ByteString	getDatasetSchema() If a result set generating query was provided, dataset_schema contains the schema of the result set.
FlightSql.ActionCreatePreparedStatementResult	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
com.google.protobuf.ByteString	getParameterSchema() If the query provided contained parameters, parameter_schema contains the schema of the expected parameters.
com.google.protobuf.ByteString	getPreparedStatementHandle() Opaque handle for the prepared statement on the server.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
FlightSql.ActionCreatePreparedStatementResult.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
FlightSql.ActionCreatePreparedStatementResult.Builder	mergeFrom(FlightSql.ActionCreatePreparedStatementResult other)
FlightSql.ActionCreatePreparedStatementResult.Builder	mergeFrom(com.google.protobuf.Message other)
FlightSql.ActionCreatePreparedStatementResult.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
FlightSql.ActionCreatePreparedStatementResult.Builder	setDatasetSchema(com.google.protobuf.ByteString value) If a result set generating query was provided, dataset_schema contains the schema of the result set.
FlightSql.ActionCreatePreparedStatementResult.Builder	setParameterSchema(com.google.protobuf.ByteString value) If the query provided contained parameters, parameter_schema contains the schema of the expected parameters.
FlightSql.ActionCreatePreparedStatementResult.Builder	setPreparedStatementHandle(com.google.protobuf.ByteString value) Opaque handle for the prepared statement on the server.
FlightSql.ActionCreatePreparedStatementResult.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.ActionCreatePreparedStatementResult.Builder>

clear

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

getDefaultInstanceForType

public FlightSql.ActionCreatePreparedStatementResult getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public FlightSql.ActionCreatePreparedStatementResult build()

Specified by:

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

Specified by:

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

buildPartial

public FlightSql.ActionCreatePreparedStatementResult buildPartial()

Specified by:

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

Specified by:

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

mergeFrom

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

mergeFrom

public FlightSql.ActionCreatePreparedStatementResult.Builder mergeFrom(FlightSql.ActionCreatePreparedStatementResult 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.ActionCreatePreparedStatementResult.Builder>

mergeFrom

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

Throws:

IOException

getPreparedStatementHandle

public com.google.protobuf.ByteString getPreparedStatementHandle()

 Opaque handle for the prepared statement on the server.
 

bytes prepared_statement_handle = 1;

Specified by:

getPreparedStatementHandle in interface FlightSql.ActionCreatePreparedStatementResultOrBuilder

Returns:

The preparedStatementHandle.

setPreparedStatementHandle

public FlightSql.ActionCreatePreparedStatementResult.Builder setPreparedStatementHandle(com.google.protobuf.ByteString value)

 Opaque handle for the prepared statement on the server.
 

bytes prepared_statement_handle = 1;

Parameters:

value - The preparedStatementHandle to set.

Returns:

This builder for chaining.

clearPreparedStatementHandle

public FlightSql.ActionCreatePreparedStatementResult.Builder clearPreparedStatementHandle()

 Opaque handle for the prepared statement on the server.
 

bytes prepared_statement_handle = 1;

Returns:

This builder for chaining.

getDatasetSchema

public com.google.protobuf.ByteString getDatasetSchema()

 If a result set generating query was provided, dataset_schema contains the
 schema of the result set.  It should be an IPC-encapsulated Schema, as described in Schema.fbs.
 For some queries, the schema of the results may depend on the schema of the parameters.  The server
 should provide its best guess as to the schema at this point.  Clients must not assume that this
 schema, if provided, will be accurate.
 

bytes dataset_schema = 2;

Specified by:

getDatasetSchema in interface FlightSql.ActionCreatePreparedStatementResultOrBuilder

Returns:

The datasetSchema.

setDatasetSchema

public FlightSql.ActionCreatePreparedStatementResult.Builder setDatasetSchema(com.google.protobuf.ByteString value)

 If a result set generating query was provided, dataset_schema contains the
 schema of the result set.  It should be an IPC-encapsulated Schema, as described in Schema.fbs.
 For some queries, the schema of the results may depend on the schema of the parameters.  The server
 should provide its best guess as to the schema at this point.  Clients must not assume that this
 schema, if provided, will be accurate.
 

bytes dataset_schema = 2;

Parameters:

value - The datasetSchema to set.

Returns:

This builder for chaining.

clearDatasetSchema

public FlightSql.ActionCreatePreparedStatementResult.Builder clearDatasetSchema()

 If a result set generating query was provided, dataset_schema contains the
 schema of the result set.  It should be an IPC-encapsulated Schema, as described in Schema.fbs.
 For some queries, the schema of the results may depend on the schema of the parameters.  The server
 should provide its best guess as to the schema at this point.  Clients must not assume that this
 schema, if provided, will be accurate.
 

bytes dataset_schema = 2;

Returns:

This builder for chaining.

getParameterSchema

public com.google.protobuf.ByteString getParameterSchema()

 If the query provided contained parameters, parameter_schema contains the
 schema of the expected parameters.  It should be an IPC-encapsulated Schema, as described in Schema.fbs.
 

bytes parameter_schema = 3;

Specified by:

getParameterSchema in interface FlightSql.ActionCreatePreparedStatementResultOrBuilder

Returns:

The parameterSchema.

setParameterSchema

public FlightSql.ActionCreatePreparedStatementResult.Builder setParameterSchema(com.google.protobuf.ByteString value)

 If the query provided contained parameters, parameter_schema contains the
 schema of the expected parameters.  It should be an IPC-encapsulated Schema, as described in Schema.fbs.
 

bytes parameter_schema = 3;

Parameters:

value - The parameterSchema to set.

Returns:

This builder for chaining.

clearParameterSchema

public FlightSql.ActionCreatePreparedStatementResult.Builder clearParameterSchema()

 If the query provided contained parameters, parameter_schema contains the
 schema of the expected parameters.  It should be an IPC-encapsulated Schema, as described in Schema.fbs.
 

bytes parameter_schema = 3;

Returns:

This builder for chaining.

setUnknownFields

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

mergeUnknownFields

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