com.microsoft.windowsazure.services.blob.models

Class CreateContainerOptions

java.lang.Object

com.microsoft.windowsazure.services.blob.models.BlobServiceOptions

com.microsoft.windowsazure.services.blob.models.CreateContainerOptions

public class CreateContainerOptions
extends BlobServiceOptions

Represents the options that may be set on a createContainer request. These options include a server response timeout for the request, metadata to set on the container, and the public access level for container and blob data. Options that are not set will not be passed to the server with a request.

Constructor Summary

Constructors

Constructor and Description
CreateContainerOptions()

Method Summary

Modifier and Type	Method and Description
CreateContainerOptions	addMetadata(String key, String value) Adds a metadata name-value pair to the metadata collection associated with this CreateContainerOptions instance.
HashMap<String,String>	getMetadata() Gets the metadata collection associated with this CreateContainerOptions instance.
String	getPublicAccess() Gets the public access level value associated with this CreateContainerOptions instance.
CreateContainerOptions	setMetadata(HashMap<String,String> metadata) Sets the metadata collection associated with this CreateContainerOptions instance.
CreateContainerOptions	setPublicAccess(String publicAccess) Sets the public access level value associated with this CreateContainerOptions instance.
CreateContainerOptions	setTimeout(Integer timeout) Sets the server request timeout value associated with this CreateContainerOptions instance.

Methods inherited from class com.microsoft.windowsazure.services.blob.models.BlobServiceOptions

getTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateContainerOptions

public CreateContainerOptions()

Method Detail

setTimeout

public CreateContainerOptions setTimeout(Integer timeout)

Sets the server request timeout value associated with this CreateContainerOptions instance.

The timeout value only affects calls made on methods where this CreateContainerOptions instance is passed as a parameter.

Overrides:

setTimeout in class BlobServiceOptions

Parameters:

timeout - The server request timeout value to set in milliseconds.

Returns:

A reference to this CreateContainerOptions instance.

getMetadata

public HashMap<String,String> getMetadata()

Gets the metadata collection associated with this CreateContainerOptions instance.

Returns:

A HashMap of name-value pairs of String containing the names and values of the container metadata to set.

setMetadata

public CreateContainerOptions setMetadata(HashMap<String,String> metadata)

Sets the metadata collection associated with this CreateContainerOptions instance. Metadata is a collection of name-value String pairs for client use and is opaque to the server. Metadata names must adhere to the naming rules for C# identifiers.

The metadata value only affects calls made on methods where this CreateContainerOptions instance is passed as a parameter.

Parameters:

metadata - A HashMap of name-value pairs of String containing the names and values of the container metadata to set.

Returns:

A reference to this CreateContainerOptions instance.

addMetadata

public CreateContainerOptions addMetadata(String key,
                                          String value)

Adds a metadata name-value pair to the metadata collection associated with this CreateContainerOptions instance.

Parameters:

key - A String containing the name portion of the name-value pair to add to the metadata collection.

value - A String containing the value portion of the name-value pair to add to the metadata collection.

Returns:

A reference to this CreateContainerOptions instance.

getPublicAccess

public String getPublicAccess()

Gets the public access level value associated with this CreateContainerOptions instance. The public access level specifies whether data in the container may be accessed publicly and the level of access. Possible values include:

• container Specifies full public read access for container and blob data. Clients can enumerate blobs within the container via anonymous request, but cannot enumerate containers within the storage account.
• blob Specifies public read access for blobs. Blob data within this container can be read via anonymous request, but container data is not available. Clients cannot enumerate blobs within the container via anonymous request.

The default value of null sets the container data private to the storage account owner.

Returns:

A String containing the public access level value to set, or null.

setPublicAccess

public CreateContainerOptions setPublicAccess(String publicAccess)

Sets the public access level value associated with this CreateContainerOptions instance. The public access level specifies whether data in the container may be accessed publicly and the level of access. Possible values include:

• container Specifies full public read access for container and blob data. Clients can enumerate blobs within the container via anonymous request, but cannot enumerate containers within the storage account.
• blob Specifies public read access for blobs. Blob data within this container can be read via anonymous request, but container data is not available. Clients cannot enumerate blobs within the container via anonymous request.

The default value of null sets the container data private to the storage account owner.

The publicAccess value only affects calls made on methods where this CreateContainerOptions instance is passed as a parameter.

Parameters:

publicAccess - A String containing the public access level value to set, or null to set the container data private to the storage account owner.

Returns:

A reference to this CreateContainerOptions instance.