Constants Class

  • java.lang.Object
    • com.microsoft.azure.storage.Constants

public class Constants

RESERVED FOR INTERNAL USE. Contains storage constants.

Field Summary

Modifier and Type Field and Description
final String ACCESS_POLICY

XML element for an access policy.

final String ACCESS_TIER

XML element for access tier.

final String ACCESS_TIER_CHANGE_TIME

XML element for the access tier change time.

final String ACCESS_TIER_INFERRED

XML element for access if the access tier is inferred.

final String ARCHIVE_STATUS

XML element for the archive status.

final int BATCH_MAX_REQUESTS

Maximum number of requests that can be batched together.

final int BUFFER_COPY_LENGTH

Buffer width used to copy data to output streams.

final String COPY_COMPLETION_TIME_ELEMENT

XML element for the copy completion time.

final String COPY_DESTINATION_SNAPSHOT_ID_ELEMENT

XML element for the snapshot ID for the last successful incremental copy.

final String COPY_ID_ELEMENT

XML element for the copy id.

final String COPY_PROGRESS_ELEMENT

XML element for the copy progress.

final String COPY_SOURCE_ELEMENT

XML element for the copy source .

final String COPY_STATUS_DESCRIPTION_ELEMENT

XML element for the copy status description.

final String COPY_STATUS_ELEMENT

XML element for the copy status.

final int DEFAULT_MINIMUM_READ_SIZE_IN_BYTES

The default minimum read size, in bytes, for a BlobInputStream or FileInputStream.

final int DEFAULT_READ_TIMEOUT

Default read timeout. 5 min * 60 seconds * 1000 ms

final int DEFAULT_STREAM_WRITE_IN_BYTES

The default write size, in bytes, used by BlobOutputStream or FileOutputStream.

final String DELIMITER_ELEMENT

XML element for delimiters.

final String EMPTY_STRING

An empty to use for comparison.

final String END_ELEMENT

XML element for page range end elements.

final String ERROR_CODE

XML element for error codes.

final String ERROR_EXCEPTION

XML element for exception details.

final String ERROR_EXCEPTION_MESSAGE

XML element for exception messages.

final String ERROR_EXCEPTION_STACK_TRACE

XML element for stack traces.

final String ERROR_MESSAGE

XML element for error messages.

final String ERROR_ROOT_ELEMENT

XML root element for errors.

final String ETAG_ELEMENT

XML element for the ETag.

final String EXPIRY

XML element for the end time of an access policy.

final String FALSE

Constant for False.

final int GB

Constant representing a gigabyte (Non-SI version).

final String GEO_BOOTSTRAP_VALUE

Constant for bootstrap geo-replication status.

final String GEO_LIVE_VALUE

Constant for live geo-replication status.

final String GEO_UNAVAILABLE_VALUE

Constant for unavailable geo-replication status.

final String HTTP

Specifies HTTP.

final String HTTP_DELETE

Http DELETE method.

final String HTTP_GET

Http GET method.

final String HTTP_HEAD

Http HEAD method.

final String HTTP_POST

Http POST method.

final String HTTP_PUT

Http PUT method.

final String HTTPS

Specifies HTTPS.

final String HTTPS_HTTP

Specifies both HTTPS and HTTP.

final String ID

XML attribute for IDs.

final String INCREMENTAL_COPY_ELEMENT

XML element for the copy type.

final String INVALID_METADATA_NAME

XML element for an invalid metadata name.

final int KB

Constant representing a kilobyte (Non-SI version).

final String LAST_MODIFIED_ELEMENT

XML element for the last modified date.

final int LEASE_BREAK_PERIOD_MAX

Lease break period max in seconds.

final int LEASE_BREAK_PERIOD_MIN

Lease break period min in seconds.

final String LEASE_DURATION_ELEMENT

XML element for the lease duration.

final int LEASE_DURATION_MAX

Lease duration max in seconds.

final int LEASE_DURATION_MIN

Lease duration min in seconds.

final String LEASE_STATE_ELEMENT

XML element for the lease state.

final String LEASE_STATUS_ELEMENT

XML element for the lease status.

final String LOCKED_VALUE

Constant signaling the resource is locked.

final String MARKER_ELEMENT

XML element for a marker.

int MAX_APPEND_BLOCK_SIZE

The maximum size of an AppendBlob block.

final long MAX_BLOB_SIZE

The maximum size of a Block Blob.

final long MAX_BLOCK_NUMBER

The maximum number of blocks.

int MAX_BLOCK_SIZE

The maximum size of a BlockBlob block.

int MAX_FILE_WRITE_SIZE

The maximum write size for Files

final int MAX_MARK_LENGTH

The maximum size, in bytes, of a given stream mark operation.

int MAX_PAGE_WRITE_SIZE

The maximum write size that can uploaded to a PageBlob at once.

int MAX_RANGE_CONTENT_MD5

The maximum size for Range ContentMD5.

final String MAX_RESULTS_ELEMENT

XML element for maximum results.

final int MAX_SHARED_ACCESS_POLICY_IDENTIFIERS

Maximum number of shared access policy identifiers supported by server.

final int MAXIMUM_SEGMENTED_RESULTS

Number of default concurrent requests for parallel operation.

final int MB

Constant representing a megabyte (Non-SI version).

final String METADATA_ELEMENT

XML element for the metadata.

int MIN_LARGE_BLOCK_SIZE

The minimum size of a block for the large block upload strategy to be employed.

final int MIN_PERMITTED_BLOCK_SIZE

The minimum suggested size of a block.

int MIN_PERMITTED_FILE_WRITE_SIZE

The minimum suggested write size for Files.

final String NAME_ELEMENT

XML element for names.

final String NEXT_MARKER_ELEMENT

XML element for the next marker.

final int PAGE_SIZE

The size of a page, in bytes, in a page blob.

final String PERMISSION

XML element for the permission of an access policy.

final String PREFIX_ELEMENT

XML element for a prefix.

final String PREFIX_FOR_STORAGE_HEADER

The master Microsoft Azure Storage header prefix.

final String PROPERTIES

XML element for properties.

final String PUBLIC_ACCESS_ELEMENT

XML element for public access

final String SERVER_ENCRYPTION_STATUS_ELEMENT

XML element for the server encryption status.

final String SIGNED_EXPIRY_ELEMENT

The XML element for the signed expiration time.

final String SIGNED_IDENTIFIER_ELEMENT

XML element for a signed identifier.

final String SIGNED_IDENTIFIERS_ELEMENT

XML element for signed identifiers.

final String SIGNED_OID_ELEMENT

The XML element for the signed object ID.

final String SIGNED_SERVICE_ELEMENT

The XML element for the storage service used by this key.

final String SIGNED_START_ELEMENT

The XML element for the signed start time.

final String SIGNED_TID_ELEMENT

The XML element for the signed tenant ID.

final String SIGNED_VERSION_ELEMENT

The XML element for the REST API version used to create the key.

final String START

XML element for the start time of an access policy.

final int SUBSTREAM_BUFFER_SIZE

The default read buffer size used by the SubStream class.

final String TRUE

Constant for True.

final String UNLOCKED_VALUE

Constant signaling the resource is unlocked.

final String UNSPECIFIED_VALUE

Constant signaling the resource lease duration, state or status is unspecified.

final String URL_ELEMENT

XML element for the URL.

final String UTF8_CHARSET

The default type for content-type and accept

final String VALUE_ELEMENT

The XML element for a generic value.

Field Details

ACCESS_POLICY

public static final String ACCESS_POLICY= "AccessPolicy"

XML element for an access policy.

ACCESS_TIER

public static final String ACCESS_TIER= "AccessTier"

XML element for access tier.

ACCESS_TIER_CHANGE_TIME

public static final String ACCESS_TIER_CHANGE_TIME= "AccessTierChangeTime"

XML element for the access tier change time.

ACCESS_TIER_INFERRED

public static final String ACCESS_TIER_INFERRED= "AccessTierInferred"

XML element for access if the access tier is inferred.

ARCHIVE_STATUS

public static final String ARCHIVE_STATUS= "ArchiveStatus"

XML element for the archive status.

BATCH_MAX_REQUESTS

public static final int BATCH_MAX_REQUESTS= 256

Maximum number of requests that can be batched together.

BUFFER_COPY_LENGTH

public static final int BUFFER_COPY_LENGTH= 8 * KB

Buffer width used to copy data to output streams.

COPY_COMPLETION_TIME_ELEMENT

public static final String COPY_COMPLETION_TIME_ELEMENT= "CopyCompletionTime"

XML element for the copy completion time.

COPY_DESTINATION_SNAPSHOT_ID_ELEMENT

public static final String COPY_DESTINATION_SNAPSHOT_ID_ELEMENT= "CopyDestinationSnapshot"

XML element for the snapshot ID for the last successful incremental copy.

COPY_ID_ELEMENT

public static final String COPY_ID_ELEMENT= "CopyId"

XML element for the copy id.

COPY_PROGRESS_ELEMENT

public static final String COPY_PROGRESS_ELEMENT= "CopyProgress"

XML element for the copy progress.

COPY_SOURCE_ELEMENT

public static final String COPY_SOURCE_ELEMENT= "CopySource"

XML element for the copy source .

COPY_STATUS_DESCRIPTION_ELEMENT

public static final String COPY_STATUS_DESCRIPTION_ELEMENT= "CopyStatusDescription"

XML element for the copy status description.

COPY_STATUS_ELEMENT

public static final String COPY_STATUS_ELEMENT= "CopyStatus"

XML element for the copy status.

DEFAULT_MINIMUM_READ_SIZE_IN_BYTES

public static final int DEFAULT_MINIMUM_READ_SIZE_IN_BYTES= 4 * Constants.MB

The default minimum read size, in bytes, for a BlobInputStream or FileInputStream.

DEFAULT_READ_TIMEOUT

public static final int DEFAULT_READ_TIMEOUT= 5 * 60 * 1000

Default read timeout. 5 min * 60 seconds * 1000 ms

DEFAULT_STREAM_WRITE_IN_BYTES

public static final int DEFAULT_STREAM_WRITE_IN_BYTES= 4 * Constants.MB

The default write size, in bytes, used by BlobOutputStream or FileOutputStream.

DELIMITER_ELEMENT

public static final String DELIMITER_ELEMENT= "Delimiter"

XML element for delimiters.

EMPTY_STRING

public static final String EMPTY_STRING= ""

An empty to use for comparison.

END_ELEMENT

public static final String END_ELEMENT= "End"

XML element for page range end elements.

ERROR_CODE

public static final String ERROR_CODE= "Code"

XML element for error codes.

ERROR_EXCEPTION

public static final String ERROR_EXCEPTION= "ExceptionDetails"

XML element for exception details.

ERROR_EXCEPTION_MESSAGE

public static final String ERROR_EXCEPTION_MESSAGE= "ExceptionMessage"

XML element for exception messages.

ERROR_EXCEPTION_STACK_TRACE

public static final String ERROR_EXCEPTION_STACK_TRACE= "StackTrace"

XML element for stack traces.

ERROR_MESSAGE

public static final String ERROR_MESSAGE= "Message"

XML element for error messages.

ERROR_ROOT_ELEMENT

public static final String ERROR_ROOT_ELEMENT= "Error"

XML root element for errors.

ETAG_ELEMENT

public static final String ETAG_ELEMENT= "Etag"

XML element for the ETag.

EXPIRY

public static final String EXPIRY= "Expiry"

XML element for the end time of an access policy.

FALSE

public static final String FALSE= "false"

Constant for False.

GB

public static final int GB= 1024 * MB

Constant representing a gigabyte (Non-SI version).

GEO_BOOTSTRAP_VALUE

public static final String GEO_BOOTSTRAP_VALUE= "bootstrap"

Constant for bootstrap geo-replication status.

GEO_LIVE_VALUE

public static final String GEO_LIVE_VALUE= "live"

Constant for live geo-replication status.

GEO_UNAVAILABLE_VALUE

public static final String GEO_UNAVAILABLE_VALUE= "unavailable"

Constant for unavailable geo-replication status.

HTTP

public static final String HTTP= "http"

Specifies HTTP.

HTTP_DELETE

public static final String HTTP_DELETE= "DELETE"

Http DELETE method.

HTTP_GET

public static final String HTTP_GET= "GET"

Http GET method.

HTTP_HEAD

public static final String HTTP_HEAD= "HEAD"

Http HEAD method.

HTTP_POST

public static final String HTTP_POST= "POST"

Http POST method.

HTTP_PUT

public static final String HTTP_PUT= "PUT"

Http PUT method.

HTTPS

public static final String HTTPS= "https"

Specifies HTTPS.

HTTPS_HTTP

public static final String HTTPS_HTTP= "https,http"

Specifies both HTTPS and HTTP.

ID

public static final String ID= "Id"

XML attribute for IDs.

INCREMENTAL_COPY_ELEMENT

public static final String INCREMENTAL_COPY_ELEMENT= "IncrementalCopy"

XML element for the copy type.

INVALID_METADATA_NAME

public static final String INVALID_METADATA_NAME= "x-ms-invalid-name"

XML element for an invalid metadata name.

KB

public static final int KB= 1024

Constant representing a kilobyte (Non-SI version).

LAST_MODIFIED_ELEMENT

public static final String LAST_MODIFIED_ELEMENT= "Last-Modified"

XML element for the last modified date.

LEASE_BREAK_PERIOD_MAX

public static final int LEASE_BREAK_PERIOD_MAX= 60

Lease break period max in seconds.

LEASE_BREAK_PERIOD_MIN

public static final int LEASE_BREAK_PERIOD_MIN= 0

Lease break period min in seconds.

LEASE_DURATION_ELEMENT

public static final String LEASE_DURATION_ELEMENT= "LeaseDuration"

XML element for the lease duration.

LEASE_DURATION_MAX

public static final int LEASE_DURATION_MAX= 60

Lease duration max in seconds.

LEASE_DURATION_MIN

public static final int LEASE_DURATION_MIN= 15

Lease duration min in seconds.

LEASE_STATE_ELEMENT

public static final String LEASE_STATE_ELEMENT= "LeaseState"

XML element for the lease state.

LEASE_STATUS_ELEMENT

public static final String LEASE_STATUS_ELEMENT= "LeaseStatus"

XML element for the lease status.

LOCKED_VALUE

public static final String LOCKED_VALUE= "Locked"

Constant signaling the resource is locked.

MARKER_ELEMENT

public static final String MARKER_ELEMENT= "Marker"

XML element for a marker.

MAX_APPEND_BLOCK_SIZE

public static int MAX_APPEND_BLOCK_SIZE= 4 * MB

The maximum size of an AppendBlob block.

MAX_BLOB_SIZE

public static final long MAX_BLOB_SIZE= Constants.MAX_BLOCK_NUMBER * Constants.MAX_BLOCK_SIZE

The maximum size of a Block Blob.

MAX_BLOCK_NUMBER

public static final long MAX_BLOCK_NUMBER= 50000

The maximum number of blocks.

MAX_BLOCK_SIZE

public static int MAX_BLOCK_SIZE= 100 * MB

The maximum size of a BlockBlob block.

MAX_FILE_WRITE_SIZE

public static int MAX_FILE_WRITE_SIZE= 4 * MB

The maximum write size for Files

MAX_MARK_LENGTH

public static final int MAX_MARK_LENGTH= 256 * MB

The maximum size, in bytes, of a given stream mark operation.

MAX_PAGE_WRITE_SIZE

public static int MAX_PAGE_WRITE_SIZE= 4 * MB

The maximum write size that can uploaded to a PageBlob at once.

MAX_RANGE_CONTENT_MD5

public static int MAX_RANGE_CONTENT_MD5= 4 * MB

The maximum size for Range ContentMD5.

MAX_RESULTS_ELEMENT

public static final String MAX_RESULTS_ELEMENT= "MaxResults"

XML element for maximum results.

MAX_SHARED_ACCESS_POLICY_IDENTIFIERS

public static final int MAX_SHARED_ACCESS_POLICY_IDENTIFIERS= 5

Maximum number of shared access policy identifiers supported by server.

MAXIMUM_SEGMENTED_RESULTS

public static final int MAXIMUM_SEGMENTED_RESULTS= 5000

Number of default concurrent requests for parallel operation.

MB

public static final int MB= 1024 * KB

Constant representing a megabyte (Non-SI version).

METADATA_ELEMENT

public static final String METADATA_ELEMENT= "Metadata"

XML element for the metadata.

MIN_LARGE_BLOCK_SIZE

public static int MIN_LARGE_BLOCK_SIZE= (4 * Constants.MB) + 1

The minimum size of a block for the large block upload strategy to be employed.

MIN_PERMITTED_BLOCK_SIZE

public static final int MIN_PERMITTED_BLOCK_SIZE= 16 * Constants.KB

The minimum suggested size of a block.

MIN_PERMITTED_FILE_WRITE_SIZE

public static int MIN_PERMITTED_FILE_WRITE_SIZE= 512

The minimum suggested write size for Files.

NAME_ELEMENT

public static final String NAME_ELEMENT= "Name"

XML element for names.

NEXT_MARKER_ELEMENT

public static final String NEXT_MARKER_ELEMENT= "NextMarker"

XML element for the next marker.

PAGE_SIZE

public static final int PAGE_SIZE= 512

The size of a page, in bytes, in a page blob.

PERMISSION

public static final String PERMISSION= "Permission"

XML element for the permission of an access policy.

PREFIX_ELEMENT

public static final String PREFIX_ELEMENT= "Prefix"

XML element for a prefix.

PREFIX_FOR_STORAGE_HEADER

public static final String PREFIX_FOR_STORAGE_HEADER= "x-ms-"

The master Microsoft Azure Storage header prefix.

PROPERTIES

public static final String PROPERTIES= "Properties"

XML element for properties.

PUBLIC_ACCESS_ELEMENT

public static final String PUBLIC_ACCESS_ELEMENT= "PublicAccess"

XML element for public access

SERVER_ENCRYPTION_STATUS_ELEMENT

public static final String SERVER_ENCRYPTION_STATUS_ELEMENT= "ServerEncrypted"

XML element for the server encryption status.

SIGNED_EXPIRY_ELEMENT

public static final String SIGNED_EXPIRY_ELEMENT= "SignedExpiry"

The XML element for the signed expiration time.

SIGNED_IDENTIFIER_ELEMENT

public static final String SIGNED_IDENTIFIER_ELEMENT= "SignedIdentifier"

XML element for a signed identifier.

SIGNED_IDENTIFIERS_ELEMENT

public static final String SIGNED_IDENTIFIERS_ELEMENT= "SignedIdentifiers"

XML element for signed identifiers.

SIGNED_OID_ELEMENT

public static final String SIGNED_OID_ELEMENT= "SignedOid"

The XML element for the signed object ID.

SIGNED_SERVICE_ELEMENT

public static final String SIGNED_SERVICE_ELEMENT= "SignedService"

The XML element for the storage service used by this key.

SIGNED_START_ELEMENT

public static final String SIGNED_START_ELEMENT= "SignedStart"

The XML element for the signed start time.

SIGNED_TID_ELEMENT

public static final String SIGNED_TID_ELEMENT= "SignedTid"

The XML element for the signed tenant ID.

SIGNED_VERSION_ELEMENT

public static final String SIGNED_VERSION_ELEMENT= "SignedVersion"

The XML element for the REST API version used to create the key.

START

public static final String START= "Start"

XML element for the start time of an access policy.

SUBSTREAM_BUFFER_SIZE

public static final int SUBSTREAM_BUFFER_SIZE= 4 * Constants.MB

The default read buffer size used by the SubStream class.

TRUE

public static final String TRUE= "true"

Constant for True.

UNLOCKED_VALUE

public static final String UNLOCKED_VALUE= "Unlocked"

Constant signaling the resource is unlocked.

UNSPECIFIED_VALUE

public static final String UNSPECIFIED_VALUE= "Unspecified"

Constant signaling the resource lease duration, state or status is unspecified.

URL_ELEMENT

public static final String URL_ELEMENT= "Url"

XML element for the URL.

UTF8_CHARSET

public static final String UTF8_CHARSET= "UTF-8"

The default type for content-type and accept

VALUE_ELEMENT

public static final String VALUE_ELEMENT= "Value"

The XML element for a generic value.

Applies to