org.jclouds.googlecloudstorage.features

Interface BucketAccessControlsApi

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

Provides access to BucketAccessControl entities via their REST API.

See Also:

Method Summary

Methods

Modifier and Type	Method and Description
BucketAccessControls	createBucketAccessControls(String bucketName, BucketAccessControlsTemplate template) Creates a new ACL entry on the specified bucket.
org.jclouds.http.HttpResponse	deleteBucketAccessControls(String bucketName, String entity) Permanently deletes the ACL entry for the specified entity on the specified bucket.
BucketAccessControls	getBucketAccessControls(String bucketName, String entity) Returns the ACL entry for the specified entity on the specified bucket.
List<BucketAccessControls>	listBucketAccessControls(String bucketName) Retrieves all ACL entries on a specified bucket
BucketAccessControls	patchBucketAccessControls(String bucketName, String entity, BucketAccessControlsTemplate template) Updates an ACL entry on the specified bucket.
BucketAccessControls	updateBucketAccessControls(String bucketName, String entity, BucketAccessControlsTemplate template) Updates an ACL entry on the specified bucket

Method Detail

getBucketAccessControls

@Named(value="BucketAccessControls:get")
@GET
@Path(value="/b/{bucket}/acl/{entity}")
@Nullable
BucketAccessControls getBucketAccessControls(@PathParam(value="bucket")
                                                                   String bucketName,
                                                                   @PathParam(value="entity")
                                                                   String entity)

Returns the ACL entry for the specified entity on the specified bucket.

Parameters:

bucketName - Name of the bucket which ACL is related

entity - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

Returns:

a BucketAccessControls resource

createBucketAccessControls

@Named(value="BucketAccessControls:insert")
@POST
@Path(value="/b/{bucket}/acl")
BucketAccessControls createBucketAccessControls(@PathParam(value="bucket")
                                                              String bucketName,
                                                              BucketAccessControlsTemplate template)

Creates a new ACL entry on the specified bucket.

Parameters:

bucketName - Name of the bucket of which ACL to be created

template - In the request body,supply a BucketAccessControlsTemplate resource with role and entity

Returns:

If successful, this method returns a BucketAccessControls resource in the response body

deleteBucketAccessControls

@Named(value="BucketAccessControls:delete")
@DELETE
@Path(value="/b/{bucket}/acl/{entity}")
@Nullable
org.jclouds.http.HttpResponse deleteBucketAccessControls(@PathParam(value="bucket")
                                                                                  String bucketName,
                                                                                  @PathParam(value="entity")
                                                                                  String entity)

Permanently deletes the ACL entry for the specified entity on the specified bucket.

Parameters:

bucketName - Name of the bucket of that ACL is related

Returns:

If successful, this method returns an empty response body.

listBucketAccessControls

@Named(value="BucketAccessControls:list")
@GET
@Produces(value="application/json")
@Path(value="/b/{bucket}/acl")
@Nullable
List<BucketAccessControls> listBucketAccessControls(@PathParam(value="bucket")
                                                                                   String bucketName)

Retrieves all ACL entries on a specified bucket

Parameters:

bucketName - Name of the bucket which ACL is related

Returns:

ListBucketAccessControls resource

updateBucketAccessControls

@Named(value="BucketAccessControls:update")
@PUT
@Produces(value="application/json")
@Path(value="/b/{bucket}/acl/{entity}")
BucketAccessControls updateBucketAccessControls(@PathParam(value="bucket")
                                                                      String bucketName,
                                                                      @PathParam(value="entity")
                                                                      String entity,
                                                                      BucketAccessControlsTemplate template)

Updates an ACL entry on the specified bucket

Parameters:

bucketName - Name of the bucket which ACL to be created

entity - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers. In the request body, supply a BucketAccessControlsTemplate resource with role

Returns:

If successful, this method returns a BucketAccessControlsTemplate resource in the response body

patchBucketAccessControls

@Named(value="BucketAccessControls:patch")
@Produces(value="application/json")
@Path(value="/b/{bucket}/acl/{entity}")
BucketAccessControls patchBucketAccessControls(@PathParam(value="bucket")
                                                                 String bucketName,
                                                                 @PathParam(value="entity")
                                                                 String entity,
                                                                 BucketAccessControlsTemplate template)

Updates an ACL entry on the specified bucket.

Parameters:

bucketName - Name of the bucket which ACL to be created

entity - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers

template - In the request body, supply a BucketAccessControlsTemplate resource with role

Returns:

If successful, this method returns a BucketAccessControls resource in the response body