Interface IDataClient

Namespace

Nexus.Api.V2

Assembly

Nexus.Api.dll

Provides methods to interact with data.

public interface IDataClient

Methods

GetStream(BatchStreamRequest)

Streams multiple resources in an Apache Arrow IPC response.

HttpResponseMessage GetStream(BatchStreamRequest request)

Parameters

request BatchStreamRequest

The batch stream request.

Returns

HttpResponseMessage

GetStreamAsync(BatchStreamRequest, CancellationToken)

Streams multiple resources in an Apache Arrow IPC response.

Task<HttpResponseMessage> GetStreamAsync(BatchStreamRequest request, CancellationToken cancellationToken = default)

Parameters

request BatchStreamRequest

The batch stream request.

cancellationToken CancellationToken

The token to cancel the current operation.

Returns

Task<HttpResponseMessage>

GetVisualization(VisualizationRequest)

Streams bounded Float32 visualization points and progress using a versioned Arrow schema.

HttpResponseMessage GetVisualization(VisualizationRequest request)

Parameters

request VisualizationRequest

The domain, resources, and one to three replacement views, typically overview, main viewport, and optional detail viewport.

Returns

HttpResponseMessage

GetVisualizationAsync(VisualizationRequest, CancellationToken)

Streams bounded Float32 visualization points and progress using a versioned Arrow schema.

Task<HttpResponseMessage> GetVisualizationAsync(VisualizationRequest request, CancellationToken cancellationToken = default)

Parameters

request VisualizationRequest

The domain, resources, and one to three replacement views, typically overview, main viewport, and optional detail viewport.

cancellationToken CancellationToken

The token to cancel the current operation.

Returns

Task<HttpResponseMessage>