Class SourcesService
Represents a collection of functions to interact with the API endpoints
Inheritance
Implements
Namespace: InfluxDB.Client.Api.Service
Assembly: InfluxDB.Client.dll
Syntax
public class SourcesService : object, ISourcesService, IApiAccessor
Constructors
SourcesService(Configuration)
Initializes a new instance of the SourcesService class using Configuration object
Declaration
public SourcesService(Configuration configuration = null)
Parameters
Type | Name | Description |
---|---|---|
InfluxDB.Client.Api.Client.Configuration | configuration | An instance of Configuration |
SourcesService(String)
Initializes a new instance of the SourcesService class.
Declaration
public SourcesService(string basePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | basePath |
Properties
Configuration
Gets or sets the configuration object
Declaration
public Configuration Configuration { get; set; }
Property Value
Type | Description |
---|---|
InfluxDB.Client.Api.Client.Configuration | An instance of the Configuration |
ExceptionFactory
Provides a factory method hook for the creation of exceptions.
Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type | Description |
---|---|
InfluxDB.Client.Api.Client.ExceptionFactory |
Methods
AddDefaultHeader(String, String)
Add default header.
Declaration
public void AddDefaultHeader(string key, string value)
Parameters
Type | Name | Description |
---|---|---|
System.String | key | Header field name. |
System.String | value | Header field value. |
DefaultHeader()
Gets the default header.
Declaration
public IDictionary<string, string> DefaultHeader()
Returns
Type | Description |
---|---|
IDictionary<System.String, System.String> | Dictionary of HTTP header |
DeleteSourcesID(String, String)
Delete a source
Declaration
public 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
public 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
public async 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 |
DeleteSourcesIDAsyncWithIRestResponse(String, String, CancellationToken)
Delete a source
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteSourcesIDAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteSourcesIDWithHttpInfo(String, String)
Delete a source
Declaration
public 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 |
DeleteSourcesIDWithIRestResponse(String, String)
Delete a source
Declaration
public RestResponse DeleteSourcesIDWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteSourcesIDWithIRestResponseAsync(String, String, CancellationToken)
Delete a source
Declaration
public async System.Threading.Tasks.Task<RestResponse> DeleteSourcesIDWithIRestResponseAsync(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<RestResponse> | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
DeleteSourcesIDWithRestRequest(String, String)
Delete a source
Declaration
public RestRequest DeleteSourcesIDWithRestRequest(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 |
---|---|
RestRequest | ApiResponse of Object(void) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
System.String | The base path |
GetSources(String, String)
List all sources
Declaration
public 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
public async 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
public async 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 |
GetSourcesAsyncWithIRestResponse(String, String, CancellationToken)
List all sources
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetSourcesAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (Sources) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetSourcesID(String, String)
Retrieve a source
Declaration
public 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
public async 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
public async 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 |
GetSourcesIDAsyncWithIRestResponse(String, String, CancellationToken)
Retrieve a source
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetSourcesIDAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (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
public 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
public async 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
public async 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 |
GetSourcesIDBucketsAsyncWithIRestResponse(String, String, String, CancellationToken)
Get buckets in a source
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetSourcesIDBucketsAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (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
public 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 |
GetSourcesIDBucketsWithIRestResponse(String, String, String)
Get buckets in a source
Declaration
public RestResponse GetSourcesIDBucketsWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of Buckets |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetSourcesIDBucketsWithIRestResponseAsync(String, String, String, CancellationToken)
Get buckets in a source
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetSourcesIDBucketsWithIRestResponseAsync(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<RestResponse> | ApiResponse of Buckets |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetSourcesIDBucketsWithRestRequest(String, String, String)
Get buckets in a source
Declaration
public RestRequest GetSourcesIDBucketsWithRestRequest(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 |
---|---|
RestRequest | 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
public 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
public async 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
public async 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 |
GetSourcesIDHealthAsyncWithIRestResponse(String, String, CancellationToken)
Get the health of a source
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetSourcesIDHealthAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (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
public 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 |
GetSourcesIDHealthWithIRestResponse(String, String)
Get the health of a source
Declaration
public RestResponse GetSourcesIDHealthWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of HealthCheck |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetSourcesIDHealthWithIRestResponseAsync(String, String, CancellationToken)
Get the health of a source
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetSourcesIDHealthWithIRestResponseAsync(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<RestResponse> | ApiResponse of HealthCheck |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetSourcesIDHealthWithRestRequest(String, String)
Get the health of a source
Declaration
public RestRequest GetSourcesIDHealthWithRestRequest(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 |
---|---|
RestRequest | 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
public 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 |
GetSourcesIDWithIRestResponse(String, String)
Retrieve a source
Declaration
public RestResponse GetSourcesIDWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of Source |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetSourcesIDWithIRestResponseAsync(String, String, CancellationToken)
Retrieve a source
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetSourcesIDWithIRestResponseAsync(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<RestResponse> | ApiResponse of Source |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetSourcesIDWithRestRequest(String, String)
Retrieve a source
Declaration
public RestRequest GetSourcesIDWithRestRequest(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 |
---|---|
RestRequest | 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
public 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 |
GetSourcesWithIRestResponse(String, String)
List all sources
Declaration
public RestResponse GetSourcesWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of Sources |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetSourcesWithIRestResponseAsync(String, String, CancellationToken)
List all sources
Declaration
public async System.Threading.Tasks.Task<RestResponse> GetSourcesWithIRestResponseAsync(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<RestResponse> | ApiResponse of Sources |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
GetSourcesWithRestRequest(String, String)
List all sources
Declaration
public RestRequest GetSourcesWithRestRequest(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 |
---|---|
RestRequest | 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
public 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
public async 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
public async 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 |
PatchSourcesIDAsyncWithIRestResponse(String, Source, String, CancellationToken)
Update a Source
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchSourcesIDAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (Source) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchSourcesIDWithHttpInfo(String, Source, String)
Update a Source
Declaration
public 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 |
PatchSourcesIDWithIRestResponse(String, Source, String)
Update a Source
Declaration
public RestResponse PatchSourcesIDWithIRestResponse(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 |
---|---|
RestResponse | ApiResponse of Source |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchSourcesIDWithIRestResponseAsync(String, Source, String, CancellationToken)
Update a Source
Declaration
public async System.Threading.Tasks.Task<RestResponse> PatchSourcesIDWithIRestResponseAsync(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<RestResponse> | ApiResponse of Source |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PatchSourcesIDWithRestRequest(String, Source, String)
Update a Source
Declaration
public RestRequest PatchSourcesIDWithRestRequest(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 |
---|---|
RestRequest | 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
public 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
public async 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
public async 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 |
PostSourcesAsyncWithIRestResponse(Source, String, CancellationToken)
Create a source
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostSourcesAsyncWithIRestResponse(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<RestResponse> | Task of RestResponse (Source) |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostSourcesWithHttpInfo(Source, String)
Create a source
Declaration
public 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 |
PostSourcesWithIRestResponse(Source, String)
Create a source
Declaration
public RestResponse PostSourcesWithIRestResponse(Source source, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
Source | source | Source to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestResponse | ApiResponse of Source |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostSourcesWithIRestResponseAsync(Source, String, CancellationToken)
Create a source
Declaration
public async System.Threading.Tasks.Task<RestResponse> PostSourcesWithIRestResponseAsync(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<RestResponse> | ApiResponse of Source |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
PostSourcesWithRestRequest(Source, String)
Create a source
Declaration
public RestRequest PostSourcesWithRestRequest(Source source, string zapTraceSpan = null)
Parameters
Type | Name | Description |
---|---|---|
Source | source | Source to create |
System.String | zapTraceSpan | OpenTracing span context (optional) |
Returns
Type | Description |
---|---|
RestRequest | ApiResponse of Source |
Exceptions
Type | Condition |
---|---|
InfluxDB.Client.Api.Client.ApiException | Thrown when fails to make API call |
SetBasePath(String)
Sets the base path of the API client.
Declaration
public void SetBasePath(string basePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | basePath |