Package com.influxdb.client.service

Interface BucketsService

public interface BucketsService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Void>	deleteBucketsID(String bucketID, String zapTraceSpan)	Delete a bucket
retrofit2.Call<Void>	deleteBucketsIDLabelsID(String bucketID, String labelID, String zapTraceSpan)	Delete a label from a bucket
retrofit2.Call<Void>	deleteBucketsIDMembersID(String userID, String bucketID, String zapTraceSpan)	Remove a member from a bucket
retrofit2.Call<Void>	deleteBucketsIDOwnersID(String userID, String bucketID, String zapTraceSpan)	Remove an owner from a bucket
retrofit2.Call<Buckets>	getBuckets(String zapTraceSpan, Integer offset, Integer limit, String after, String org, String orgID, String name, String id)	List all buckets
retrofit2.Call<Bucket>	getBucketsID(String bucketID, String zapTraceSpan)	Retrieve a bucket
retrofit2.Call<LabelsResponse>	getBucketsIDLabels(String bucketID, String zapTraceSpan)	List all labels for a bucket
retrofit2.Call<ResourceMembers>	getBucketsIDMembers(String bucketID, String zapTraceSpan)	List all users with member privileges for a bucket
retrofit2.Call<ResourceOwners>	getBucketsIDOwners(String bucketID, String zapTraceSpan)	List all owners of a bucket
retrofit2.Call<Buckets>	getSourcesIDBuckets(String sourceID, String zapTraceSpan, String org)	Get buckets in a source
retrofit2.Call<Bucket>	patchBucketsID(String bucketID, PatchBucketRequest patchBucketRequest, String zapTraceSpan)	Update a bucket
retrofit2.Call<Bucket>	postBuckets(PostBucketRequest postBucketRequest, String zapTraceSpan)	Create a bucket
retrofit2.Call<LabelResponse>	postBucketsIDLabels(String bucketID, LabelMapping labelMapping, String zapTraceSpan)	Add a label to a bucket
retrofit2.Call<ResourceMember>	postBucketsIDMembers(String bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, String zapTraceSpan)	Add a member to a bucket
retrofit2.Call<ResourceOwner>	postBucketsIDOwners(String bucketID, AddResourceMemberRequestBody addResourceMemberRequestBody, String zapTraceSpan)	Add an owner to a bucket

Method Details

deleteBucketsID

@DELETE("api/v2/buckets/{bucketID}")
retrofit2.Call<Void> deleteBucketsID(@Path("bucketID")
 String bucketID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Delete a bucket

Parameters:

bucketID - The ID of the bucket to delete. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteBucketsIDLabelsID

@DELETE("api/v2/buckets/{bucketID}/labels/{labelID}")
retrofit2.Call<Void> deleteBucketsIDLabelsID(@Path("bucketID")
 String bucketID,
 @Path("labelID")
 String labelID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Delete a label from a bucket

Parameters:

bucketID - The bucket ID. (required)

labelID - The ID of the label to delete. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteBucketsIDMembersID

@DELETE("api/v2/buckets/{bucketID}/members/{userID}")
retrofit2.Call<Void> deleteBucketsIDMembersID(@Path("userID")
 String userID,
 @Path("bucketID")
 String bucketID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Remove a member from a bucket

Parameters:

userID - The ID of the member to remove. (required)

bucketID - The bucket ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

deleteBucketsIDOwnersID

@DELETE("api/v2/buckets/{bucketID}/owners/{userID}")
retrofit2.Call<Void> deleteBucketsIDOwnersID(@Path("userID")
 String userID,
 @Path("bucketID")
 String bucketID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Remove an owner from a bucket

Parameters:

userID - The ID of the owner to remove. (required)

bucketID - The bucket ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Void>

getBuckets

@GET("api/v2/buckets")
retrofit2.Call<Buckets> getBuckets(@Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("after")
 String after,
 @Query("org")
 String org,
 @Query("orgID")
 String orgID,
 @Query("name")
 String name,
 @Query("id")
 String id)

List all buckets

Parameters:

zapTraceSpan - OpenTracing span context (optional)

offset - (optional)

limit - (optional, default to 20)

after - Resource ID to seek from. Results are not inclusive of this ID. Use `after` instead of `offset`. (optional)

org - The name of the organization. (optional)

orgID - The organization ID. (optional)

name - Only returns buckets with a specific name. (optional)

id - Only returns buckets with a specific ID. (optional)

Returns:

Call<Buckets>

getBucketsID

@GET("api/v2/buckets/{bucketID}")
retrofit2.Call<Bucket> getBucketsID(@Path("bucketID")
 String bucketID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Retrieve a bucket

Parameters:

bucketID - The bucket ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Bucket>

getBucketsIDLabels

@GET("api/v2/buckets/{bucketID}/labels")
retrofit2.Call<LabelsResponse> getBucketsIDLabels(@Path("bucketID")
 String bucketID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

List all labels for a bucket

Parameters:

bucketID - The bucket ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelsResponse>

getBucketsIDMembers

@GET("api/v2/buckets/{bucketID}/members")
retrofit2.Call<ResourceMembers> getBucketsIDMembers(@Path("bucketID")
 String bucketID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

List all users with member privileges for a bucket

Parameters:

bucketID - The bucket ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceMembers>

getBucketsIDOwners

@GET("api/v2/buckets/{bucketID}/owners")
retrofit2.Call<ResourceOwners> getBucketsIDOwners(@Path("bucketID")
 String bucketID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

List all owners of a bucket

Parameters:

bucketID - The bucket ID. (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceOwners>

getSourcesIDBuckets

@GET("api/v2/sources/{sourceID}/buckets")
retrofit2.Call<Buckets> getSourcesIDBuckets(@Path("sourceID")
 String sourceID,
 @Header("Zap-Trace-Span")
 String zapTraceSpan,
 @Query("org")
 String org)

Get buckets in a source

Parameters:

sourceID - The source ID. (required)

zapTraceSpan - OpenTracing span context (optional)

org - The name of the organization. (optional)

Returns:

Call<Buckets>

patchBucketsID

@Headers("Content-Type:application/json")
@PATCH("api/v2/buckets/{bucketID}")
retrofit2.Call<Bucket> patchBucketsID(@Path("bucketID")
 String bucketID,
 @Body
 PatchBucketRequest patchBucketRequest,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Update a bucket

Parameters:

bucketID - The bucket ID. (required)

patchBucketRequest - Bucket update to apply (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Bucket>

postBuckets

@Headers("Content-Type:application/json")
@POST("api/v2/buckets")
retrofit2.Call<Bucket> postBuckets(@Body
 PostBucketRequest postBucketRequest,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Create a bucket

Parameters:

postBucketRequest - Bucket to create (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<Bucket>

postBucketsIDLabels

@Headers("Content-Type:application/json")
@POST("api/v2/buckets/{bucketID}/labels")
retrofit2.Call<LabelResponse> postBucketsIDLabels(@Path("bucketID")
 String bucketID,
 @Body
 LabelMapping labelMapping,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Add a label to a bucket

Parameters:

bucketID - The bucket ID. (required)

labelMapping - Label to add (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<LabelResponse>

postBucketsIDMembers

@Headers("Content-Type:application/json")
@POST("api/v2/buckets/{bucketID}/members")
retrofit2.Call<ResourceMember> postBucketsIDMembers(@Path("bucketID")
 String bucketID,
 @Body
 AddResourceMemberRequestBody addResourceMemberRequestBody,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Add a member to a bucket

Parameters:

bucketID - The bucket ID. (required)

addResourceMemberRequestBody - User to add as member (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceMember>

postBucketsIDOwners

@Headers("Content-Type:application/json")
@POST("api/v2/buckets/{bucketID}/owners")
retrofit2.Call<ResourceOwner> postBucketsIDOwners(@Path("bucketID")
 String bucketID,
 @Body
 AddResourceMemberRequestBody addResourceMemberRequestBody,
 @Header("Zap-Trace-Span")
 String zapTraceSpan)

Add an owner to a bucket

Parameters:

bucketID - The bucket ID. (required)

addResourceMemberRequestBody - User to add as owner (required)

zapTraceSpan - OpenTracing span context (optional)

Returns:

Call<ResourceOwner>