Class ConnectionsClient

Index

Constructors

Methods

createConnection deleteConnection getConnection listConnections listConnectionsIter updateConnection

Constructors

constructor

new ConnectionsClient(options: ClientOptions): ConnectionsClient
Parameters
- options: ClientOptions
Returns ConnectionsClient
- Defined in client.ts:55

Methods

createConnection

createConnection(
req: CreateConnectionRequest,
options?: CallOptions,
): Promise<ConnectionInfo>
Creates a new connection

Creates a new connection to an external data source. It allows users to specify connection details and configurations for interaction with the external server.
Parameters
- req: CreateConnectionRequest
- Optionaloptions: CallOptions
Returns Promise<ConnectionInfo>
- Defined in client.ts:76

deleteConnection

deleteConnection(
req: DeleteConnectionRequest,
options?: CallOptions,
): Promise<DeleteConnectionResponse>
Deletes the connection that matches the supplied name.
Parameters
- req: DeleteConnectionRequest
- Optionaloptions: CallOptions
Returns Promise<DeleteConnectionResponse>
- Defined in client.ts:106

getConnection

getConnection(
req: GetConnectionRequest,
options?: CallOptions,
): Promise<ConnectionInfo>
Gets a connection from it's name.
Parameters
- req: GetConnectionRequest
- Optionaloptions: CallOptions
Returns Promise<ConnectionInfo>
- Defined in client.ts:135

listConnections

listConnections(
req: ListConnectionsRequest,
options?: CallOptions,
): Promise<ListConnectionsResponse>
List all connections.

NOTE: we recommend using max_results=0 to use the paginated version of this API. Unpaginated calls will be deprecated soon.

PAGINATION BEHAVIOR: When using pagination (max_results >= 0), a page may contain zero results while still providing a next_page_token. Clients must continue reading pages until next_page_token is absent, which is the only indication that the end of results has been reached.
Parameters
- req: ListConnectionsRequest
- Optionaloptions: CallOptions
Returns Promise<ListConnectionsResponse>
- Defined in client.ts:171

listConnectionsIter

listConnectionsIter(
req: ListConnectionsRequest,
options?: CallOptions,
): AsyncGenerator<ConnectionInfo>
Parameters
- req: ListConnectionsRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<ConnectionInfo>
- Defined in client.ts:208

updateConnection

updateConnection(
req: UpdateConnectionRequest,
options?: CallOptions,
): Promise<ConnectionInfo>
Updates the connection that matches the supplied name.
Parameters
- req: UpdateConnectionRequest
- Optionaloptions: CallOptions
Returns Promise<ConnectionInfo>
- Defined in client.ts:226