BucketApi (Apache jclouds 2.1.0 API)

Methods
Modifier and Type	Method and Description
`boolean`	`bucketExist(String bucketName)` Check the existence of a bucket
`Bucket`	`createBucket(String projectId, BucketTemplate bucketTemplate)` Creates a new bucket
`Bucket`	`createBucket(String projectId, BucketTemplate bucketTemplate, InsertBucketOptions options)` Creates a new Bucket
`boolean`	`deleteBucket(String bucketName)` Permanently deletes an empty Bucket.If bucket is not empty 409 error to indicate the conflict.
`boolean`	`deleteBucket(String bucketName, DeleteBucketOptions options)` Permanently deletes an empty Bucket.If bucket is not empty 409 error to indicate the conflict.
`Bucket`	`getBucket(String bucketName)` Returns metadata for the specified bucket.
`Bucket`	`getBucket(String bucketName, GetBucketOptions options)` Returns metadata for the specified bucket
`ListPage<Bucket>`	`listBucket(String projectId)` Retrieves a list of buckets for a given project
`ListPage<Bucket>`	`listBucket(String projectId, ListOptions options)` Retrieves a list of buckets for a given project
`Bucket`	`patchBucket(String bucketName, BucketTemplate bucketTemplate)` Updates a bucket supporting patch semantics.
`Bucket`	`patchBucket(String bucketName, BucketTemplate bucketTemplate, UpdateBucketOptions options)` Updates a bucket supporting patch semantics.
`Bucket`	`updateBucket(String bucketName, BucketTemplate bucketTemplate)` Updates a bucket
`Bucket`	`updateBucket(String bucketName, BucketTemplate bucketTemplate, UpdateBucketOptions options)` Updates a bucket

@Consumes(value="application/json")
public interface BucketApi

Provides access to Bucket entities via their REST API.

See Also:

Method Summary

Methods
Modifier and Type Method and Description

boolean bucketExist(String bucketName)
Check the existence of a bucket

Bucket createBucket(String projectId, BucketTemplate bucketTemplate)
Creates a new bucket

Bucket createBucket(String projectId, BucketTemplate bucketTemplate, InsertBucketOptions options)
Creates a new Bucket

boolean deleteBucket(String bucketName)
Permanently deletes an empty Bucket.If bucket is not empty 409 error to indicate the conflict.

boolean deleteBucket(String bucketName, DeleteBucketOptions options)
Permanently deletes an empty Bucket.If bucket is not empty 409 error to indicate the conflict.

Bucket getBucket(String bucketName)
Returns metadata for the specified bucket.

Bucket getBucket(String bucketName, GetBucketOptions options)
Returns metadata for the specified bucket

ListPage<Bucket> listBucket(String projectId)
Retrieves a list of buckets for a given project

ListPage<Bucket> listBucket(String projectId, ListOptions options)
Retrieves a list of buckets for a given project

Bucket patchBucket(String bucketName, BucketTemplate bucketTemplate)
Updates a bucket supporting patch semantics.

Bucket patchBucket(String bucketName, BucketTemplate bucketTemplate, UpdateBucketOptions options)
Updates a bucket supporting patch semantics.

Bucket updateBucket(String bucketName, BucketTemplate bucketTemplate)
Updates a bucket

Bucket updateBucket(String bucketName, BucketTemplate bucketTemplate, UpdateBucketOptions options)
Updates a bucket

Method Detail

bucketExist

@Named(value="Bucket:get")
@GET
@Path(value="/b/{bucket}")
boolean bucketExist(@PathParam(value="bucket")
                                 String bucketName)

Check the existence of a bucket

Parameters:: bucketName - Name of the bucket
Returns:: a Bucket true if bucket exist

getBucket

@Named(value="Bucket:get")
@GET
@Produces(value="application/json")
@Path(value="/b/{bucket}")
@Nullable
Bucket getBucket(@PathParam(value="bucket")
                                                String bucketName)

Returns metadata for the specified bucket.

Parameters:: bucketName - Name of the bucket
Returns:: a Bucket resource

getBucket

@Named(value="Bucket:get")
@GET
@Produces(value="application/json")
@Path(value="/b/{bucket}")
@Nullable
Bucket getBucket(@PathParam(value="bucket")
                                                String bucketName,
                                                GetBucketOptions options)

Returns metadata for the specified bucket

Parameters:: bucketName - Name of the bucket; options - Supply GetBucketOptions with optional query parameters
Returns:: a Bucket resource

createBucket

@Named(value="Bucket:insert")
@POST
@Path(value="/b")
Bucket createBucket(@QueryParam(value="project")
                                  String projectId,
                                  BucketTemplate bucketTemplate)

Creates a new bucket

Parameters:: projectId - A valid API project identifier; bucketTemplate - supply a BucketTemplate resource
Returns:: If successful, this method returns a Bucket resource.

createBucket

@Named(value="Bucket:insert")
@POST
@Path(value="/b")
Bucket createBucket(@QueryParam(value="project")
                                  String projectId,
                                  BucketTemplate bucketTemplate,
                                  InsertBucketOptions options)

Creates a new Bucket

Parameters:: projectId - A valid API project identifier; bucketTemplate - Supply a BucketTemplate resource; options - Supply InsertBucketOptions with optional query parameters
Returns:: If successful, this method returns a Bucket resource.

deleteBucket

@Named(value="Bucket:delete")
@DELETE
@Path(value="/b/{bucket}")
boolean deleteBucket(@PathParam(value="bucket")
                                     String bucketName)

Permanently deletes an empty Bucket.If bucket is not empty 409 error to indicate the conflict.

Parameters:: bucketName - Name of the bucket

deleteBucket

@Named(value="Bucket:delete")
@DELETE
@Path(value="/b/{bucket}")
boolean deleteBucket(@PathParam(value="bucket")
                                     String bucketName,
                                     DeleteBucketOptions options)

Permanently deletes an empty Bucket.If bucket is not empty 409 error to indicate the conflict.

Parameters:: bucketName - Name of the bucket; options - Supply DeleteBucketOptions with optional query parameters

listBucket

@Named(value="Bucket:list")
@GET
@Produces(value="application/json")
@Path(value="/b")
ListPage<Bucket> listBucket(@QueryParam(value="project")
                                                  String projectId)

Retrieves a list of buckets for a given project

Parameters:: projectId - A valid API project identifier
Returns:: a ListPage

listBucket

@Named(value="Bucket:list")
@GET
@Produces(value="application/json")
@Path(value="/b")
ListPage<Bucket> listBucket(@QueryParam(value="project")
                                                  String projectId,
                                                  ListOptions options)

Retrieves a list of buckets for a given project

Parameters:: projectId - A valid API project identifier; options - Supply ListOptions with optional query parameters

updateBucket

@Named(value="Bucket:update")
@PUT
@Produces(value="application/json")
@Path(value="/b/{bucket}")
Bucket updateBucket(@PathParam(value="bucket")
                                          String bucketName,
                                          BucketTemplate bucketTemplate)

Updates a bucket

Parameters:: bucketName - Name of the bucket; bucketTemplate - Supply a BucketTemplate resource with list of BucketAccessControls
Returns:: If successful, this method returns the updated Bucket resource.

updateBucket

@Named(value="Bucket:update")
@PUT
@Produces(value="application/json")
@Path(value="/b/{bucket}")
Bucket updateBucket(@PathParam(value="bucket")
                                          String bucketName,
                                          BucketTemplate bucketTemplate,
                                          UpdateBucketOptions options)

Updates a bucket

Parameters:: bucketName - Name of the bucket; bucketTemplate - Supply a BucketTemplate resource with list of BucketAccessControls; options - Supply UpdateBucketOptions with optional query parameters
Returns:: If successful,this method returns the updated Bucket resource.

patchBucket

@Named(value="Bucket:patch")
@Produces(value="application/json")
@Path(value="/b/{bucket}")
Bucket patchBucket(@PathParam(value="bucket")
                                     String bucketName,
                                     BucketTemplate bucketTemplate)

Updates a bucket supporting patch semantics.

Parameters:: bucketName - Name of the bucket; bucketTemplate - Supply a BucketTemplate resource with list of BucketAccessControls
Returns:: If successful, this method returns the updated Bucket resource.
See Also:

patchBucket

@Named(value="Bucket:patch")
@Produces(value="application/json")
@Path(value="/b/{bucket}")
Bucket patchBucket(@PathParam(value="bucket")
                                     String bucketName,
                                     BucketTemplate bucketTemplate,
                                     UpdateBucketOptions options)

Updates a bucket supporting patch semantics.

Parameters:: bucketName - Name of the bucket; bucketTemplate - Supply a BucketTemplate resource with list of BucketAccessControls; options - Supply UpdateBucketOptions with optional query parameters
Returns:: If successful, this method returns the updated Bucket resource.
See Also:

Interface BucketApi

Method Summary

Method Detail

bucketExist

getBucket

getBucket

createBucket

createBucket

deleteBucket

deleteBucket

listBucket

listBucket

updateBucket

updateBucket

patchBucket

patchBucket