Package org.jclouds.googlecloudstorage.features

Interface DefaultObjectAccessControlsApi

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

    • Method Detail

      • getDefaultObjectAccessControls

        @Named("DefaultObjectAccessControls:get")
@GET
@Path("/b/{bucket}/defaultObjectAcl/{entity}")
@Nullable
ObjectAccessControls getDefaultObjectAccessControls​(@PathParam("bucket")
                                                    String bucketName,
                                                    @PathParam("entity")
                                                    String entity)
        Returns the ACL entry for the specified entity on the specified object.
        Parameters:
        bucketName - Name of the bucket which contains the object
        entity - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers
        Returns:
        an DefaultObjectAccessControls resource

      • createDefaultObjectAccessControls

        @Named("DefaultObjectAccessControls:insert")
@POST
@Produces("application/json")
@Path("/b/{bucket}/defaultObjectAcl")
ObjectAccessControls createDefaultObjectAccessControls​(@PathParam("bucket")
                                                       String bucketName,
                                                       ObjectAccessControlsTemplate template)
        Creates a new ACL entry for specified object
        Parameters:
        bucketName - Name of the bucket of that ACL to be created In the request body, supply a DefaultObjectAccessControls resource with the following properties
        Returns:
        If successful, this method returns a DefaultObjectAccessControls resource

      • deleteDefaultObjectAccessControls

        @Named("DefaultObjectAccessControls:delete")
@DELETE
@Path("/b/{bucket}/defaultObjectAcl/{entity}")
@Nullable
HttpResponse deleteDefaultObjectAccessControls​(@PathParam("bucket")
                                               String bucketName,
                                               @PathParam("entity")
                                               String entity)
        Permanently deletes the DefaultObjectAcessControl entry for the specified entity on the specified bucket.
        Parameters:
        bucketName - Name of the bucket which contains the object
        entity - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers
        Returns:
        If successful, this method returns an empty response body

      • listDefaultObjectAccessControls

        @Named("DefaultObjectAccessControls:list")
@GET
@Produces("application/json")
@Path("/b/{bucket}/defaultObjectAcl")
@Nullable
List<ObjectAccessControls> listDefaultObjectAccessControls​(@PathParam("bucket")
                                                           String bucketName)
        Retrieves ACL entries on a specified object
        Parameters:
        bucketName - Name of the bucket which contains the object
        Returns:
        ListObjectAccessControls resource

      • updateDefaultObjectAccessControls

        @Named("DefaultObjectAccessControls:update")
@PUT
@Produces("application/json")
@Path("/b/{bucket}/defaultObjectAcl/{entity}")
ObjectAccessControls updateDefaultObjectAccessControls​(@PathParam("bucket")
                                                       String bucketName,
                                                       @PathParam("entity")
                                                       String entity,
                                                       ObjectAccessControls payload)
        Retrieves ACL entries on a specified object
        Parameters:
        bucketName - Name of the bucket which contains the object
        Returns:
        DefaultObjectAccessControls resource

      • updateDefaultObjectAccessControls

        @Named("DefaultObjectAccessControls:update")
@PUT
@Produces("application/json")
@Path("/b/{bucket}/defaultObjectAcl/{entity}")
ObjectAccessControls updateDefaultObjectAccessControls​(@PathParam("bucket")
                                                       String bucketName,
                                                       @PathParam("entity")
                                                       String entity,
                                                       ObjectAccessControls payload,
                                                       @QueryParam("role")
                                                       DomainResourceReferences.ObjectRole role)
        Retrieves ACL entries on a specified object
        Parameters:
        bucketName - Name of the bucket which contains the object

      • patchDefaultObjectAccessControls

        @Named("DefaultObjectAccessControls:patch")
@Produces("application/json")
@Path("/b/{bucket}/defaultObjectAcl/{entity}")
ObjectAccessControls patchDefaultObjectAccessControls​(@PathParam("bucket")
                                                      String bucketName,
                                                      @PathParam("entity")
                                                      String entity,
                                                      ObjectAccessControls payload)
        Retrieves ACL entries on a specified object
        Parameters:
        bucketName - Name of the bucket which contains the object