Module org.apache.arrow.flight.core

Package org.apache.arrow.flight

Class SetSessionOptionsRequest

java.lang.Object

org.apache.arrow.flight.SetSessionOptionsRequest

public class SetSessionOptionsRequest
extends Object

A request to set option(s) in an existing or implicitly-created server session.

Constructor Summary

Constructors

Constructor	Description
SetSessionOptionsRequest(Map<String,SessionOptionValue> sessionOptions)

Method Summary

Modifier and Type	Method	Description
static SetSessionOptionsRequest	deserialize(ByteBuffer serialized)	Parse the serialized form of this protocol message.
Map<String,SessionOptionValue>	getSessionOptions()	Get the session option map from the request.
ByteBuffer	serialize()	Get the serialized form of this protocol message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SetSessionOptionsRequest

public SetSessionOptionsRequest(Map<String,SessionOptionValue> sessionOptions)

Method Details

getSessionOptions

public Map<String,SessionOptionValue> getSessionOptions()

Get the session option map from the request.

Returns:

An immutable view of the session options map.

serialize

public ByteBuffer serialize()

Get the serialized form of this protocol message.

Intended to help interoperability by allowing non-Flight services to still return Flight types.

deserialize

public static SetSessionOptionsRequest deserialize(ByteBuffer serialized)
                                            throws IOException

Parse the serialized form of this protocol message.

Intended to help interoperability by allowing Flight clients to obtain stream info from non-Flight services.

Parameters:

serialized - The serialized form of the message, as returned by serialize().

Returns:

The deserialized message.

Throws:

IOException - if the serialized form is invalid.