@lancedb/arrow-flight-sql-client
Version:
A native typescript project for querying Flight SQL endpoints
1,034 lines (871 loc) • 173 kB
text/typescript
import * as apache_arrow from 'apache-arrow';
import { Schema, AsyncRecordBatchStreamReader, RecordBatch } from 'apache-arrow';
import * as $protobuf from 'protobufjs';
import Long from 'long';
import { Metadata as Metadata$1 } from '@grpc/grpc-js';
/** Namespace arrow. */
declare namespace arrow {
/** Namespace flight. */
namespace flight {
/** Namespace protocol. */
namespace protocol {
/** Represents a FlightService */
class FlightService extends $protobuf.rpc.Service {
/**
* Constructs a new FlightService service.
* @param rpcImpl RPC implementation
* @param [requestDelimited=false] Whether requests are length-delimited
* @param [responseDelimited=false] Whether responses are length-delimited
*/
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
/**
* Creates new FlightService service using the specified rpc implementation.
* @param rpcImpl RPC implementation
* @param [requestDelimited=false] Whether requests are length-delimited
* @param [responseDelimited=false] Whether responses are length-delimited
* @returns RPC service. Useful where requests and/or responses are streamed.
*/
public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): FlightService;
/**
* Calls Handshake.
* @param request HandshakeRequest message or plain object
* @param callback Node-style callback called with the error, if any, and HandshakeResponse
*/
public handshake(request: arrow.flight.protocol.IHandshakeRequest, callback: arrow.flight.protocol.FlightService.HandshakeCallback): void;
/**
* Calls Handshake.
* @param request HandshakeRequest message or plain object
* @returns Promise
*/
public handshake(request: arrow.flight.protocol.IHandshakeRequest): Promise<arrow.flight.protocol.HandshakeResponse>;
/**
* Calls ListFlights.
* @param request Criteria message or plain object
* @param callback Node-style callback called with the error, if any, and FlightInfo
*/
public listFlights(request: arrow.flight.protocol.ICriteria, callback: arrow.flight.protocol.FlightService.ListFlightsCallback): void;
/**
* Calls ListFlights.
* @param request Criteria message or plain object
* @returns Promise
*/
public listFlights(request: arrow.flight.protocol.ICriteria): Promise<arrow.flight.protocol.FlightInfo>;
/**
* Calls GetFlightInfo.
* @param request FlightDescriptor message or plain object
* @param callback Node-style callback called with the error, if any, and FlightInfo
*/
public getFlightInfo(request: arrow.flight.protocol.IFlightDescriptor, callback: arrow.flight.protocol.FlightService.GetFlightInfoCallback): void;
/**
* Calls GetFlightInfo.
* @param request FlightDescriptor message or plain object
* @returns Promise
*/
public getFlightInfo(request: arrow.flight.protocol.IFlightDescriptor): Promise<arrow.flight.protocol.FlightInfo>;
/**
* Calls PollFlightInfo.
* @param request FlightDescriptor message or plain object
* @param callback Node-style callback called with the error, if any, and PollInfo
*/
public pollFlightInfo(request: arrow.flight.protocol.IFlightDescriptor, callback: arrow.flight.protocol.FlightService.PollFlightInfoCallback): void;
/**
* Calls PollFlightInfo.
* @param request FlightDescriptor message or plain object
* @returns Promise
*/
public pollFlightInfo(request: arrow.flight.protocol.IFlightDescriptor): Promise<arrow.flight.protocol.PollInfo>;
/**
* Calls GetSchema.
* @param request FlightDescriptor message or plain object
* @param callback Node-style callback called with the error, if any, and SchemaResult
*/
public getSchema(request: arrow.flight.protocol.IFlightDescriptor, callback: arrow.flight.protocol.FlightService.GetSchemaCallback): void;
/**
* Calls GetSchema.
* @param request FlightDescriptor message or plain object
* @returns Promise
*/
public getSchema(request: arrow.flight.protocol.IFlightDescriptor): Promise<arrow.flight.protocol.SchemaResult>;
/**
* Calls DoGet.
* @param request Ticket message or plain object
* @param callback Node-style callback called with the error, if any, and FlightData
*/
public doGet(request: arrow.flight.protocol.ITicket, callback: arrow.flight.protocol.FlightService.DoGetCallback): void;
/**
* Calls DoGet.
* @param request Ticket message or plain object
* @returns Promise
*/
public doGet(request: arrow.flight.protocol.ITicket): Promise<arrow.flight.protocol.FlightData>;
/**
* Calls DoPut.
* @param request FlightData message or plain object
* @param callback Node-style callback called with the error, if any, and PutResult
*/
public doPut(request: arrow.flight.protocol.IFlightData, callback: arrow.flight.protocol.FlightService.DoPutCallback): void;
/**
* Calls DoPut.
* @param request FlightData message or plain object
* @returns Promise
*/
public doPut(request: arrow.flight.protocol.IFlightData): Promise<arrow.flight.protocol.PutResult>;
/**
* Calls DoExchange.
* @param request FlightData message or plain object
* @param callback Node-style callback called with the error, if any, and FlightData
*/
public doExchange(request: arrow.flight.protocol.IFlightData, callback: arrow.flight.protocol.FlightService.DoExchangeCallback): void;
/**
* Calls DoExchange.
* @param request FlightData message or plain object
* @returns Promise
*/
public doExchange(request: arrow.flight.protocol.IFlightData): Promise<arrow.flight.protocol.FlightData>;
/**
* Calls DoAction.
* @param request Action message or plain object
* @param callback Node-style callback called with the error, if any, and Result
*/
public doAction(request: arrow.flight.protocol.IAction, callback: arrow.flight.protocol.FlightService.DoActionCallback): void;
/**
* Calls DoAction.
* @param request Action message or plain object
* @returns Promise
*/
public doAction(request: arrow.flight.protocol.IAction): Promise<arrow.flight.protocol.Result>;
/**
* Calls ListActions.
* @param request Empty message or plain object
* @param callback Node-style callback called with the error, if any, and ActionType
*/
public listActions(request: arrow.flight.protocol.IEmpty, callback: arrow.flight.protocol.FlightService.ListActionsCallback): void;
/**
* Calls ListActions.
* @param request Empty message or plain object
* @returns Promise
*/
public listActions(request: arrow.flight.protocol.IEmpty): Promise<arrow.flight.protocol.ActionType>;
}
namespace FlightService {
/**
* Callback as used by {@link arrow.flight.protocol.FlightService#handshake}.
* @param error Error, if any
* @param [response] HandshakeResponse
*/
type HandshakeCallback = (error: (Error|null), response?: arrow.flight.protocol.HandshakeResponse) => void;
/**
* Callback as used by {@link arrow.flight.protocol.FlightService#listFlights}.
* @param error Error, if any
* @param [response] FlightInfo
*/
type ListFlightsCallback = (error: (Error|null), response?: arrow.flight.protocol.FlightInfo) => void;
/**
* Callback as used by {@link arrow.flight.protocol.FlightService#getFlightInfo}.
* @param error Error, if any
* @param [response] FlightInfo
*/
type GetFlightInfoCallback = (error: (Error|null), response?: arrow.flight.protocol.FlightInfo) => void;
/**
* Callback as used by {@link arrow.flight.protocol.FlightService#pollFlightInfo}.
* @param error Error, if any
* @param [response] PollInfo
*/
type PollFlightInfoCallback = (error: (Error|null), response?: arrow.flight.protocol.PollInfo) => void;
/**
* Callback as used by {@link arrow.flight.protocol.FlightService#getSchema}.
* @param error Error, if any
* @param [response] SchemaResult
*/
type GetSchemaCallback = (error: (Error|null), response?: arrow.flight.protocol.SchemaResult) => void;
/**
* Callback as used by {@link arrow.flight.protocol.FlightService#doGet}.
* @param error Error, if any
* @param [response] FlightData
*/
type DoGetCallback = (error: (Error|null), response?: arrow.flight.protocol.FlightData) => void;
/**
* Callback as used by {@link arrow.flight.protocol.FlightService#doPut}.
* @param error Error, if any
* @param [response] PutResult
*/
type DoPutCallback = (error: (Error|null), response?: arrow.flight.protocol.PutResult) => void;
/**
* Callback as used by {@link arrow.flight.protocol.FlightService#doExchange}.
* @param error Error, if any
* @param [response] FlightData
*/
type DoExchangeCallback = (error: (Error|null), response?: arrow.flight.protocol.FlightData) => void;
/**
* Callback as used by {@link arrow.flight.protocol.FlightService#doAction}.
* @param error Error, if any
* @param [response] Result
*/
type DoActionCallback = (error: (Error|null), response?: arrow.flight.protocol.Result) => void;
/**
* Callback as used by {@link arrow.flight.protocol.FlightService#listActions}.
* @param error Error, if any
* @param [response] ActionType
*/
type ListActionsCallback = (error: (Error|null), response?: arrow.flight.protocol.ActionType) => void;
}
/** Properties of a HandshakeRequest. */
interface IHandshakeRequest {
/** HandshakeRequest protocolVersion */
protocolVersion?: (number|Long|null);
/** HandshakeRequest payload */
payload?: (Uint8Array|null);
}
/** Represents a HandshakeRequest. */
class HandshakeRequest implements IHandshakeRequest {
/**
* Constructs a new HandshakeRequest.
* @param [properties] Properties to set
*/
constructor(properties?: arrow.flight.protocol.IHandshakeRequest);
/** HandshakeRequest protocolVersion. */
public protocolVersion: (number|Long);
/** HandshakeRequest payload. */
public payload: Uint8Array;
/**
* Creates a new HandshakeRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns HandshakeRequest instance
*/
public static create(properties?: arrow.flight.protocol.IHandshakeRequest): arrow.flight.protocol.HandshakeRequest;
/**
* Encodes the specified HandshakeRequest message. Does not implicitly {@link arrow.flight.protocol.HandshakeRequest.verify|verify} messages.
* @param message HandshakeRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: arrow.flight.protocol.IHandshakeRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified HandshakeRequest message, length delimited. Does not implicitly {@link arrow.flight.protocol.HandshakeRequest.verify|verify} messages.
* @param message HandshakeRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: arrow.flight.protocol.IHandshakeRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a HandshakeRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns HandshakeRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): arrow.flight.protocol.HandshakeRequest;
/**
* Decodes a HandshakeRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns HandshakeRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): arrow.flight.protocol.HandshakeRequest;
/**
* Verifies a HandshakeRequest message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a HandshakeRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns HandshakeRequest
*/
public static fromObject(object: { [k: string]: any }): arrow.flight.protocol.HandshakeRequest;
/**
* Creates a plain object from a HandshakeRequest message. Also converts values to other types if specified.
* @param message HandshakeRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: arrow.flight.protocol.HandshakeRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this HandshakeRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for HandshakeRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a HandshakeResponse. */
interface IHandshakeResponse {
/** HandshakeResponse protocolVersion */
protocolVersion?: (number|Long|null);
/** HandshakeResponse payload */
payload?: (Uint8Array|null);
}
/** Represents a HandshakeResponse. */
class HandshakeResponse implements IHandshakeResponse {
/**
* Constructs a new HandshakeResponse.
* @param [properties] Properties to set
*/
constructor(properties?: arrow.flight.protocol.IHandshakeResponse);
/** HandshakeResponse protocolVersion. */
public protocolVersion: (number|Long);
/** HandshakeResponse payload. */
public payload: Uint8Array;
/**
* Creates a new HandshakeResponse instance using the specified properties.
* @param [properties] Properties to set
* @returns HandshakeResponse instance
*/
public static create(properties?: arrow.flight.protocol.IHandshakeResponse): arrow.flight.protocol.HandshakeResponse;
/**
* Encodes the specified HandshakeResponse message. Does not implicitly {@link arrow.flight.protocol.HandshakeResponse.verify|verify} messages.
* @param message HandshakeResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: arrow.flight.protocol.IHandshakeResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified HandshakeResponse message, length delimited. Does not implicitly {@link arrow.flight.protocol.HandshakeResponse.verify|verify} messages.
* @param message HandshakeResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: arrow.flight.protocol.IHandshakeResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a HandshakeResponse message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns HandshakeResponse
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): arrow.flight.protocol.HandshakeResponse;
/**
* Decodes a HandshakeResponse message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns HandshakeResponse
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): arrow.flight.protocol.HandshakeResponse;
/**
* Verifies a HandshakeResponse message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a HandshakeResponse message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns HandshakeResponse
*/
public static fromObject(object: { [k: string]: any }): arrow.flight.protocol.HandshakeResponse;
/**
* Creates a plain object from a HandshakeResponse message. Also converts values to other types if specified.
* @param message HandshakeResponse
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: arrow.flight.protocol.HandshakeResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this HandshakeResponse to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for HandshakeResponse
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a BasicAuth. */
interface IBasicAuth {
/** BasicAuth username */
username?: (string|null);
/** BasicAuth password */
password?: (string|null);
}
/** Represents a BasicAuth. */
class BasicAuth implements IBasicAuth {
/**
* Constructs a new BasicAuth.
* @param [properties] Properties to set
*/
constructor(properties?: arrow.flight.protocol.IBasicAuth);
/** BasicAuth username. */
public username: string;
/** BasicAuth password. */
public password: string;
/**
* Creates a new BasicAuth instance using the specified properties.
* @param [properties] Properties to set
* @returns BasicAuth instance
*/
public static create(properties?: arrow.flight.protocol.IBasicAuth): arrow.flight.protocol.BasicAuth;
/**
* Encodes the specified BasicAuth message. Does not implicitly {@link arrow.flight.protocol.BasicAuth.verify|verify} messages.
* @param message BasicAuth message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: arrow.flight.protocol.IBasicAuth, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified BasicAuth message, length delimited. Does not implicitly {@link arrow.flight.protocol.BasicAuth.verify|verify} messages.
* @param message BasicAuth message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: arrow.flight.protocol.IBasicAuth, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a BasicAuth message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns BasicAuth
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): arrow.flight.protocol.BasicAuth;
/**
* Decodes a BasicAuth message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns BasicAuth
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): arrow.flight.protocol.BasicAuth;
/**
* Verifies a BasicAuth message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a BasicAuth message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns BasicAuth
*/
public static fromObject(object: { [k: string]: any }): arrow.flight.protocol.BasicAuth;
/**
* Creates a plain object from a BasicAuth message. Also converts values to other types if specified.
* @param message BasicAuth
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: arrow.flight.protocol.BasicAuth, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this BasicAuth to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for BasicAuth
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an Empty. */
interface IEmpty {
}
/** Represents an Empty. */
class Empty implements IEmpty {
/**
* Constructs a new Empty.
* @param [properties] Properties to set
*/
constructor(properties?: arrow.flight.protocol.IEmpty);
/**
* Creates a new Empty instance using the specified properties.
* @param [properties] Properties to set
* @returns Empty instance
*/
public static create(properties?: arrow.flight.protocol.IEmpty): arrow.flight.protocol.Empty;
/**
* Encodes the specified Empty message. Does not implicitly {@link arrow.flight.protocol.Empty.verify|verify} messages.
* @param message Empty message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: arrow.flight.protocol.IEmpty, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified Empty message, length delimited. Does not implicitly {@link arrow.flight.protocol.Empty.verify|verify} messages.
* @param message Empty message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: arrow.flight.protocol.IEmpty, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an Empty message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns Empty
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): arrow.flight.protocol.Empty;
/**
* Decodes an Empty message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns Empty
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): arrow.flight.protocol.Empty;
/**
* Verifies an Empty message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an Empty message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Empty
*/
public static fromObject(object: { [k: string]: any }): arrow.flight.protocol.Empty;
/**
* Creates a plain object from an Empty message. Also converts values to other types if specified.
* @param message Empty
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: arrow.flight.protocol.Empty, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Empty to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Empty
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an ActionType. */
interface IActionType {
/** ActionType type */
type?: (string|null);
/** ActionType description */
description?: (string|null);
}
/** Represents an ActionType. */
class ActionType implements IActionType {
/**
* Constructs a new ActionType.
* @param [properties] Properties to set
*/
constructor(properties?: arrow.flight.protocol.IActionType);
/** ActionType type. */
public type: string;
/** ActionType description. */
public description: string;
/**
* Creates a new ActionType instance using the specified properties.
* @param [properties] Properties to set
* @returns ActionType instance
*/
public static create(properties?: arrow.flight.protocol.IActionType): arrow.flight.protocol.ActionType;
/**
* Encodes the specified ActionType message. Does not implicitly {@link arrow.flight.protocol.ActionType.verify|verify} messages.
* @param message ActionType message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: arrow.flight.protocol.IActionType, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified ActionType message, length delimited. Does not implicitly {@link arrow.flight.protocol.ActionType.verify|verify} messages.
* @param message ActionType message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: arrow.flight.protocol.IActionType, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an ActionType message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns ActionType
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): arrow.flight.protocol.ActionType;
/**
* Decodes an ActionType message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns ActionType
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): arrow.flight.protocol.ActionType;
/**
* Verifies an ActionType message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an ActionType message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns ActionType
*/
public static fromObject(object: { [k: string]: any }): arrow.flight.protocol.ActionType;
/**
* Creates a plain object from an ActionType message. Also converts values to other types if specified.
* @param message ActionType
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: arrow.flight.protocol.ActionType, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this ActionType to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for ActionType
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a Criteria. */
interface ICriteria {
/** Criteria expression */
expression?: (Uint8Array|null);
}
/** Represents a Criteria. */
class Criteria implements ICriteria {
/**
* Constructs a new Criteria.
* @param [properties] Properties to set
*/
constructor(properties?: arrow.flight.protocol.ICriteria);
/** Criteria expression. */
public expression: Uint8Array;
/**
* Creates a new Criteria instance using the specified properties.
* @param [properties] Properties to set
* @returns Criteria instance
*/
public static create(properties?: arrow.flight.protocol.ICriteria): arrow.flight.protocol.Criteria;
/**
* Encodes the specified Criteria message. Does not implicitly {@link arrow.flight.protocol.Criteria.verify|verify} messages.
* @param message Criteria message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: arrow.flight.protocol.ICriteria, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified Criteria message, length delimited. Does not implicitly {@link arrow.flight.protocol.Criteria.verify|verify} messages.
* @param message Criteria message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: arrow.flight.protocol.ICriteria, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a Criteria message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns Criteria
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): arrow.flight.protocol.Criteria;
/**
* Decodes a Criteria message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns Criteria
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): arrow.flight.protocol.Criteria;
/**
* Verifies a Criteria message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a Criteria message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Criteria
*/
public static fromObject(object: { [k: string]: any }): arrow.flight.protocol.Criteria;
/**
* Creates a plain object from a Criteria message. Also converts values to other types if specified.
* @param message Criteria
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: arrow.flight.protocol.Criteria, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Criteria to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Criteria
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an Action. */
interface IAction {
/** Action type */
type?: (string|null);
/** Action body */
body?: (Uint8Array|null);
}
/** Represents an Action. */
class Action implements IAction {
/**
* Constructs a new Action.
* @param [properties] Properties to set
*/
constructor(properties?: arrow.flight.protocol.IAction);
/** Action type. */
public type: string;
/** Action body. */
public body: Uint8Array;
/**
* Creates a new Action instance using the specified properties.
* @param [properties] Properties to set
* @returns Action instance
*/
public static create(properties?: arrow.flight.protocol.IAction): arrow.flight.protocol.Action;
/**
* Encodes the specified Action message. Does not implicitly {@link arrow.flight.protocol.Action.verify|verify} messages.
* @param message Action message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: arrow.flight.protocol.IAction, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified Action message, length delimited. Does not implicitly {@link arrow.flight.protocol.Action.verify|verify} messages.
* @param message Action message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: arrow.flight.protocol.IAction, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an Action message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns Action
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): arrow.flight.protocol.Action;
/**
* Decodes an Action message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns Action
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): arrow.flight.protocol.Action;
/**
* Verifies an Action message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an Action message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Action
*/
public static fromObject(object: { [k: string]: any }): arrow.flight.protocol.Action;
/**
* Creates a plain object from an Action message. Also converts values to other types if specified.
* @param message Action
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: arrow.flight.protocol.Action, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this Action to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for Action
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a Result. */
interface IResult {
/** Result body */
body?: (Uint8Array|null);
}
/** Represents a Result. */
class Result implements IResult {
/**
* Constructs a new Result.
* @param [properties] Properties to set
*/
constructor(properties?: arrow.flight.protocol.IResult);
/** Result body. */
public body: Uint8Array;
/**
* Creates a new Result instance using the specified properties.
* @param [properties] Properties to set
* @returns Result instance
*/
public static create(properties?: arrow.flight.protocol.IResult): arrow.flight.protocol.Result;
/**
* Encodes the specified Result message. Does not implicitly {@link arrow.flight.protocol.Result.verify|verify} messages.
* @param message Result message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: arrow.flight.protocol.IResult, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified Result message, length delimited. Does not implicitly {@link arrow.flight.protocol.Result.verify|verify} messages.
* @param message Result message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: arrow.flight.protocol.IResult, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a Result message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns Result
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): arrow.flight.protocol.Result;
/**
* Decodes a Result message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns Result
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): arrow.flight.protocol.Result;
/**
* Verifies a Result message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a Result message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns Result
*/
public static fromObject(object: { [k: string]: any }): arrow.flight.protocol.Result;
/**
* Creates a plain object from a Result message. Also converts values to other types if specified.
* @param message Result
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: arrow.flight.pro