org.jclouds.googlecloudstorage.features
Interface DefaultObjectAccessControlsApi

public interface DefaultObjectAccessControlsApi

Provides access to DefaultObjectAccessControl entities via their REST API.

See Also:

Method Summary

DefaultObjectAccessControls	createDefaultObjectAccessControls(String bucketName, DefaultObjectAccessControlsTemplate template) Creates a new ACL entry for specified object
org.jclouds.http.HttpResponse	deleteDefaultObjectAccessControls(String bucketName, String entity) Permanently deletes the DefaultObjectAcessControl entry for the specified entity on the specified bucket.
DefaultObjectAccessControls	getDefaultObjectAccessControls(String bucketName, String entity) Returns the ACL entry for the specified entity on the specified object.
ListDefaultObjectAccessControls	listDefaultObjectAccessControls(String bucketName) Retrieves ACL entries on a specified object
DefaultObjectAccessControls	patchDefaultObjectAccessControls(String bucketName, String entity, DefaultObjectAccessControls payload) Retrieves ACL entries on a specified object
DefaultObjectAccessControls	updateDefaultObjectAccessControls(String bucketName, String entity, DefaultObjectAccessControls payload) Retrieves ACL entries on a specified object
DefaultObjectAccessControls	updateDefaultObjectAccessControls(String bucketName, String entity, DefaultObjectAccessControls payload, DomainResourceReferences.ObjectRole role) Retrieves ACL entries on a specified object

Method Detail

getDefaultObjectAccessControls

@Named(value="DefaultObjectAccessControls:get")
@Nullable
DefaultObjectAccessControls getDefaultObjectAccessControls(String bucketName,
                                                                          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(value="DefaultObjectAccessControls:insert")
DefaultObjectAccessControls createDefaultObjectAccessControls(String bucketName,
                                                                    DefaultObjectAccessControlsTemplate 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(value="DefaultObjectAccessControls:delete")
@Nullable
org.jclouds.http.HttpResponse deleteDefaultObjectAccessControls(String bucketName,
                                                                               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(value="DefaultObjectAccessControls:list")
@Nullable
ListDefaultObjectAccessControls listDefaultObjectAccessControls(String bucketName)

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

Returns:

ListObjectAccessControls resource

updateDefaultObjectAccessControls

@Named(value="DefaultObjectAccessControls:update")
DefaultObjectAccessControls updateDefaultObjectAccessControls(String bucketName,
                                                                    String entity,
                                                                    DefaultObjectAccessControls payload)

Retrieves ACL entries on a specified object

Parameters:

bucketName - Name of the bucket which contains the object

generation - If present, selects a specific revision of this object

Returns:

DefaultObjectAccessControls resource

updateDefaultObjectAccessControls

@Named(value="DefaultObjectAccessControls:update")
DefaultObjectAccessControls updateDefaultObjectAccessControls(String bucketName,
                                                                    String entity,
                                                                    DefaultObjectAccessControls payload,
                                                                    DomainResourceReferences.ObjectRole role)

Retrieves ACL entries on a specified object

Parameters:

bucketName - Name of the bucket which contains the object

generation - If present, selects a specific revision of this object

Returns:

DefaultObjectAccessControls resource

patchDefaultObjectAccessControls

@Named(value="DefaultObjectAccessControls:patch")
DefaultObjectAccessControls patchDefaultObjectAccessControls(String bucketName,
                                                                   String entity,
                                                                   DefaultObjectAccessControls payload)

Retrieves ACL entries on a specified object

Parameters:

bucketName - Name of the bucket which contains the object

generation - If present, selects a specific revision of this object

Returns:

DefaultObjectAccessControls resource