public interface AzureBlobClient
All commands return a Future of the result from Azure Blob. Any exceptions incurred during
processing will be backend in an ExecutionException
as documented in Future#get()
.
Modifier and Type | Method and Description |
---|---|
boolean |
blobExists(String container,
String name) |
boolean |
containerExists(String container)
Issues a HEAD command to determine if the container exists or not.
|
boolean |
createContainer(String container,
CreateContainerOptions... options)
The Create Container operation creates a new container under the specified identity.
|
boolean |
createRootContainer(CreateContainerOptions... options)
The root container is a default container that may be inferred from a URL requesting a blob
resource.
|
void |
deleteBlob(String container,
String name)
The Delete Blob operation marks the specified blob for deletion.
|
void |
deleteContainer(String container)
The Delete Container operation marks the specified container for deletion.
|
void |
deleteRootContainer()
The Delete Container operation marks the specified container for deletion.
|
AzureBlob |
getBlob(String container,
String name,
GetOptions... options)
The Get Blob operation reads or downloads a blob from the system, including its metadata and
properties.
|
BlobProperties |
getBlobProperties(String container,
String name)
The Get Blob Properties operation returns all user-defined metadata, standard HTTP properties,
and system properties for the blob.
|
ContainerProperties |
getContainerProperties(String container)
The Get Container Properties operation returns all user-defined metadata and system properties
for the specified container.
|
PublicAccess |
getPublicAccessForContainer(String container) |
ListBlobsResponse |
listBlobs(ListBlobsOptions... options) |
ListBlobsResponse |
listBlobs(String container,
ListBlobsOptions... options)
The List Blobs operation enumerates the list of blobs under the specified container.
|
BoundedSet<ContainerProperties> |
listContainers(ListOptions... listOptions)
The List Containers operation returns a list of the containers under the specified identity.
|
AzureBlob |
newBlob() |
String |
putBlob(String container,
AzureBlob object)
The Put Blob operation creates a new blob or updates the content of an existing blob.
|
void |
setBlobMetadata(String container,
String name,
Map<String,String> metadata) |
void |
setResourceMetadata(String container,
Map<String,String> metadata)
The Set Container Metadata operation sets one or more user-defined name/value pairs for the
specified container.
|
@Provides AzureBlob newBlob()
BoundedSet<ContainerProperties> listContainers(ListOptions... listOptions)
The 2009-07-17 version of the List Containers operation times out after 30 seconds.
listOptions
- controls the number or type of results requestedListOptions
boolean createContainer(String container, CreateContainerOptions... options)
The container resource includes metadata and properties for that container. It does not include a list of the blobs contained by the container.
CreateContainerOptions
ContainerProperties getContainerProperties(String container)
boolean containerExists(String container)
void setResourceMetadata(String container, Map<String,String> metadata)
You may also set metadata for a container at the time it is created.
Calling Set Container Metadata updates the ETag for the container.
void deleteContainer(String container)
When a container is deleted, a container with the same name cannot be created for at least 30 seconds; the container may not be available for more than 30 seconds if the service is still processing the request. While the container is being deleted, attempts to create a container of the same name will fail with status code 409 (Conflict), with the service returning additional error information indicating that the container is being deleted. All other operations, including operations on any blobs under the container, will fail with status code 404 (Not Found) while the container is being deleted.
boolean createRootContainer(CreateContainerOptions... options)
The container resource includes metadata and properties for that container. It does not include a list of the blobs contained by the container.
CreateContainerOptions
PublicAccess getPublicAccessForContainer(String container)
container
- void deleteRootContainer()
deleteContainer(String)
,
createRootContainer(CreateContainerOptions)
ListBlobsResponse listBlobs(String container, ListBlobsOptions... options)
Note that the value of NextMarker should be treated as opaque.
The delimiter parameter enables the caller to traverse the blob keyspace by using a user-configured delimiter. The delimiter may be a single character or a string. When the request includes this parameter, the operation returns a BlobPrefix element. The BlobPrefix element is returned in place of all blobs whose keys begin with the same substring up to the appearance of the delimiter character. The value of the BlobPrefix element is substring+delimiter, where substring is the common substring that begins one or more blob keys, and delimiter is the value of the delimiter parameter.
You can use the value of BlobPrefix to make a subsequent call to list the blobs that begin with this prefix, by specifying the value of BlobPrefix for the prefix parameter on the request URI. In this way, you can traverse a virtual hierarchy of blobs as though it were a file system.
Note that each BlobPrefix element returned counts toward the maximum result, just as each Blob element does.
Blobs are listed in alphabetical order in the response body.
ListBlobsResponse listBlobs(ListBlobsOptions... options)
String putBlob(String container, AzureBlob object)
Updating an existing blob overwrites any existing metadata on the blob. Partial updates are not supported; the content of the existing blob is overwritten with the content of the new blob.
If you attempt to upload a blob that is larger than 64 MB, the service returns status code 413 (Request Payload Too Large). The Blob service also returns additional information about the error in the response, including the maximum blob size permitted in bytes.
AzureBlob getBlob(String container, String name, GetOptions... options)
BlobProperties getBlobProperties(String container, String name)
void deleteBlob(String container, String name)
Copyright © 2009-2013 The Apache Software Foundation. All Rights Reserved.