Interface IBucketsApi
Namespace: InfluxDB.Client
Assembly: InfluxDB.Client.dll
Syntax
public interface IBucketsApiMethods
AddLabelAsync(Label, Bucket, CancellationToken)
Add a bucket label.
Declaration
Task<Label> AddLabelAsync(Label label, Bucket bucket, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| Label | label | the label of a bucket |
| Bucket | bucket | the bucket of a label |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<Label> | added label |
AddLabelAsync(String, String, CancellationToken)
Add a bucket label.
Declaration
Task<Label> AddLabelAsync(string labelId, string bucketId, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | labelId | the ID of a label |
| System.String | bucketId | the ID of a bucket |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<Label> | added label |
AddMemberAsync(User, Bucket, CancellationToken)
Add a bucket member.
Declaration
Task<ResourceMember> AddMemberAsync(User member, Bucket bucket, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| User | member | the member of a bucket |
| Bucket | bucket | the bucket of a member |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<ResourceMember> | created mapping |
AddMemberAsync(String, String, CancellationToken)
Add a bucket member.
Declaration
Task<ResourceMember> AddMemberAsync(string memberId, string bucketId, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | memberId | the ID of a member |
| System.String | bucketId | the ID of a bucket |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<ResourceMember> | created mapping |
AddOwnerAsync(User, Bucket, CancellationToken)
Add a bucket owner.
Declaration
Task<ResourceOwner> AddOwnerAsync(User owner, Bucket bucket, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| User | owner | the owner of a bucket |
| Bucket | bucket | the bucket of a owner |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<ResourceOwner> | created mapping |
AddOwnerAsync(String, String, CancellationToken)
Add a bucket owner.
Declaration
Task<ResourceOwner> AddOwnerAsync(string ownerId, string bucketId, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | ownerId | the ID of a owner |
| System.String | bucketId | the ID of a bucket |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<ResourceOwner> | created mapping |
CloneBucketAsync(String, Bucket, CancellationToken)
Clone a bucket.
Declaration
Task<Bucket> CloneBucketAsync(string clonedName, Bucket bucket, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | clonedName | name of cloned bucket |
| Bucket | bucket | bucket to clone |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<Bucket> | cloned bucket |
CloneBucketAsync(String, String, CancellationToken)
Clone a bucket.
Declaration
Task<Bucket> CloneBucketAsync(string clonedName, string bucketId, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | clonedName | name of cloned bucket |
| System.String | bucketId | ID of bucket to clone |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<Bucket> | cloned bucket |
CreateBucketAsync(Bucket, CancellationToken)
Creates a new bucket and sets Id with the new identifier.
Declaration
Task<Bucket> CreateBucketAsync(Bucket bucket, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| Bucket | bucket | bucket to create |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<Bucket> | created Bucket |
CreateBucketAsync(PostBucketRequest, CancellationToken)
Creates a new bucket and sets Id with the new identifier.
Declaration
Task<Bucket> CreateBucketAsync(PostBucketRequest bucket, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| PostBucketRequest | bucket | bucket to create |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<Bucket> | created Bucket |
CreateBucketAsync(String, BucketRetentionRules, Organization, CancellationToken)
Creates a new bucket and sets Id with the new identifier.
Declaration
Task<Bucket> CreateBucketAsync(string name, BucketRetentionRules bucketRetentionRules, Organization organization, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | name of the bucket |
| BucketRetentionRules | bucketRetentionRules | retention rule of the bucket |
| Organization | organization | owner of the bucket |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<Bucket> | created Bucket |
CreateBucketAsync(String, BucketRetentionRules, String, CancellationToken)
Creates a new bucket and sets Id with the new identifier.
Declaration
Task<Bucket> CreateBucketAsync(string name, BucketRetentionRules bucketRetentionRules, string orgId, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | name of the bucket |
| BucketRetentionRules | bucketRetentionRules | retention rule of the bucket |
| System.String | orgId | owner of the bucket |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<Bucket> | created Bucket |
CreateBucketAsync(String, Organization, CancellationToken)
Creates a new bucket and sets Id with the new identifier.
Declaration
Task<Bucket> CreateBucketAsync(string name, Organization organization, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | name of the bucket |
| Organization | organization | owner of the bucket |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<Bucket> | created Bucket |
CreateBucketAsync(String, String, CancellationToken)
Creates a new bucket and sets Id with the new identifier.
Declaration
Task<Bucket> CreateBucketAsync(string name, string orgId, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | name of the bucket |
| System.String | orgId | owner of the bucket |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<Bucket> | created Bucket |
DeleteBucketAsync(Bucket, CancellationToken)
Delete a bucket.
Declaration
Task DeleteBucketAsync(Bucket bucket, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| Bucket | bucket | bucket to delete |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task | delete has been accepted |
DeleteBucketAsync(String, CancellationToken)
Delete a bucket.
Declaration
Task DeleteBucketAsync(string bucketId, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | bucketId | ID of bucket to delete |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task | delete has been accepted |
DeleteLabelAsync(Label, Bucket, CancellationToken)
Removes a label from a bucket.
Declaration
Task DeleteLabelAsync(Label label, Bucket bucket, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| Label | label | the label of a bucket |
| Bucket | bucket | the bucket of a owner |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task | delete has been accepted |
DeleteLabelAsync(String, String, CancellationToken)
Removes a label from a bucket.
Declaration
Task DeleteLabelAsync(string labelId, string bucketId, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | labelId | the ID of a label |
| System.String | bucketId | the ID of a bucket |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task | delete has been accepted |
DeleteMemberAsync(User, Bucket, CancellationToken)
Removes a member from a bucket.
Declaration
Task DeleteMemberAsync(User member, Bucket bucket, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| User | member | the member of a bucket |
| Bucket | bucket | the bucket of a member |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task | member removed |
DeleteMemberAsync(String, String, CancellationToken)
Removes a member from a bucket.
Declaration
Task DeleteMemberAsync(string memberId, string bucketId, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | memberId | the ID of a member |
| System.String | bucketId | the ID of a bucket |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task | member removed |
DeleteOwnerAsync(User, Bucket, CancellationToken)
Removes a owner from a bucket.
Declaration
Task DeleteOwnerAsync(User owner, Bucket bucket, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| User | owner | the owner of a bucket |
| Bucket | bucket | the bucket of a owner |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task | owner removed |
DeleteOwnerAsync(String, String, CancellationToken)
Removes a owner from a bucket.
Declaration
Task DeleteOwnerAsync(string ownerId, string bucketId, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | ownerId | the ID of a owner |
| System.String | bucketId | the ID of a bucket |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task | owner removed |
FindBucketByIdAsync(String, CancellationToken)
Retrieve a bucket.
Declaration
Task<Bucket> FindBucketByIdAsync(string bucketId, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | bucketId | ID of bucket to get |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<Bucket> | Bucket Details |
FindBucketByNameAsync(String, CancellationToken)
Retrieve a bucket.
Declaration
Task<Bucket> FindBucketByNameAsync(string bucketName, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | bucketName | Name of bucket to get |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<Bucket> | Bucket Details |
FindBucketsAsync(FindOptions, CancellationToken)
List all buckets.
Declaration
Task<Buckets> FindBucketsAsync(FindOptions findOptions, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| FindOptions | findOptions | the find options |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<Buckets> | List all buckets |
FindBucketsAsync(Nullable<Int32>, Nullable<Int32>, String, String, String, String, String, CancellationToken)
List all buckets.
Declaration
Task<List<Bucket>> FindBucketsAsync(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.Nullable<System.Int32> | offset | (optional) |
| System.Nullable<System.Int32> | limit | (optional, default to 20) |
| System.String | after | The last resource ID from which to seek from (but not including). This is to be used instead of |
| 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 |
|---|---|
| Task<List<Bucket>> | List all buckets |
FindBucketsByOrganizationAsync(Organization, CancellationToken)
List all buckets for specified organization.
Declaration
Task<List<Bucket>> FindBucketsByOrganizationAsync(Organization organization, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| Organization | organization | filter buckets to a specific organization |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<List<Bucket>> | A list of buckets |
FindBucketsByOrgNameAsync(String, CancellationToken)
List all buckets for specified orgId.
Declaration
Task<List<Bucket>> FindBucketsByOrgNameAsync(string orgName, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | orgName | filter buckets to a specific organization |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<List<Bucket>> | A list of buckets |
GetLabelsAsync(Bucket, CancellationToken)
List all labels of a bucket.
Declaration
Task<List<Label>> GetLabelsAsync(Bucket bucket, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| Bucket | bucket | bucket of the labels |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<List<Label>> | the List all labels of a bucket |
GetLabelsAsync(String, CancellationToken)
List all labels of a bucket.
Declaration
Task<List<Label>> GetLabelsAsync(string bucketId, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | bucketId | ID of a bucket to get labels |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<List<Label>> | the List all labels of a bucket |
GetMembersAsync(Bucket, CancellationToken)
List all members of a bucket.
Declaration
Task<List<ResourceMember>> GetMembersAsync(Bucket bucket, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| Bucket | bucket | bucket of the members |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<List<ResourceMember>> | the List all members of a bucket |
GetMembersAsync(String, CancellationToken)
List all members of a bucket.
Declaration
Task<List<ResourceMember>> GetMembersAsync(string bucketId, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | bucketId | ID of bucket to get members |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<List<ResourceMember>> | the List all members of a bucket |
GetOwnersAsync(Bucket, CancellationToken)
List all owners of a bucket.
Declaration
Task<List<ResourceOwner>> GetOwnersAsync(Bucket bucket, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| Bucket | bucket | bucket of the owners |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<List<ResourceOwner>> | the List all owners of a bucket |
GetOwnersAsync(String, CancellationToken)
List all owners of a bucket.
Declaration
Task<List<ResourceOwner>> GetOwnersAsync(string bucketId, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | bucketId | ID of a bucket to get owners |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<List<ResourceOwner>> | the List all owners of a bucket |
UpdateBucketAsync(Bucket, CancellationToken)
Update a bucket name and retention.
Declaration
Task<Bucket> UpdateBucketAsync(Bucket bucket, CancellationToken cancellationToken = null)Parameters
| Type | Name | Description |
|---|---|---|
| Bucket | bucket | bucket update to apply |
| CancellationToken | cancellationToken | Cancellation token |
Returns
| Type | Description |
|---|---|
| Task<Bucket> | bucket updated |