Package org.jclouds.googlecloudstorage.features

Interface ObjectAccessControlsApi

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

  • Method Details

    • getObjectAccessControls

      @Named("ObjectAccessControls:get") @GET @Path("/b/{bucket}/o/{object}/acl/{entity}") @Nullable ObjectAccessControls getObjectAccessControls(@PathParam("bucket") String bucketName, @PathParam("object") @Encoded String objectName, @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
      objectName - Name of the bucket of that acl is related
      entity - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers
      Returns:
      an ObjectAccessControls

    • getObjectAccessControls

      @Named("ObjectAccessControls:get") @GET @Path("/b/{bucket}/o/{object}/acl/{entity}") @Nullable ObjectAccessControls getObjectAccessControls(@PathParam("bucket") String bucketName, @PathParam("object") @Encoded String objectName, @PathParam("entity") String entity, @QueryParam("generation") Long generation)
      Returns the acl entry for the specified entity on the specified object.
      Parameters:
      bucketName - Name of the bucket which contains the object
      objectName - Name of the object of that acl is related
      entity - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers
      generation - If present, selects a specific revision of this object
      Returns:
      an ObjectAccessControls

    • createObjectAccessControls

      @Named("ObjectAccessControls:insert") @POST @Produces("application/json") @Path("/b/{bucket}/o/{object}/acl") ObjectAccessControls createObjectAccessControls(@PathParam("bucket") String bucketName, @PathParam("object") @Encoded String objectName, 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 ObjectAccessControls resource with the following properties
      objectName - Name of the bucket of that acl is related
      Returns:
      an ObjectAccessControls

    • createObjectAccessControls

      @Named("ObjectAccessControls:insert") @POST @Produces("application/json") @Path("/b/{bucket}/o/{object}/acl") ObjectAccessControls createObjectAccessControls(@PathParam("bucket") String bucketName, @PathParam("object") @Encoded String objectName, ObjectAccessControlsTemplate template, @QueryParam("generation") Long generation)
      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 ObjectAccessControls resource with the following properties
      objectName - Name of the bucket of that acl is related
      generation - If present, selects a specific revision of this object
      Returns:
      an ObjectAccessControls

    • deleteObjectAccessControls

      @Named("ObjectAccessControls:delete") @DELETE @Path("/b/{bucket}/o/{object}/acl/{entity}") void deleteObjectAccessControls(@PathParam("bucket") String bucketName, @PathParam("object") @Encoded String objectName, @PathParam("entity") String entity)
      Permanently deletes the acl entry for the specified entity on the specified bucket.
      Parameters:
      bucketName - Name of the bucket which contains the object
      objectName - Name of the bucket of which acl is related
      entity - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers

    • deleteObjectAccessControls

      @Named("ObjectAccessControls:delete") @DELETE @Path("/b/{bucket}/o/{object}/acl/{entity}") void deleteObjectAccessControls(@PathParam("bucket") String bucketName, @PathParam("object") @Encoded String objectName, @PathParam("entity") String entity, @QueryParam("generation") Long generation)
      Permanently deletes the acl entry for the specified entity on the specified bucket.
      Parameters:
      bucketName - Name of the bucket which contains the object
      objectName - Name of the bucket of that acl is related
      entity - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers
      generation - If present, selects a specific revision of this object

    • listObjectAccessControls

      @Named("ObjectAccessControls:list") @GET @Produces("application/json") @Path("/b/{bucket}/o/{object}/acl") @Nullable List<ObjectAccessControls> listObjectAccessControls(@PathParam("bucket") String bucketName, @PathParam("object") @Encoded String objectName)
      Retrieves acl entries on a specified object
      Parameters:
      bucketName - Name of the bucket which contains the object
      objectName - Name of the bucket of that acl is related

    • listObjectAccessControls

      @Named("ObjectAccessControls:list") @GET @Produces("application/json") @Path("/b/{bucket}/o/{object}/acl") @Nullable List<ObjectAccessControls> listObjectAccessControls(@PathParam("bucket") String bucketName, @PathParam("object") @Encoded String objectName, @QueryParam("generation") Long generation)
      Retrieves acl entries on a specified object
      Parameters:
      bucketName - Name of the bucket which contains the object
      objectName - Name of the bucket of that acl is related
      generation - If present, selects a specific revision of this object

    • updateObjectAccessControls

      @Named("ObjectAccessControls:update") @PUT @Produces("application/json") @Path("/b/{bucket}/o/{object}/acl/{entity}") ObjectAccessControls updateObjectAccessControls(@PathParam("bucket") String bucketName, @PathParam("object") @Encoded String objectName, @PathParam("entity") String entity, ObjectAccessControlsTemplate template)
      Updates an acl entry on the specified object
      Parameters:
      bucketName - Name of the bucket of which contains the object
      objectName - Name of the object which acl is related
      entity - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
      template - Supply an ObjectAccessControlsTemplate
      Returns:
      an ObjectAccessControls

    • updateObjectAccessControls

      @Named("ObjectAccessControls:update") @PUT @Produces("application/json") @Path("/b/{bucket}/o/{object}/acl/{entity}") ObjectAccessControls updateObjectAccessControls(@PathParam("bucket") String bucketName, @PathParam("object") @Encoded String objectName, @PathParam("entity") String entity, ObjectAccessControlsTemplate template, @QueryParam("generation") Long generation)
      Updates an acl entry on the specified object
      Parameters:
      bucketName - Name of the bucket of which contains the object
      objectName - Name of the object which acl is related *
      entity - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers
      template - Supply an ObjectAccessControlsTemplate
      generation - If present, selects a specific revision of this object
      Returns:
      ObjectAccessControls

    • patchObjectAccessControls

      @Named("ObjectAccessControls:patch") @POST @Produces("application/json") @Path("/b/{bucket}/o/{object}/acl/{entity}") ObjectAccessControls patchObjectAccessControls(@PathParam("bucket") String bucketName, @PathParam("object") @Encoded String objectName, @PathParam("entity") String entity, ObjectAccessControlsTemplate template)
      Updates an acl entry on the specified object
      Parameters:
      bucketName - Name of the bucket of which contains the object
      objectName - Name of the object which acl is related
      entity - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
      template - Supply an ObjectAccessControlsTemplate
      Returns:
      an ObjectAccessControls

    • patchObjectAccessControls

      @Named("ObjectAccessControls:patch") @POST @Produces("application/json") @Path("/b/{bucket}/o/{object}/acl/{entity}") ObjectAccessControls patchObjectAccessControls(@PathParam("bucket") String bucketName, @PathParam("object") @Encoded String objectName, @PathParam("entity") String entity, ObjectAccessControlsTemplate template, @QueryParam("generation") Long generation)
      Updates an acl entry on the specified object
      Parameters:
      bucketName - Name of the bucket of which contains the object
      objectName - Name of the object which acl is related
      entity - The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers
      template - Supply an ObjectAccessControlsTemplate
      generation - If present, selects a specific revision of this object
      Returns:
      ObjectAccessControls