org.apache.arrow.flight.impl

Class Flight.SetSessionOptionsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.apache.arrow.flight.impl.Flight.SetSessionOptionsRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Flight.SetSessionOptionsRequestOrBuilder

Enclosing class:

Flight

public static final class Flight.SetSessionOptionsRequest
extends com.google.protobuf.GeneratedMessageV3
implements Flight.SetSessionOptionsRequestOrBuilder

 EXPERIMENTAL: A request to set session options for an existing or new (implicit)
 server session.

 Sessions are persisted and referenced via a transport-level state management, typically
 RFC 6265 HTTP cookies when using an HTTP transport.  The suggested cookie name or state
 context key is 'arrow_flight_session_id', although implementations may freely choose their
 own name.

 Session creation (if one does not already exist) is implied by this RPC request, however
 server implementations may choose to initiate a session that also contains client-provided
 session options at any other time, e.g. on authentication, or when any other call is made
 and the server wishes to use a session to persist any state (or lack thereof).
 

Protobuf type arrow.flight.protocol.SetSessionOptionsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Flight.SetSessionOptionsRequest.Builder EXPERIMENTAL: A request to set session options for an existing or new (implicit) server session.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	SESSION_OPTIONS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	containsSessionOptions(String key) map<string, .arrow.flight.protocol.SessionOptionValue> session_options = 1;
boolean	equals(Object obj)
static Flight.SetSessionOptionsRequest	getDefaultInstance()
Flight.SetSessionOptionsRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<Flight.SetSessionOptionsRequest>	getParserForType()
int	getSerializedSize()
Map<String,Flight.SessionOptionValue>	getSessionOptions() Deprecated.
int	getSessionOptionsCount() map<string, .arrow.flight.protocol.SessionOptionValue> session_options = 1;
Map<String,Flight.SessionOptionValue>	getSessionOptionsMap() map<string, .arrow.flight.protocol.SessionOptionValue> session_options = 1;
Flight.SessionOptionValue	getSessionOptionsOrDefault(String key, Flight.SessionOptionValue defaultValue) map<string, .arrow.flight.protocol.SessionOptionValue> session_options = 1;
Flight.SessionOptionValue	getSessionOptionsOrThrow(String key) map<string, .arrow.flight.protocol.SessionOptionValue> session_options = 1;
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static Flight.SetSessionOptionsRequest.Builder	newBuilder()
static Flight.SetSessionOptionsRequest.Builder	newBuilder(Flight.SetSessionOptionsRequest prototype)
Flight.SetSessionOptionsRequest.Builder	newBuilderForType()
protected Flight.SetSessionOptionsRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Flight.SetSessionOptionsRequest	parseDelimitedFrom(InputStream input)
static Flight.SetSessionOptionsRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.SetSessionOptionsRequest	parseFrom(byte[] data)
static Flight.SetSessionOptionsRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.SetSessionOptionsRequest	parseFrom(ByteBuffer data)
static Flight.SetSessionOptionsRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.SetSessionOptionsRequest	parseFrom(com.google.protobuf.ByteString data)
static Flight.SetSessionOptionsRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.SetSessionOptionsRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static Flight.SetSessionOptionsRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Flight.SetSessionOptionsRequest	parseFrom(InputStream input)
static Flight.SetSessionOptionsRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Flight.SetSessionOptionsRequest>	parser()
Flight.SetSessionOptionsRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SESSION_OPTIONS_FIELD_NUMBER

public static final int SESSION_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSessionOptionsCount

public int getSessionOptionsCount()

Description copied from interface: Flight.SetSessionOptionsRequestOrBuilder

map<string, .arrow.flight.protocol.SessionOptionValue> session_options = 1;

Specified by:

getSessionOptionsCount in interface Flight.SetSessionOptionsRequestOrBuilder

containsSessionOptions

public boolean containsSessionOptions(String key)

map<string, .arrow.flight.protocol.SessionOptionValue> session_options = 1;

Specified by:

containsSessionOptions in interface Flight.SetSessionOptionsRequestOrBuilder

getSessionOptions

@Deprecated
public Map<String,Flight.SessionOptionValue> getSessionOptions()

Deprecated.

Use getSessionOptionsMap() instead.

Specified by:

getSessionOptions in interface Flight.SetSessionOptionsRequestOrBuilder

getSessionOptionsMap

public Map<String,Flight.SessionOptionValue> getSessionOptionsMap()

map<string, .arrow.flight.protocol.SessionOptionValue> session_options = 1;

Specified by:

getSessionOptionsMap in interface Flight.SetSessionOptionsRequestOrBuilder

getSessionOptionsOrDefault

public Flight.SessionOptionValue getSessionOptionsOrDefault(String key,
                                                            Flight.SessionOptionValue defaultValue)

map<string, .arrow.flight.protocol.SessionOptionValue> session_options = 1;

Specified by:

getSessionOptionsOrDefault in interface Flight.SetSessionOptionsRequestOrBuilder

getSessionOptionsOrThrow

public Flight.SessionOptionValue getSessionOptionsOrThrow(String key)

map<string, .arrow.flight.protocol.SessionOptionValue> session_options = 1;

Specified by:

getSessionOptionsOrThrow in interface Flight.SetSessionOptionsRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Flight.SetSessionOptionsRequest parseFrom(ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Flight.SetSessionOptionsRequest parseFrom(ByteBuffer data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Flight.SetSessionOptionsRequest parseFrom(com.google.protobuf.ByteString data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Flight.SetSessionOptionsRequest parseFrom(com.google.protobuf.ByteString data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Flight.SetSessionOptionsRequest parseFrom(byte[] data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Flight.SetSessionOptionsRequest parseFrom(byte[] data,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Flight.SetSessionOptionsRequest parseFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseFrom

public static Flight.SetSessionOptionsRequest parseFrom(InputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Flight.SetSessionOptionsRequest parseDelimitedFrom(InputStream input)
                                                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static Flight.SetSessionOptionsRequest parseDelimitedFrom(InputStream input,
                                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                          throws IOException

Throws:

IOException

parseFrom

public static Flight.SetSessionOptionsRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                                 throws IOException

Throws:

IOException

parseFrom

public static Flight.SetSessionOptionsRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                 throws IOException

Throws:

IOException

newBuilderForType

public Flight.SetSessionOptionsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Flight.SetSessionOptionsRequest.Builder newBuilder()

newBuilder

public static Flight.SetSessionOptionsRequest.Builder newBuilder(Flight.SetSessionOptionsRequest prototype)

toBuilder

public Flight.SetSessionOptionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Flight.SetSessionOptionsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Flight.SetSessionOptionsRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<Flight.SetSessionOptionsRequest> parser()

getParserForType

public com.google.protobuf.Parser<Flight.SetSessionOptionsRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Flight.SetSessionOptionsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder