ConnectionsApi class

Constructors

ConnectionsApi([ApiClient? apiClient])

Properties

apiClient → ApiClient

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createConnections(String companyId, ConnectionsInput connectionsInput, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<CreateConnections200Response?>

Create a new connection by ID

createConnectionsWithHttpInfo(String companyId, ConnectionsInput connectionsInput, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<Response>

Create a new connection by ID

deleteConnections(String companyId, String connectionId) → Future<DeleteConnections200Response?>

Delete single connection by ID

deleteConnectionsWithHttpInfo(String companyId, String connectionId) → Future<Response>

Delete single connection by ID

getConnectionsById(String companyId, String connectionId) → Future<GetConnectionsById200Response?>

Get single connection by ID

getConnectionsById2(String companyId, String connectionId) → Future<GetConnectionsById200Response?>

Test the specified connection

getConnectionsById2WithHttpInfo(String companyId, String connectionId) → Future<Response>

Test the specified connection

getConnectionsByIdInfoschema(String companyId, String connectionId) → Future<GetConnectionsById200Response?>

Retrieve the information schema for the specified connection

getConnectionsByIdInfoschemaWithHttpInfo(String companyId, String connectionId) → Future<Response>

Retrieve the information schema for the specified connection

getConnectionsByIdSampleData(String companyId, String connectionId) → Future<GetConnectionsById200Response?>

Get a randomized sample of rows from a table on this connection. Used by the visualization editor to give sellers data to author against. Query Parameters: schema_name (required): Schema/dataset name table_name (required): Table name limit (optional): Max rows to return (default 1000, max 10000) Returns columnar data — {column_name: values} — ready for Plotly's dataSources prop. The actual chart at render time will pull fresh data via the asset's saved SQL; this is only for authoring preview.

getConnectionsByIdSampleDataWithHttpInfo(String companyId, String connectionId) → Future<Response>

Get a randomized sample of rows from a table on this connection. Used by the visualization editor to give sellers data to author against. Query Parameters: schema_name (required): Schema/dataset name table_name (required): Table name limit (optional): Max rows to return (default 1000, max 10000) Returns columnar data — {column_name: values} — ready for Plotly's dataSources prop. The actual chart at render time will pull fresh data via the asset's saved SQL; this is only for authoring preview.

getConnectionsByIdWithHttpInfo(String companyId, String connectionId) → Future<Response>

Get single connection by ID

listConnections(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<ListConnections200Response?>

Get all connections for a specific company

listConnectionsWithHttpInfo(String companyId, {int? page, int? limit, String? sortBy, String? sortOrder, String? search}) → Future<Response>

Get all connections for a specific company

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

updateConnections(String companyId, String connectionId, ConnectionsUpdate connectionsUpdate) → Future<UpdateConnections200Response?>

Update an existing connection by ID

updateConnectionsWithHttpInfo(String companyId, String connectionId, ConnectionsUpdate connectionsUpdate) → Future<Response>

Update an existing connection by ID

Operators

operator ==(Object other) → bool

The equality operator.

inherited