Class SourcesClient

Namespace

Nexus.Api.V1

Assembly

Nexus.Api.dll

Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.

public class SourcesClient : ISourcesClient

Inheritance

object

SourcesClient

Implements

ISourcesClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

CreatePipeline(DataSourcePipeline)

Creates a data source pipeline.

public Guid CreatePipeline(DataSourcePipeline pipeline)

Parameters

pipeline DataSourcePipeline

The pipeline to create.

Returns

Guid

CreatePipelineAsync(DataSourcePipeline, CancellationToken)

Creates a data source pipeline.

public Task<Guid> CreatePipelineAsync(DataSourcePipeline pipeline, CancellationToken cancellationToken = default)

Parameters

pipeline DataSourcePipeline

The pipeline to create.

cancellationToken CancellationToken

The token to cancel the current operation.

Returns

Task<Guid>

DeletePipeline(Guid)

Deletes a data source pipeline.

public HttpResponseMessage DeletePipeline(Guid pipelineId)

Parameters

pipelineId Guid

The identifier of the pipeline to delete.

Returns

HttpResponseMessage

DeletePipelineAsync(Guid, CancellationToken)

Deletes a data source pipeline.

public Task<HttpResponseMessage> DeletePipelineAsync(Guid pipelineId, CancellationToken cancellationToken = default)

Parameters

pipelineId Guid

The identifier of the pipeline to delete.

cancellationToken CancellationToken

The token to cancel the current operation.

Returns

Task<HttpResponseMessage>

GetDescriptions()

Gets the list of source descriptions.

public IReadOnlyList<ExtensionDescription> GetDescriptions()

Returns

IReadOnlyList<ExtensionDescription>

GetDescriptionsAsync(CancellationToken)

Gets the list of source descriptions.

public Task<IReadOnlyList<ExtensionDescription>> GetDescriptionsAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The token to cancel the current operation.

Returns

Task<IReadOnlyList<ExtensionDescription>>

GetPipelines()

Gets the list of data source pipelines.

public IReadOnlyDictionary<string, DataSourcePipeline> GetPipelines()

Returns

IReadOnlyDictionary<string, DataSourcePipeline>

GetPipelinesAsync(CancellationToken)

Gets the list of data source pipelines.

public Task<IReadOnlyDictionary<string, DataSourcePipeline>> GetPipelinesAsync(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

The token to cancel the current operation.

Returns

Task<IReadOnlyDictionary<string, DataSourcePipeline>>

UpdatePipeline(Guid, DataSourcePipeline)

Updates a data source pipeline.

public HttpResponseMessage UpdatePipeline(Guid pipelineId, DataSourcePipeline pipeline)

Parameters

pipelineId Guid

The identifier of the pipeline to update.

pipeline DataSourcePipeline

The new pipeline.

Returns

HttpResponseMessage

UpdatePipelineAsync(Guid, DataSourcePipeline, CancellationToken)

Updates a data source pipeline.

public Task<HttpResponseMessage> UpdatePipelineAsync(Guid pipelineId, DataSourcePipeline pipeline, CancellationToken cancellationToken = default)

Parameters

pipelineId Guid

The identifier of the pipeline to update.

pipeline DataSourcePipeline

The new pipeline.

cancellationToken CancellationToken

The token to cancel the current operation.

Returns

Task<HttpResponseMessage>