Package org.jclouds.googlecloudstorage.features

Interface BucketAccessControlsApi

  • @Consumes("application/json")
public interface BucketAccessControlsApi
    Provides access to BucketAccessControl entities via their REST API.
    See Also:

    • Method Detail

      • getBucketAccessControls

        @Named("BucketAccessControls:get")
@GET
@Path("/b/{bucket}/acl/{entity}")
@Nullable
BucketAccessControls getBucketAccessControls​(@PathParam("bucket")
                                             String bucketName,
                                             @PathParam("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("BucketAccessControls:insert")
@POST
@Path("/b/{bucket}/acl")
BucketAccessControls createBucketAccessControls​(@PathParam("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("BucketAccessControls:delete")
@DELETE
@Path("/b/{bucket}/acl/{entity}")
@Nullable
HttpResponse deleteBucketAccessControls​(@PathParam("bucket")
                                        String bucketName,
                                        @PathParam("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("BucketAccessControls:list")
@GET
@Produces("application/json")
@Path("/b/{bucket}/acl")
@Nullable
List<BucketAccessControls> listBucketAccessControls​(@PathParam("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("BucketAccessControls:update")
@PUT
@Produces("application/json")
@Path("/b/{bucket}/acl/{entity}")
BucketAccessControls updateBucketAccessControls​(@PathParam("bucket")
                                                String bucketName,
                                                @PathParam("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("BucketAccessControls:patch")
@Produces("application/json")
@Path("/b/{bucket}/acl/{entity}")
BucketAccessControls patchBucketAccessControls​(@PathParam("bucket")
                                               String bucketName,
                                               @PathParam("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