Interface ISourcesService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface ISourcesService : IApiAccessor

Methods

DeleteSourcesID(String, String)

Delete a source

Declaration

void DeleteSourcesID(string sourceID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteSourcesIDAsync(String, String, CancellationToken)

Delete a source

Declaration

System.Threading.Tasks.Task DeleteSourcesIDAsync(string sourceID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task	Task of void

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteSourcesIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a source

Declaration

System.Threading.Tasks.Task<ApiResponse<object>> DeleteSourcesIDAsyncWithHttpInfo(string sourceID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.Object>>	Task of ApiResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

DeleteSourcesIDWithHttpInfo(String, String)

Delete a source

Declaration

ApiResponse<object> DeleteSourcesIDWithHttpInfo(string sourceID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.Object>	ApiResponse of Object(void)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSources(String, String)

List all sources

Declaration

Sources GetSources(string zapTraceSpan = null, string org = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)

Returns

Type	Description
Sources	Sources

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesAsync(String, String, CancellationToken)

List all sources

Declaration

System.Threading.Tasks.Task<Sources> GetSourcesAsync(string zapTraceSpan = null, string org = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Sources>	Task of Sources

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesAsyncWithHttpInfo(String, String, CancellationToken)

List all sources

Declaration

System.Threading.Tasks.Task<ApiResponse<Sources>> GetSourcesAsyncWithHttpInfo(string zapTraceSpan = null, string org = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Sources>>	Task of ApiResponse (Sources)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesID(String, String)

Retrieve a source

Declaration

Source GetSourcesID(string sourceID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Source	Source

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDAsync(String, String, CancellationToken)

Retrieve a source

Declaration

System.Threading.Tasks.Task<Source> GetSourcesIDAsync(string sourceID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Source>	Task of Source

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a source

Declaration

System.Threading.Tasks.Task<ApiResponse<Source>> GetSourcesIDAsyncWithHttpInfo(string sourceID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Source>>	Task of ApiResponse (Source)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDBuckets(String, String, String)

Get buckets in a source

Declaration

Buckets GetSourcesIDBuckets(string sourceID, string zapTraceSpan = null, string org = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)

Returns

Type	Description
Buckets	Buckets

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDBucketsAsync(String, String, String, CancellationToken)

Get buckets in a source

Declaration

System.Threading.Tasks.Task<Buckets> GetSourcesIDBucketsAsync(string sourceID, string zapTraceSpan = null, string org = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Buckets>	Task of Buckets

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDBucketsAsyncWithHttpInfo(String, String, String, CancellationToken)

Get buckets in a source

Declaration

System.Threading.Tasks.Task<ApiResponse<Buckets>> GetSourcesIDBucketsAsyncWithHttpInfo(string sourceID, string zapTraceSpan = null, string org = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Buckets>>	Task of ApiResponse (Buckets)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDBucketsWithHttpInfo(String, String, String)

Get buckets in a source

Declaration

ApiResponse<Buckets> GetSourcesIDBucketsWithHttpInfo(string sourceID, string zapTraceSpan = null, string org = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Buckets>	ApiResponse of Buckets

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDHealth(String, String)

Get the health of a source

Declaration

HealthCheck GetSourcesIDHealth(string sourceID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
HealthCheck	HealthCheck

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDHealthAsync(String, String, CancellationToken)

Get the health of a source

Declaration

System.Threading.Tasks.Task<HealthCheck> GetSourcesIDHealthAsync(string sourceID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<HealthCheck>	Task of HealthCheck

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDHealthAsyncWithHttpInfo(String, String, CancellationToken)

Get the health of a source

Declaration

System.Threading.Tasks.Task<ApiResponse<HealthCheck>> GetSourcesIDHealthAsyncWithHttpInfo(string sourceID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<HealthCheck>>	Task of ApiResponse (HealthCheck)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDHealthWithHttpInfo(String, String)

Get the health of a source

Declaration

ApiResponse<HealthCheck> GetSourcesIDHealthWithHttpInfo(string sourceID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<HealthCheck>	ApiResponse of HealthCheck

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesIDWithHttpInfo(String, String)

Retrieve a source

Declaration

ApiResponse<Source> GetSourcesIDWithHttpInfo(string sourceID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Source>	ApiResponse of Source

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetSourcesWithHttpInfo(String, String)

List all sources

Declaration

ApiResponse<Sources> GetSourcesWithHttpInfo(string zapTraceSpan = null, string org = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	org	The name of the organization. (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Sources>	ApiResponse of Sources

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchSourcesID(String, Source, String)

Update a Source

Declaration

Source PatchSourcesID(string sourceID, Source source, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
Source	source	Source update
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Source	Source

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchSourcesIDAsync(String, Source, String, CancellationToken)

Update a Source

Declaration

System.Threading.Tasks.Task<Source> PatchSourcesIDAsync(string sourceID, Source source, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
Source	source	Source update
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Source>	Task of Source

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchSourcesIDAsyncWithHttpInfo(String, Source, String, CancellationToken)

Update a Source

Declaration

System.Threading.Tasks.Task<ApiResponse<Source>> PatchSourcesIDAsyncWithHttpInfo(string sourceID, Source source, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
Source	source	Source update
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Source>>	Task of ApiResponse (Source)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PatchSourcesIDWithHttpInfo(String, Source, String)

Update a Source

Declaration

ApiResponse<Source> PatchSourcesIDWithHttpInfo(string sourceID, Source source, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	sourceID	The source ID.
Source	source	Source update
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Source>	ApiResponse of Source

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostSources(Source, String)

Create a source

Declaration

Source PostSources(Source source, string zapTraceSpan = null)

Parameters

Type	Name	Description
Source	source	Source to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Source	Source

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostSourcesAsync(Source, String, CancellationToken)

Create a source

Declaration

System.Threading.Tasks.Task<Source> PostSourcesAsync(Source source, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Source	source	Source to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<Source>	Task of Source

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostSourcesAsyncWithHttpInfo(Source, String, CancellationToken)

Create a source

Declaration

System.Threading.Tasks.Task<ApiResponse<Source>> PostSourcesAsyncWithHttpInfo(Source source, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
Source	source	Source to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<Source>>	Task of ApiResponse (Source)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostSourcesWithHttpInfo(Source, String)

Create a source

Declaration

ApiResponse<Source> PostSourcesWithHttpInfo(Source source, string zapTraceSpan = null)

Parameters

Type	Name	Description
Source	source	Source to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<Source>	ApiResponse of Source

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call