Class BucketsService

Represents a collection of functions to interact with the API endpoints

Inheritance

System.Object

BucketsService

Implements

IBucketsService

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public class BucketsService : object, IBucketsService, IApiAccessor

Constructors

BucketsService(Configuration)

Initializes a new instance of the BucketsService class using Configuration object

Declaration

public BucketsService(Configuration configuration = null)

Parameters

Type	Name	Description
InfluxDB.Client.Api.Client.Configuration	configuration	An instance of Configuration

BucketsService(String)

Initializes a new instance of the BucketsService class.

Declaration

public BucketsService(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

DeleteBucketsID(String, String)

Delete a bucket

Declaration

public void DeleteBucketsID(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The ID of the bucket to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

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

DeleteBucketsIDAsync(String, String, CancellationToken)

Delete a bucket

Declaration

public System.Threading.Tasks.Task DeleteBucketsIDAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The ID of the bucket to delete.
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

DeleteBucketsIDAsyncWithHttpInfo(String, String, CancellationToken)

Delete a bucket

Declaration

public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteBucketsIDAsyncWithHttpInfo(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The ID of the bucket to delete.
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

DeleteBucketsIDAsyncWithIRestResponse(String, String, CancellationToken)

Delete a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteBucketsIDAsyncWithIRestResponse(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The ID of the bucket to delete.
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

DeleteBucketsIDLabelsID(String, String, String)

Delete a label from a bucket

Declaration

public void DeleteBucketsIDLabelsID(string bucketID, string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	labelID	The ID of the label to delete.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

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

DeleteBucketsIDLabelsIDAsync(String, String, String, CancellationToken)

Delete a label from a bucket

Declaration

public System.Threading.Tasks.Task DeleteBucketsIDLabelsIDAsync(string bucketID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	labelID	The ID of the label to delete.
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

DeleteBucketsIDLabelsIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Delete a label from a bucket

Declaration

public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteBucketsIDLabelsIDAsyncWithHttpInfo(string bucketID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	labelID	The ID of the label to delete.
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

DeleteBucketsIDLabelsIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Delete a label from a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteBucketsIDLabelsIDAsyncWithIRestResponse(string bucketID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	labelID	The ID of the label to delete.
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

DeleteBucketsIDLabelsIDWithHttpInfo(String, String, String)

Delete a label from a bucket

Declaration

public ApiResponse<object> DeleteBucketsIDLabelsIDWithHttpInfo(string bucketID, string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	labelID	The ID of the label to delete.
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

DeleteBucketsIDLabelsIDWithIRestResponse(String, String, String)

Delete a label from a bucket

Declaration

public RestResponse DeleteBucketsIDLabelsIDWithIRestResponse(string bucketID, string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	labelID	The ID of the label to delete.
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

DeleteBucketsIDLabelsIDWithIRestResponseAsync(String, String, String, CancellationToken)

Delete a label from a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteBucketsIDLabelsIDWithIRestResponseAsync(string bucketID, string labelID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	labelID	The ID of the label to delete.
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

DeleteBucketsIDLabelsIDWithRestRequest(String, String, String)

Delete a label from a bucket

Declaration

public RestRequest DeleteBucketsIDLabelsIDWithRestRequest(string bucketID, string labelID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	labelID	The ID of the label to delete.
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

DeleteBucketsIDMembersID(String, String, String)

Remove a member from a bucket

Declaration

public void DeleteBucketsIDMembersID(string userID, string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the member to remove.
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

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

DeleteBucketsIDMembersIDAsync(String, String, String, CancellationToken)

Remove a member from a bucket

Declaration

public System.Threading.Tasks.Task DeleteBucketsIDMembersIDAsync(string userID, string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the member to remove.
System.String	bucketID	The bucket 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

DeleteBucketsIDMembersIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Remove a member from a bucket

Declaration

public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteBucketsIDMembersIDAsyncWithHttpInfo(string userID, string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the member to remove.
System.String	bucketID	The bucket 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

DeleteBucketsIDMembersIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Remove a member from a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteBucketsIDMembersIDAsyncWithIRestResponse(string userID, string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the member to remove.
System.String	bucketID	The bucket 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

DeleteBucketsIDMembersIDWithHttpInfo(String, String, String)

Remove a member from a bucket

Declaration

public ApiResponse<object> DeleteBucketsIDMembersIDWithHttpInfo(string userID, string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the member to remove.
System.String	bucketID	The bucket 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

DeleteBucketsIDMembersIDWithIRestResponse(String, String, String)

Remove a member from a bucket

Declaration

public RestResponse DeleteBucketsIDMembersIDWithIRestResponse(string userID, string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the member to remove.
System.String	bucketID	The bucket 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

DeleteBucketsIDMembersIDWithIRestResponseAsync(String, String, String, CancellationToken)

Remove a member from a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteBucketsIDMembersIDWithIRestResponseAsync(string userID, string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the member to remove.
System.String	bucketID	The bucket 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

DeleteBucketsIDMembersIDWithRestRequest(String, String, String)

Remove a member from a bucket

Declaration

public RestRequest DeleteBucketsIDMembersIDWithRestRequest(string userID, string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the member to remove.
System.String	bucketID	The bucket 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

DeleteBucketsIDOwnersID(String, String, String)

Remove an owner from a bucket

Declaration

public void DeleteBucketsIDOwnersID(string userID, string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the owner to remove.
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Exceptions

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

DeleteBucketsIDOwnersIDAsync(String, String, String, CancellationToken)

Remove an owner from a bucket

Declaration

public System.Threading.Tasks.Task DeleteBucketsIDOwnersIDAsync(string userID, string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the owner to remove.
System.String	bucketID	The bucket 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

DeleteBucketsIDOwnersIDAsyncWithHttpInfo(String, String, String, CancellationToken)

Remove an owner from a bucket

Declaration

public async System.Threading.Tasks.Task<ApiResponse<object>> DeleteBucketsIDOwnersIDAsyncWithHttpInfo(string userID, string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the owner to remove.
System.String	bucketID	The bucket 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

DeleteBucketsIDOwnersIDAsyncWithIRestResponse(String, String, String, CancellationToken)

Remove an owner from a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteBucketsIDOwnersIDAsyncWithIRestResponse(string userID, string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the owner to remove.
System.String	bucketID	The bucket 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

DeleteBucketsIDOwnersIDWithHttpInfo(String, String, String)

Remove an owner from a bucket

Declaration

public ApiResponse<object> DeleteBucketsIDOwnersIDWithHttpInfo(string userID, string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the owner to remove.
System.String	bucketID	The bucket 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

DeleteBucketsIDOwnersIDWithIRestResponse(String, String, String)

Remove an owner from a bucket

Declaration

public RestResponse DeleteBucketsIDOwnersIDWithIRestResponse(string userID, string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the owner to remove.
System.String	bucketID	The bucket 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

DeleteBucketsIDOwnersIDWithIRestResponseAsync(String, String, String, CancellationToken)

Remove an owner from a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteBucketsIDOwnersIDWithIRestResponseAsync(string userID, string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the owner to remove.
System.String	bucketID	The bucket 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

DeleteBucketsIDOwnersIDWithRestRequest(String, String, String)

Remove an owner from a bucket

Declaration

public RestRequest DeleteBucketsIDOwnersIDWithRestRequest(string userID, string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	userID	The ID of the owner to remove.
System.String	bucketID	The bucket 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

DeleteBucketsIDWithHttpInfo(String, String)

Delete a bucket

Declaration

public ApiResponse<object> DeleteBucketsIDWithHttpInfo(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The ID of the bucket to delete.
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

DeleteBucketsIDWithIRestResponse(String, String)

Delete a bucket

Declaration

public RestResponse DeleteBucketsIDWithIRestResponse(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The ID of the bucket to delete.
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

DeleteBucketsIDWithIRestResponseAsync(String, String, CancellationToken)

Delete a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> DeleteBucketsIDWithIRestResponseAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The ID of the bucket to delete.
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

DeleteBucketsIDWithRestRequest(String, String)

Delete a bucket

Declaration

public RestRequest DeleteBucketsIDWithRestRequest(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The ID of the bucket to delete.
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

GetBuckets(String, Nullable<Int32>, Nullable<Int32>, String, String, String, String, String)

List all buckets

Declaration

public Buckets GetBuckets(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string org = null, string orgID = null, string name = null, string id = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
System.String	name	Only returns buckets with a specific name. (optional)
System.String	id	Only returns buckets with a specific ID. (optional)

Returns

Type	Description
Buckets	Buckets

Exceptions

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

GetBucketsAsync(String, Nullable<Int32>, Nullable<Int32>, String, String, String, String, String, CancellationToken)

List all buckets

Declaration

public async System.Threading.Tasks.Task<Buckets> GetBucketsAsync(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string org = null, string orgID = null, string name = null, string id = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
System.String	name	Only returns buckets with a specific name. (optional)
System.String	id	Only returns buckets with a specific ID. (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

GetBucketsAsyncWithHttpInfo(String, Nullable<Int32>, Nullable<Int32>, String, String, String, String, String, CancellationToken)

List all buckets

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Buckets>> GetBucketsAsyncWithHttpInfo(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string org = null, string orgID = null, string name = null, string id = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
System.String	name	Only returns buckets with a specific name. (optional)
System.String	id	Only returns buckets with a specific ID. (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

GetBucketsAsyncWithIRestResponse(String, Nullable<Int32>, Nullable<Int32>, String, String, String, String, String, CancellationToken)

List all buckets

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetBucketsAsyncWithIRestResponse(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string org = null, string orgID = null, string name = null, string id = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
System.String	name	Only returns buckets with a specific name. (optional)
System.String	id	Only returns buckets with a specific ID. (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

GetBucketsID(String, String)

Retrieve a bucket

Declaration

public Bucket GetBucketsID(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Bucket	Bucket

Exceptions

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

GetBucketsIDAsync(String, String, CancellationToken)

Retrieve a bucket

Declaration

public async System.Threading.Tasks.Task<Bucket> GetBucketsIDAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

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

Exceptions

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

GetBucketsIDAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve a bucket

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Bucket>> GetBucketsIDAsyncWithHttpInfo(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

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

Exceptions

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

GetBucketsIDAsyncWithIRestResponse(String, String, CancellationToken)

Retrieve a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetBucketsIDAsyncWithIRestResponse(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (Bucket)

Exceptions

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

GetBucketsIDLabels(String, String)

List all labels for a bucket

Declaration

public LabelsResponse GetBucketsIDLabels(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
LabelsResponse	LabelsResponse

Exceptions

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

GetBucketsIDLabelsAsync(String, String, CancellationToken)

List all labels for a bucket

Declaration

public async System.Threading.Tasks.Task<LabelsResponse> GetBucketsIDLabelsAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

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

Exceptions

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

GetBucketsIDLabelsAsyncWithHttpInfo(String, String, CancellationToken)

List all labels for a bucket

Declaration

public async System.Threading.Tasks.Task<ApiResponse<LabelsResponse>> GetBucketsIDLabelsAsyncWithHttpInfo(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

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

Exceptions

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

GetBucketsIDLabelsAsyncWithIRestResponse(String, String, CancellationToken)

List all labels for a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetBucketsIDLabelsAsyncWithIRestResponse(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (LabelsResponse)

Exceptions

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

GetBucketsIDLabelsWithHttpInfo(String, String)

List all labels for a bucket

Declaration

public ApiResponse<LabelsResponse> GetBucketsIDLabelsWithHttpInfo(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

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

Exceptions

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

GetBucketsIDLabelsWithIRestResponse(String, String)

List all labels for a bucket

Declaration

public RestResponse GetBucketsIDLabelsWithIRestResponse(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of LabelsResponse

Exceptions

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

GetBucketsIDLabelsWithIRestResponseAsync(String, String, CancellationToken)

List all labels for a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetBucketsIDLabelsWithIRestResponseAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of LabelsResponse

Exceptions

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

GetBucketsIDLabelsWithRestRequest(String, String)

List all labels for a bucket

Declaration

public RestRequest GetBucketsIDLabelsWithRestRequest(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of LabelsResponse

Exceptions

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

GetBucketsIDMembers(String, String)

List all users with member privileges for a bucket

Declaration

public ResourceMembers GetBucketsIDMembers(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
ResourceMembers	ResourceMembers

Exceptions

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

GetBucketsIDMembersAsync(String, String, CancellationToken)

List all users with member privileges for a bucket

Declaration

public async System.Threading.Tasks.Task<ResourceMembers> GetBucketsIDMembersAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

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

Exceptions

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

GetBucketsIDMembersAsyncWithHttpInfo(String, String, CancellationToken)

List all users with member privileges for a bucket

Declaration

public async System.Threading.Tasks.Task<ApiResponse<ResourceMembers>> GetBucketsIDMembersAsyncWithHttpInfo(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

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

Exceptions

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

GetBucketsIDMembersAsyncWithIRestResponse(String, String, CancellationToken)

List all users with member privileges for a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetBucketsIDMembersAsyncWithIRestResponse(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (ResourceMembers)

Exceptions

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

GetBucketsIDMembersWithHttpInfo(String, String)

List all users with member privileges for a bucket

Declaration

public ApiResponse<ResourceMembers> GetBucketsIDMembersWithHttpInfo(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

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

Exceptions

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

GetBucketsIDMembersWithIRestResponse(String, String)

List all users with member privileges for a bucket

Declaration

public RestResponse GetBucketsIDMembersWithIRestResponse(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of ResourceMembers

Exceptions

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

GetBucketsIDMembersWithIRestResponseAsync(String, String, CancellationToken)

List all users with member privileges for a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetBucketsIDMembersWithIRestResponseAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of ResourceMembers

Exceptions

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

GetBucketsIDMembersWithRestRequest(String, String)

List all users with member privileges for a bucket

Declaration

public RestRequest GetBucketsIDMembersWithRestRequest(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of ResourceMembers

Exceptions

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

GetBucketsIDOwners(String, String)

List all owners of a bucket

Declaration

public ResourceOwners GetBucketsIDOwners(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
ResourceOwners	ResourceOwners

Exceptions

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

GetBucketsIDOwnersAsync(String, String, CancellationToken)

List all owners of a bucket

Declaration

public async System.Threading.Tasks.Task<ResourceOwners> GetBucketsIDOwnersAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

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

Exceptions

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

GetBucketsIDOwnersAsyncWithHttpInfo(String, String, CancellationToken)

List all owners of a bucket

Declaration

public async System.Threading.Tasks.Task<ApiResponse<ResourceOwners>> GetBucketsIDOwnersAsyncWithHttpInfo(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

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

Exceptions

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

GetBucketsIDOwnersAsyncWithIRestResponse(String, String, CancellationToken)

List all owners of a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetBucketsIDOwnersAsyncWithIRestResponse(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (ResourceOwners)

Exceptions

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

GetBucketsIDOwnersWithHttpInfo(String, String)

List all owners of a bucket

Declaration

public ApiResponse<ResourceOwners> GetBucketsIDOwnersWithHttpInfo(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

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

Exceptions

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

GetBucketsIDOwnersWithIRestResponse(String, String)

List all owners of a bucket

Declaration

public RestResponse GetBucketsIDOwnersWithIRestResponse(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of ResourceOwners

Exceptions

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

GetBucketsIDOwnersWithIRestResponseAsync(String, String, CancellationToken)

List all owners of a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetBucketsIDOwnersWithIRestResponseAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of ResourceOwners

Exceptions

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

GetBucketsIDOwnersWithRestRequest(String, String)

List all owners of a bucket

Declaration

public RestRequest GetBucketsIDOwnersWithRestRequest(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of ResourceOwners

Exceptions

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

GetBucketsIDWithHttpInfo(String, String)

Retrieve a bucket

Declaration

public ApiResponse<Bucket> GetBucketsIDWithHttpInfo(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

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

Exceptions

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

GetBucketsIDWithIRestResponse(String, String)

Retrieve a bucket

Declaration

public RestResponse GetBucketsIDWithIRestResponse(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of Bucket

Exceptions

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

GetBucketsIDWithIRestResponseAsync(String, String, CancellationToken)

Retrieve a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetBucketsIDWithIRestResponseAsync(string bucketID, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

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

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Bucket

Exceptions

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

GetBucketsIDWithRestRequest(String, String)

Retrieve a bucket

Declaration

public RestRequest GetBucketsIDWithRestRequest(string bucketID, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of Bucket

Exceptions

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

GetBucketsWithHttpInfo(String, Nullable<Int32>, Nullable<Int32>, String, String, String, String, String)

List all buckets

Declaration

public ApiResponse<Buckets> GetBucketsWithHttpInfo(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string org = null, string orgID = null, string name = null, string id = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
System.String	name	Only returns buckets with a specific name. (optional)
System.String	id	Only returns buckets with a specific ID. (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

GetBucketsWithIRestResponse(String, Nullable<Int32>, Nullable<Int32>, String, String, String, String, String)

List all buckets

Declaration

public RestResponse GetBucketsWithIRestResponse(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string org = null, string orgID = null, string name = null, string id = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
System.String	name	Only returns buckets with a specific name. (optional)
System.String	id	Only returns buckets with a specific ID. (optional)

Returns

Type	Description
RestResponse	ApiResponse of Buckets

Exceptions

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

GetBucketsWithIRestResponseAsync(String, Nullable<Int32>, Nullable<Int32>, String, String, String, String, String, CancellationToken)

List all buckets

Declaration

public async System.Threading.Tasks.Task<RestResponse> GetBucketsWithIRestResponseAsync(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string org = null, string orgID = null, string name = null, string id = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
System.String	name	Only returns buckets with a specific name. (optional)
System.String	id	Only returns buckets with a specific ID. (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

GetBucketsWithRestRequest(String, Nullable<Int32>, Nullable<Int32>, String, String, String, String, String)

List all buckets

Declaration

public RestRequest GetBucketsWithRestRequest(string zapTraceSpan = null, int? offset = null, int? limit = null, string after = null, string org = null, string orgID = null, string name = null, string id = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.Nullable<System.Int32>	offset	(optional)
System.Nullable<System.Int32>	limit	(optional, default to 20)
System.String	after	Resource ID to seek from. Results are not inclusive of this ID. Use after instead of offset. (optional)
System.String	org	The name of the organization. (optional)
System.String	orgID	The organization ID. (optional)
System.String	name	Only returns buckets with a specific name. (optional)
System.String	id	Only returns buckets with a specific ID. (optional)

Returns

Type	Description
RestRequest	ApiResponse of Buckets

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

PatchBucketsID(String, PatchBucketRequest, String)

Update a bucket

Declaration

public Bucket PatchBucketsID(string bucketID, PatchBucketRequest patchBucketRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
PatchBucketRequest	patchBucketRequest	Bucket update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Bucket	Bucket

Exceptions

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

PatchBucketsIDAsync(String, PatchBucketRequest, String, CancellationToken)

Update a bucket

Declaration

public async System.Threading.Tasks.Task<Bucket> PatchBucketsIDAsync(string bucketID, PatchBucketRequest patchBucketRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
PatchBucketRequest	patchBucketRequest	Bucket update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PatchBucketsIDAsyncWithHttpInfo(String, PatchBucketRequest, String, CancellationToken)

Update a bucket

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Bucket>> PatchBucketsIDAsyncWithHttpInfo(string bucketID, PatchBucketRequest patchBucketRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
PatchBucketRequest	patchBucketRequest	Bucket update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PatchBucketsIDAsyncWithIRestResponse(String, PatchBucketRequest, String, CancellationToken)

Update a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> PatchBucketsIDAsyncWithIRestResponse(string bucketID, PatchBucketRequest patchBucketRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
PatchBucketRequest	patchBucketRequest	Bucket update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (Bucket)

Exceptions

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

PatchBucketsIDWithHttpInfo(String, PatchBucketRequest, String)

Update a bucket

Declaration

public ApiResponse<Bucket> PatchBucketsIDWithHttpInfo(string bucketID, PatchBucketRequest patchBucketRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
PatchBucketRequest	patchBucketRequest	Bucket update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

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

Exceptions

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

PatchBucketsIDWithIRestResponse(String, PatchBucketRequest, String)

Update a bucket

Declaration

public RestResponse PatchBucketsIDWithIRestResponse(string bucketID, PatchBucketRequest patchBucketRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
PatchBucketRequest	patchBucketRequest	Bucket update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of Bucket

Exceptions

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

PatchBucketsIDWithIRestResponseAsync(String, PatchBucketRequest, String, CancellationToken)

Update a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> PatchBucketsIDWithIRestResponseAsync(string bucketID, PatchBucketRequest patchBucketRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
PatchBucketRequest	patchBucketRequest	Bucket update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Bucket

Exceptions

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

PatchBucketsIDWithRestRequest(String, PatchBucketRequest, String)

Update a bucket

Declaration

public RestRequest PatchBucketsIDWithRestRequest(string bucketID, PatchBucketRequest patchBucketRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
PatchBucketRequest	patchBucketRequest	Bucket update to apply
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of Bucket

Exceptions

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

PostBuckets(PostBucketRequest, String)

Create a bucket

Declaration

public Bucket PostBuckets(PostBucketRequest postBucketRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
PostBucketRequest	postBucketRequest	Bucket to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
Bucket	Bucket

Exceptions

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

PostBucketsAsync(PostBucketRequest, String, CancellationToken)

Create a bucket

Declaration

public async System.Threading.Tasks.Task<Bucket> PostBucketsAsync(PostBucketRequest postBucketRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PostBucketRequest	postBucketRequest	Bucket to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PostBucketsAsyncWithHttpInfo(PostBucketRequest, String, CancellationToken)

Create a bucket

Declaration

public async System.Threading.Tasks.Task<ApiResponse<Bucket>> PostBucketsAsyncWithHttpInfo(PostBucketRequest postBucketRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PostBucketRequest	postBucketRequest	Bucket 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<Bucket>>	Task of ApiResponse (Bucket)

Exceptions

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

PostBucketsAsyncWithIRestResponse(PostBucketRequest, String, CancellationToken)

Create a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostBucketsAsyncWithIRestResponse(PostBucketRequest postBucketRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PostBucketRequest	postBucketRequest	Bucket to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (Bucket)

Exceptions

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

PostBucketsIDLabels(String, LabelMapping, String)

Add a label to a bucket

Declaration

public LabelResponse PostBucketsIDLabels(string bucketID, LabelMapping labelMapping, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
LabelMapping	labelMapping	Label to add
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
LabelResponse	LabelResponse

Exceptions

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

PostBucketsIDLabelsAsync(String, LabelMapping, String, CancellationToken)

Add a label to a bucket

Declaration

public async System.Threading.Tasks.Task<LabelResponse> PostBucketsIDLabelsAsync(string bucketID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
LabelMapping	labelMapping	Label to add
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PostBucketsIDLabelsAsyncWithHttpInfo(String, LabelMapping, String, CancellationToken)

Add a label to a bucket

Declaration

public async System.Threading.Tasks.Task<ApiResponse<LabelResponse>> PostBucketsIDLabelsAsyncWithHttpInfo(string bucketID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
LabelMapping	labelMapping	Label to add
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PostBucketsIDLabelsAsyncWithIRestResponse(String, LabelMapping, String, CancellationToken)

Add a label to a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostBucketsIDLabelsAsyncWithIRestResponse(string bucketID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
LabelMapping	labelMapping	Label to add
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (LabelResponse)

Exceptions

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

PostBucketsIDLabelsWithHttpInfo(String, LabelMapping, String)

Add a label to a bucket

Declaration

public ApiResponse<LabelResponse> PostBucketsIDLabelsWithHttpInfo(string bucketID, LabelMapping labelMapping, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
LabelMapping	labelMapping	Label to add
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

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

Exceptions

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

PostBucketsIDLabelsWithIRestResponse(String, LabelMapping, String)

Add a label to a bucket

Declaration

public RestResponse PostBucketsIDLabelsWithIRestResponse(string bucketID, LabelMapping labelMapping, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
LabelMapping	labelMapping	Label to add
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of LabelResponse

Exceptions

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

PostBucketsIDLabelsWithIRestResponseAsync(String, LabelMapping, String, CancellationToken)

Add a label to a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostBucketsIDLabelsWithIRestResponseAsync(string bucketID, LabelMapping labelMapping, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
LabelMapping	labelMapping	Label to add
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of LabelResponse

Exceptions

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

PostBucketsIDLabelsWithRestRequest(String, LabelMapping, String)

Add a label to a bucket

Declaration

public RestRequest PostBucketsIDLabelsWithRestRequest(string bucketID, LabelMapping labelMapping, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
LabelMapping	labelMapping	Label to add
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of LabelResponse

Exceptions

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

PostBucketsIDMembers(String, AddResourceMemberRequestBody, String)

Add a member to a bucket

Declaration

public ResourceMember PostBucketsIDMembers(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as member
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
ResourceMember	ResourceMember

Exceptions

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

PostBucketsIDMembersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a bucket

Declaration

public async System.Threading.Tasks.Task<ResourceMember> PostBucketsIDMembersAsync(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as member
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PostBucketsIDMembersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a bucket

Declaration

public async System.Threading.Tasks.Task<ApiResponse<ResourceMember>> PostBucketsIDMembersAsyncWithHttpInfo(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as member
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PostBucketsIDMembersAsyncWithIRestResponse(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostBucketsIDMembersAsyncWithIRestResponse(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as member
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (ResourceMember)

Exceptions

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

PostBucketsIDMembersWithHttpInfo(String, AddResourceMemberRequestBody, String)

Add a member to a bucket

Declaration

public ApiResponse<ResourceMember> PostBucketsIDMembersWithHttpInfo(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as member
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

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

Exceptions

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

PostBucketsIDMembersWithIRestResponse(String, AddResourceMemberRequestBody, String)

Add a member to a bucket

Declaration

public RestResponse PostBucketsIDMembersWithIRestResponse(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as member
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of ResourceMember

Exceptions

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

PostBucketsIDMembersWithIRestResponseAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add a member to a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostBucketsIDMembersWithIRestResponseAsync(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as member
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of ResourceMember

Exceptions

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

PostBucketsIDMembersWithRestRequest(String, AddResourceMemberRequestBody, String)

Add a member to a bucket

Declaration

public RestRequest PostBucketsIDMembersWithRestRequest(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as member
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of ResourceMember

Exceptions

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

PostBucketsIDOwners(String, AddResourceMemberRequestBody, String)

Add an owner to a bucket

Declaration

public ResourceOwner PostBucketsIDOwners(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as owner
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
ResourceOwner	ResourceOwner

Exceptions

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

PostBucketsIDOwnersAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a bucket

Declaration

public async System.Threading.Tasks.Task<ResourceOwner> PostBucketsIDOwnersAsync(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as owner
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PostBucketsIDOwnersAsyncWithHttpInfo(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a bucket

Declaration

public async System.Threading.Tasks.Task<ApiResponse<ResourceOwner>> PostBucketsIDOwnersAsyncWithHttpInfo(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as owner
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

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

Exceptions

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

PostBucketsIDOwnersAsyncWithIRestResponse(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostBucketsIDOwnersAsyncWithIRestResponse(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as owner
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	Task of RestResponse (ResourceOwner)

Exceptions

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

PostBucketsIDOwnersWithHttpInfo(String, AddResourceMemberRequestBody, String)

Add an owner to a bucket

Declaration

public ApiResponse<ResourceOwner> PostBucketsIDOwnersWithHttpInfo(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as owner
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

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

Exceptions

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

PostBucketsIDOwnersWithIRestResponse(String, AddResourceMemberRequestBody, String)

Add an owner to a bucket

Declaration

public RestResponse PostBucketsIDOwnersWithIRestResponse(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as owner
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of ResourceOwner

Exceptions

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

PostBucketsIDOwnersWithIRestResponseAsync(String, AddResourceMemberRequestBody, String, CancellationToken)

Add an owner to a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostBucketsIDOwnersWithIRestResponseAsync(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as owner
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of ResourceOwner

Exceptions

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

PostBucketsIDOwnersWithRestRequest(String, AddResourceMemberRequestBody, String)

Add an owner to a bucket

Declaration

public RestRequest PostBucketsIDOwnersWithRestRequest(string bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	bucketID	The bucket ID.
AddResourceMemberRequestBody	addResourceMemberRequestBody	User to add as owner
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of ResourceOwner

Exceptions

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

PostBucketsWithHttpInfo(PostBucketRequest, String)

Create a bucket

Declaration

public ApiResponse<Bucket> PostBucketsWithHttpInfo(PostBucketRequest postBucketRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
PostBucketRequest	postBucketRequest	Bucket to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

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

Exceptions

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

PostBucketsWithIRestResponse(PostBucketRequest, String)

Create a bucket

Declaration

public RestResponse PostBucketsWithIRestResponse(PostBucketRequest postBucketRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
PostBucketRequest	postBucketRequest	Bucket to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestResponse	ApiResponse of Bucket

Exceptions

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

PostBucketsWithIRestResponseAsync(PostBucketRequest, String, CancellationToken)

Create a bucket

Declaration

public async System.Threading.Tasks.Task<RestResponse> PostBucketsWithIRestResponseAsync(PostBucketRequest postBucketRequest, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
PostBucketRequest	postBucketRequest	Bucket to create
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<RestResponse>	ApiResponse of Bucket

Exceptions

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

PostBucketsWithRestRequest(PostBucketRequest, String)

Create a bucket

Declaration

public RestRequest PostBucketsWithRestRequest(PostBucketRequest postBucketRequest, string zapTraceSpan = null)

Parameters

Type	Name	Description
PostBucketRequest	postBucketRequest	Bucket to create
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
RestRequest	ApiResponse of Bucket

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

Implements

IBucketsService