public interface BucketsService
| Modifier and Type | Method and 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
|
@DELETE(value="api/v2/buckets/{bucketID}")
retrofit2.Call<Void> deleteBucketsID(@Path(value="bucketID")
String bucketID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
bucketID - The ID of the bucket to delete. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/buckets/{bucketID}/labels/{labelID}")
retrofit2.Call<Void> deleteBucketsIDLabelsID(@Path(value="bucketID")
String bucketID,
@Path(value="labelID")
String labelID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
bucketID - The bucket ID. (required)labelID - The ID of the label to delete. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/buckets/{bucketID}/members/{userID}")
retrofit2.Call<Void> deleteBucketsIDMembersID(@Path(value="userID")
String userID,
@Path(value="bucketID")
String bucketID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
userID - The ID of the member to remove. (required)bucketID - The bucket ID. (required)zapTraceSpan - OpenTracing span context (optional)@DELETE(value="api/v2/buckets/{bucketID}/owners/{userID}")
retrofit2.Call<Void> deleteBucketsIDOwnersID(@Path(value="userID")
String userID,
@Path(value="bucketID")
String bucketID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
userID - The ID of the owner to remove. (required)bucketID - The bucket ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/buckets") retrofit2.Call<Buckets> getBuckets(@Header(value="Zap-Trace-Span") String zapTraceSpan, @Query(value="offset") Integer offset, @Query(value="limit") Integer limit, @Query(value="after") String after, @Query(value="org") String org, @Query(value="orgID") String orgID, @Query(value="name") String name, @Query(value="id") String id)
zapTraceSpan - OpenTracing span context (optional)offset - (optional)limit - (optional, default to 20)after - The last resource ID from which to seek from (but not including). This is to be used 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)@GET(value="api/v2/buckets/{bucketID}")
retrofit2.Call<Bucket> getBucketsID(@Path(value="bucketID")
String bucketID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
bucketID - The bucket ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/buckets/{bucketID}/labels")
retrofit2.Call<LabelsResponse> getBucketsIDLabels(@Path(value="bucketID")
String bucketID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
bucketID - The bucket ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/buckets/{bucketID}/members")
retrofit2.Call<ResourceMembers> getBucketsIDMembers(@Path(value="bucketID")
String bucketID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
bucketID - The bucket ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/buckets/{bucketID}/owners")
retrofit2.Call<ResourceOwners> getBucketsIDOwners(@Path(value="bucketID")
String bucketID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
bucketID - The bucket ID. (required)zapTraceSpan - OpenTracing span context (optional)@GET(value="api/v2/sources/{sourceID}/buckets")
retrofit2.Call<Buckets> getSourcesIDBuckets(@Path(value="sourceID")
String sourceID,
@Header(value="Zap-Trace-Span")
String zapTraceSpan,
@Query(value="org")
String org)
sourceID - The source ID. (required)zapTraceSpan - OpenTracing span context (optional)org - The name of the organization. (optional)@Headers(value="Content-Type:application/json")
@PATCH(value="api/v2/buckets/{bucketID}")
retrofit2.Call<Bucket> patchBucketsID(@Path(value="bucketID")
String bucketID,
@Body
PatchBucketRequest patchBucketRequest,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
bucketID - The bucket ID. (required)patchBucketRequest - Bucket update to apply (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json") @POST(value="api/v2/buckets") retrofit2.Call<Bucket> postBuckets(@Body PostBucketRequest postBucketRequest, @Header(value="Zap-Trace-Span") String zapTraceSpan)
postBucketRequest - Bucket to create (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/buckets/{bucketID}/labels")
retrofit2.Call<LabelResponse> postBucketsIDLabels(@Path(value="bucketID")
String bucketID,
@Body
LabelMapping labelMapping,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
bucketID - The bucket ID. (required)labelMapping - Label to add (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/buckets/{bucketID}/members")
retrofit2.Call<ResourceMember> postBucketsIDMembers(@Path(value="bucketID")
String bucketID,
@Body
AddResourceMemberRequestBody addResourceMemberRequestBody,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
bucketID - The bucket ID. (required)addResourceMemberRequestBody - User to add as member (required)zapTraceSpan - OpenTracing span context (optional)@Headers(value="Content-Type:application/json")
@POST(value="api/v2/buckets/{bucketID}/owners")
retrofit2.Call<ResourceOwner> postBucketsIDOwners(@Path(value="bucketID")
String bucketID,
@Body
AddResourceMemberRequestBody addResourceMemberRequestBody,
@Header(value="Zap-Trace-Span")
String zapTraceSpan)
bucketID - The bucket ID. (required)addResourceMemberRequestBody - User to add as owner (required)zapTraceSpan - OpenTracing span context (optional)Copyright © 2018–2021 InfluxData, Inc.. All rights reserved.