azure-docs-sdk-java/docs-ref-autogen/com.azure.storage.blob.mode...

854 строки
69 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.storage.blob.models.BlobQueryHeaders"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders"
name: "BlobQueryHeaders"
nameWithType: "BlobQueryHeaders"
summary: "Defines headers for Query operation."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **BlobQueryHeaders**"
constructors:
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.BlobQueryHeaders()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.BlobQueryHeaders()"
name: "BlobQueryHeaders()"
nameWithType: "BlobQueryHeaders.BlobQueryHeaders()"
summary: "Constructs a new instance of <xref uid=\"com.azure.storage.blob.models.BlobQueryHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobQueryHeaders\"></xref>."
syntax: "public BlobQueryHeaders()"
desc: "Constructs a new instance of <xref uid=\"com.azure.storage.blob.models.BlobQueryHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobQueryHeaders\"></xref>."
methods:
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getAcceptRanges()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getAcceptRanges()"
name: "getAcceptRanges()"
nameWithType: "BlobQueryHeaders.getAcceptRanges()"
summary: "Get the accept<wbr>Ranges property: Indicates that the service supports requests for partial blob content."
syntax: "public String getAcceptRanges()"
desc: "Get the acceptRanges property: Indicates that the service supports requests for partial blob content."
returns:
description: "the acceptRanges value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getBlobCommittedBlockCount()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getBlobCommittedBlockCount()"
name: "getBlobCommittedBlockCount()"
nameWithType: "BlobQueryHeaders.getBlobCommittedBlockCount()"
summary: "Get the blob<wbr>Committed<wbr>Block<wbr>Count property: The number of committed blocks present in the blob."
syntax: "public Integer getBlobCommittedBlockCount()"
desc: "Get the blobCommittedBlockCount property: The number of committed blocks present in the blob. This header is returned only for append blobs."
returns:
description: "the blobCommittedBlockCount value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getBlobContentMd5()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getBlobContentMd5()"
name: "getBlobContentMd5()"
nameWithType: "BlobQueryHeaders.getBlobContentMd5()"
summary: "Get the blob<wbr>Content<wbr>Md5 property: If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value."
syntax: "public byte[] getBlobContentMd5()"
desc: "Get the blobContentMd5 property: If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range."
returns:
description: "the blobContentMd5 value."
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getBlobSequenceNumber()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getBlobSequenceNumber()"
name: "getBlobSequenceNumber()"
nameWithType: "BlobQueryHeaders.getBlobSequenceNumber()"
summary: "Get the blob<wbr>Sequence<wbr>Number property: The current sequence number for a page blob."
syntax: "public Long getBlobSequenceNumber()"
desc: "Get the blobSequenceNumber property: The current sequence number for a page blob. This header is not returned for block blobs or append blobs."
returns:
description: "the blobSequenceNumber value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getBlobType()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getBlobType()"
name: "getBlobType()"
nameWithType: "BlobQueryHeaders.getBlobType()"
summary: "Get the blob<wbr>Type property: The blob's type."
syntax: "public BlobType getBlobType()"
desc: "Get the blobType property: The blob's type. Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'."
returns:
description: "the blobType value."
type: "<xref href=\"com.azure.storage.blob.models.BlobType?alt=com.azure.storage.blob.models.BlobType&text=BlobType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getCacheControl()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getCacheControl()"
name: "getCacheControl()"
nameWithType: "BlobQueryHeaders.getCacheControl()"
summary: "Get the cache<wbr>Control property: This header is returned if it was previously specified for the blob."
syntax: "public String getCacheControl()"
desc: "Get the cacheControl property: This header is returned if it was previously specified for the blob."
returns:
description: "the cacheControl value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getClientRequestId()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getClientRequestId()"
name: "getClientRequestId()"
nameWithType: "BlobQueryHeaders.getClientRequestId()"
summary: "Get the client<wbr>Request<wbr>Id property: If a client request id header is sent in the request, this header will be present in the response with the same value."
syntax: "public String getClientRequestId()"
desc: "Get the clientRequestId property: If a client request id header is sent in the request, this header will be present in the response with the same value."
returns:
description: "the clientRequestId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getContentCrc64()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getContentCrc64()"
name: "getContentCrc64()"
nameWithType: "BlobQueryHeaders.getContentCrc64()"
summary: "Get the content<wbr>Crc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB."
syntax: "public byte[] getContentCrc64()"
desc: "Get the contentCrc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 and x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request)."
returns:
description: "the contentCrc64 value."
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getContentDisposition()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getContentDisposition()"
name: "getContentDisposition()"
nameWithType: "BlobQueryHeaders.getContentDisposition()"
summary: "Get the content<wbr>Disposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header."
syntax: "public String getContentDisposition()"
desc: "Get the contentDisposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified."
returns:
description: "the contentDisposition value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getContentEncoding()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getContentEncoding()"
name: "getContentEncoding()"
nameWithType: "BlobQueryHeaders.getContentEncoding()"
summary: "Get the content<wbr>Encoding property: This header returns the value that was specified for the Content-Encoding request header."
syntax: "public String getContentEncoding()"
desc: "Get the contentEncoding property: This header returns the value that was specified for the Content-Encoding request header."
returns:
description: "the contentEncoding value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getContentLanguage()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getContentLanguage()"
name: "getContentLanguage()"
nameWithType: "BlobQueryHeaders.getContentLanguage()"
summary: "Get the content<wbr>Language property: This header returns the value that was specified for the Content-Language request header."
syntax: "public String getContentLanguage()"
desc: "Get the contentLanguage property: This header returns the value that was specified for the Content-Language request header."
returns:
description: "the contentLanguage value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getContentLength()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getContentLength()"
name: "getContentLength()"
nameWithType: "BlobQueryHeaders.getContentLength()"
summary: "Get the content<wbr>Length property: The number of bytes present in the response body."
syntax: "public Long getContentLength()"
desc: "Get the contentLength property: The number of bytes present in the response body."
returns:
description: "the contentLength value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getContentMd5()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getContentMd5()"
name: "getContentMd5()"
nameWithType: "BlobQueryHeaders.getContentMd5()"
summary: "Get the content<wbr>Md5 property: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
syntax: "public byte[] getContentMd5()"
desc: "Get the contentMd5 property: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
returns:
description: "the contentMd5 value."
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getContentRange()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getContentRange()"
name: "getContentRange()"
nameWithType: "BlobQueryHeaders.getContentRange()"
summary: "Get the content<wbr>Range property: Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header."
syntax: "public String getContentRange()"
desc: "Get the contentRange property: Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header."
returns:
description: "the contentRange value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getContentType()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getContentType()"
name: "getContentType()"
nameWithType: "BlobQueryHeaders.getContentType()"
summary: "Get the content<wbr>Type property: The media type of the body of the response."
syntax: "public String getContentType()"
desc: "Get the contentType property: The media type of the body of the response. For Download Blob this is 'application/octet-stream'."
returns:
description: "the contentType value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getCopyCompletionTime()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getCopyCompletionTime()"
name: "getCopyCompletionTime()"
nameWithType: "BlobQueryHeaders.getCopyCompletionTime()"
summary: "Get the copy<wbr>Completion<wbr>Time property: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob."
syntax: "public OffsetDateTime getCopyCompletionTime()"
desc: "Get the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the copyCompletionTime value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getCopyId()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getCopyId()"
name: "getCopyId()"
nameWithType: "BlobQueryHeaders.getCopyId()"
summary: "Get the copy<wbr>Id property: String identifier for this copy operation."
syntax: "public String getCopyId()"
desc: "Get the copyId property: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy."
returns:
description: "the copyId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getCopyProgress()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getCopyProgress()"
name: "getCopyProgress()"
nameWithType: "BlobQueryHeaders.getCopyProgress()"
summary: "Get the copy<wbr>Progress property: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob."
syntax: "public String getCopyProgress()"
desc: "Get the copyProgress property: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the copyProgress value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getCopySource()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getCopySource()"
name: "getCopySource()"
nameWithType: "BlobQueryHeaders.getCopySource()"
summary: "Get the copy<wbr>Source property: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob."
syntax: "public String getCopySource()"
desc: "Get the copySource property: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the copySource value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getCopyStatus()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getCopyStatus()"
name: "getCopyStatus()"
nameWithType: "BlobQueryHeaders.getCopyStatus()"
summary: "Get the copy<wbr>Status property: State of the copy operation identified by x-ms-copy-id."
syntax: "public CopyStatusType getCopyStatus()"
desc: "Get the copyStatus property: State of the copy operation identified by x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted', 'failed'."
returns:
description: "the copyStatus value."
type: "<xref href=\"com.azure.storage.blob.models.CopyStatusType?alt=com.azure.storage.blob.models.CopyStatusType&text=CopyStatusType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getCopyStatusDescription()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getCopyStatusDescription()"
name: "getCopyStatusDescription()"
nameWithType: "BlobQueryHeaders.getCopyStatusDescription()"
summary: "Get the copy<wbr>Status<wbr>Description property: Only appears when x-ms-copy-status is failed or pending."
syntax: "public String getCopyStatusDescription()"
desc: "Get the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the copyStatusDescription value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getDateProperty()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getDateProperty()"
name: "getDateProperty()"
nameWithType: "BlobQueryHeaders.getDateProperty()"
summary: "Get the date<wbr>Property property: UTC date/time value generated by the service that indicates the time at which the response was initiated."
syntax: "public OffsetDateTime getDateProperty()"
desc: "Get the dateProperty property: UTC date/time value generated by the service that indicates the time at which the response was initiated."
returns:
description: "the dateProperty value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getETag()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getETag()"
name: "getETag()"
nameWithType: "BlobQueryHeaders.getETag()"
summary: "Get the e<wbr>Tag property: The ETag contains a value that you can use to perform operations conditionally."
syntax: "public String getETag()"
desc: "Get the eTag property: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
returns:
description: "the eTag value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getEncryptionKeySha256()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getEncryptionKeySha256()"
name: "getEncryptionKeySha256()"
nameWithType: "BlobQueryHeaders.getEncryptionKeySha256()"
summary: "Get the encryption<wbr>Key<wbr>Sha256 property: The SHA-256 hash of the encryption key used to encrypt the blob."
syntax: "public String getEncryptionKeySha256()"
desc: "Get the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key."
returns:
description: "the encryptionKeySha256 value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getEncryptionScope()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getEncryptionScope()"
name: "getEncryptionScope()"
nameWithType: "BlobQueryHeaders.getEncryptionScope()"
summary: "Get the encryption<wbr>Scope property: Returns the name of the encryption scope used to encrypt the blob contents and application metadata."
syntax: "public String getEncryptionScope()"
desc: "Get the encryptionScope property: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope."
returns:
description: "the encryptionScope value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getErrorCode()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getErrorCode()"
name: "getErrorCode()"
nameWithType: "BlobQueryHeaders.getErrorCode()"
summary: "Get the error<wbr>Code property: The error<wbr>Code property."
syntax: "public String getErrorCode()"
desc: "Get the errorCode property: The errorCode property."
returns:
description: "the errorCode value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getLastModified()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getLastModified()"
name: "getLastModified()"
nameWithType: "BlobQueryHeaders.getLastModified()"
summary: "Get the last<wbr>Modified property: Returns the date and time the container was last modified."
syntax: "public OffsetDateTime getLastModified()"
desc: "Get the lastModified property: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
returns:
description: "the lastModified value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getLeaseDuration()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getLeaseDuration()"
name: "getLeaseDuration()"
nameWithType: "BlobQueryHeaders.getLeaseDuration()"
summary: "Get the lease<wbr>Duration property: When a blob is leased, specifies whether the lease is of infinite or fixed duration."
syntax: "public LeaseDurationType getLeaseDuration()"
desc: "Get the leaseDuration property: When a blob is leased, specifies whether the lease is of infinite or fixed duration. Possible values include: 'infinite', 'fixed'."
returns:
description: "the leaseDuration value."
type: "<xref href=\"com.azure.storage.blob.models.LeaseDurationType?alt=com.azure.storage.blob.models.LeaseDurationType&text=LeaseDurationType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getLeaseState()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getLeaseState()"
name: "getLeaseState()"
nameWithType: "BlobQueryHeaders.getLeaseState()"
summary: "Get the lease<wbr>State property: Lease state of the blob."
syntax: "public LeaseStateType getLeaseState()"
desc: "Get the leaseState property: Lease state of the blob. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'."
returns:
description: "the leaseState value."
type: "<xref href=\"com.azure.storage.blob.models.LeaseStateType?alt=com.azure.storage.blob.models.LeaseStateType&text=LeaseStateType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getLeaseStatus()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getLeaseStatus()"
name: "getLeaseStatus()"
nameWithType: "BlobQueryHeaders.getLeaseStatus()"
summary: "Get the lease<wbr>Status property: The current lease status of the blob."
syntax: "public LeaseStatusType getLeaseStatus()"
desc: "Get the leaseStatus property: The current lease status of the blob. Possible values include: 'locked', 'unlocked'."
returns:
description: "the leaseStatus value."
type: "<xref href=\"com.azure.storage.blob.models.LeaseStatusType?alt=com.azure.storage.blob.models.LeaseStatusType&text=LeaseStatusType\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getMetadata()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getMetadata()"
name: "getMetadata()"
nameWithType: "BlobQueryHeaders.getMetadata()"
summary: "Get the metadata property: The metadata property."
syntax: "public Map<String,String> getMetadata()"
desc: "Get the metadata property: The metadata property."
returns:
description: "the metadata value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getRequestId()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getRequestId()"
name: "getRequestId()"
nameWithType: "BlobQueryHeaders.getRequestId()"
summary: "Get the request<wbr>Id property: This header uniquely identifies the request that was made and can be used for troubleshooting the request."
syntax: "public String getRequestId()"
desc: "Get the requestId property: This header uniquely identifies the request that was made and can be used for troubleshooting the request."
returns:
description: "the requestId value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.getVersion()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.getVersion()"
name: "getVersion()"
nameWithType: "BlobQueryHeaders.getVersion()"
summary: "Get the version property: Indicates the version of the Blob service used to execute the request."
syntax: "public String getVersion()"
desc: "Get the version property: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
returns:
description: "the version value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.isServerEncrypted()"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.isServerEncrypted()"
name: "isServerEncrypted()"
nameWithType: "BlobQueryHeaders.isServerEncrypted()"
summary: "Get the server<wbr>Encrypted property: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm."
syntax: "public Boolean isServerEncrypted()"
desc: "Get the serverEncrypted property: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)."
returns:
description: "the serverEncrypted value."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setAcceptRanges(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setAcceptRanges(String acceptRanges)"
name: "setAcceptRanges(String acceptRanges)"
nameWithType: "BlobQueryHeaders.setAcceptRanges(String acceptRanges)"
summary: "Set the accept<wbr>Ranges property: Indicates that the service supports requests for partial blob content."
parameters:
- description: "the acceptRanges value to set."
name: "acceptRanges"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setAcceptRanges(String acceptRanges)"
desc: "Set the acceptRanges property: Indicates that the service supports requests for partial blob content."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setBlobCommittedBlockCount(java.lang.Integer)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setBlobCommittedBlockCount(Integer blobCommittedBlockCount)"
name: "setBlobCommittedBlockCount(Integer blobCommittedBlockCount)"
nameWithType: "BlobQueryHeaders.setBlobCommittedBlockCount(Integer blobCommittedBlockCount)"
summary: "Set the blob<wbr>Committed<wbr>Block<wbr>Count property: The number of committed blocks present in the blob."
parameters:
- description: "the blobCommittedBlockCount value to set."
name: "blobCommittedBlockCount"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
syntax: "public BlobQueryHeaders setBlobCommittedBlockCount(Integer blobCommittedBlockCount)"
desc: "Set the blobCommittedBlockCount property: The number of committed blocks present in the blob. This header is returned only for append blobs."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setBlobContentMd5(byte[])"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setBlobContentMd5(byte[] blobContentMd5)"
name: "setBlobContentMd5(byte[] blobContentMd5)"
nameWithType: "BlobQueryHeaders.setBlobContentMd5(byte[] blobContentMd5)"
summary: "Set the blob<wbr>Content<wbr>Md5 property: If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value."
parameters:
- description: "the blobContentMd5 value to set."
name: "blobContentMd5"
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
syntax: "public BlobQueryHeaders setBlobContentMd5(byte[] blobContentMd5)"
desc: "Set the blobContentMd5 property: If the blob has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole blob's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setBlobSequenceNumber(java.lang.Long)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setBlobSequenceNumber(Long blobSequenceNumber)"
name: "setBlobSequenceNumber(Long blobSequenceNumber)"
nameWithType: "BlobQueryHeaders.setBlobSequenceNumber(Long blobSequenceNumber)"
summary: "Set the blob<wbr>Sequence<wbr>Number property: The current sequence number for a page blob."
parameters:
- description: "the blobSequenceNumber value to set."
name: "blobSequenceNumber"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
syntax: "public BlobQueryHeaders setBlobSequenceNumber(Long blobSequenceNumber)"
desc: "Set the blobSequenceNumber property: The current sequence number for a page blob. This header is not returned for block blobs or append blobs."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setBlobType(com.azure.storage.blob.models.BlobType)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setBlobType(BlobType blobType)"
name: "setBlobType(BlobType blobType)"
nameWithType: "BlobQueryHeaders.setBlobType(BlobType blobType)"
summary: "Set the blob<wbr>Type property: The blob's type."
parameters:
- description: "the blobType value to set."
name: "blobType"
type: "<xref href=\"com.azure.storage.blob.models.BlobType?alt=com.azure.storage.blob.models.BlobType&text=BlobType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobQueryHeaders setBlobType(BlobType blobType)"
desc: "Set the blobType property: The blob's type. Possible values include: 'BlockBlob', 'PageBlob', 'AppendBlob'."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setCacheControl(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setCacheControl(String cacheControl)"
name: "setCacheControl(String cacheControl)"
nameWithType: "BlobQueryHeaders.setCacheControl(String cacheControl)"
summary: "Set the cache<wbr>Control property: This header is returned if it was previously specified for the blob."
parameters:
- description: "the cacheControl value to set."
name: "cacheControl"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setCacheControl(String cacheControl)"
desc: "Set the cacheControl property: This header is returned if it was previously specified for the blob."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setClientRequestId(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setClientRequestId(String clientRequestId)"
name: "setClientRequestId(String clientRequestId)"
nameWithType: "BlobQueryHeaders.setClientRequestId(String clientRequestId)"
summary: "Set the client<wbr>Request<wbr>Id property: If a client request id header is sent in the request, this header will be present in the response with the same value."
parameters:
- description: "the clientRequestId value to set."
name: "clientRequestId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setClientRequestId(String clientRequestId)"
desc: "Set the clientRequestId property: If a client request id header is sent in the request, this header will be present in the response with the same value."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setContentCrc64(byte[])"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setContentCrc64(byte[] contentCrc64)"
name: "setContentCrc64(byte[] contentCrc64)"
nameWithType: "BlobQueryHeaders.setContentCrc64(byte[] contentCrc64)"
summary: "Set the content<wbr>Crc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB."
parameters:
- description: "the contentCrc64 value to set."
name: "contentCrc64"
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
syntax: "public BlobQueryHeaders setContentCrc64(byte[] contentCrc64)"
desc: "Set the contentCrc64 property: If the request is to read a specified range and the x-ms-range-get-content-crc64 is set to true, then the request returns a crc64 for the range, as long as the range size is less than or equal to 4 MB. If both x-ms-range-get-content-crc64 and x-ms-range-get-content-md5 is specified in the same request, it will fail with 400(Bad Request)."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setContentDisposition(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setContentDisposition(String contentDisposition)"
name: "setContentDisposition(String contentDisposition)"
nameWithType: "BlobQueryHeaders.setContentDisposition(String contentDisposition)"
summary: "Set the content<wbr>Disposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header."
parameters:
- description: "the contentDisposition value to set."
name: "contentDisposition"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setContentDisposition(String contentDisposition)"
desc: "Set the contentDisposition property: This header returns the value that was specified for the 'x-ms-blob-content-disposition' header. The Content-Disposition response header field conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setContentEncoding(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setContentEncoding(String contentEncoding)"
name: "setContentEncoding(String contentEncoding)"
nameWithType: "BlobQueryHeaders.setContentEncoding(String contentEncoding)"
summary: "Set the content<wbr>Encoding property: This header returns the value that was specified for the Content-Encoding request header."
parameters:
- description: "the contentEncoding value to set."
name: "contentEncoding"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setContentEncoding(String contentEncoding)"
desc: "Set the contentEncoding property: This header returns the value that was specified for the Content-Encoding request header."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setContentLanguage(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setContentLanguage(String contentLanguage)"
name: "setContentLanguage(String contentLanguage)"
nameWithType: "BlobQueryHeaders.setContentLanguage(String contentLanguage)"
summary: "Set the content<wbr>Language property: This header returns the value that was specified for the Content-Language request header."
parameters:
- description: "the contentLanguage value to set."
name: "contentLanguage"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setContentLanguage(String contentLanguage)"
desc: "Set the contentLanguage property: This header returns the value that was specified for the Content-Language request header."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setContentLength(java.lang.Long)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setContentLength(Long contentLength)"
name: "setContentLength(Long contentLength)"
nameWithType: "BlobQueryHeaders.setContentLength(Long contentLength)"
summary: "Set the content<wbr>Length property: The number of bytes present in the response body."
parameters:
- description: "the contentLength value to set."
name: "contentLength"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
syntax: "public BlobQueryHeaders setContentLength(Long contentLength)"
desc: "Set the contentLength property: The number of bytes present in the response body."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setContentMd5(byte[])"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setContentMd5(byte[] contentMd5)"
name: "setContentMd5(byte[] contentMd5)"
nameWithType: "BlobQueryHeaders.setContentMd5(byte[] contentMd5)"
summary: "Set the content<wbr>Md5 property: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
parameters:
- description: "the contentMd5 value to set."
name: "contentMd5"
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
syntax: "public BlobQueryHeaders setContentMd5(byte[] contentMd5)"
desc: "Set the contentMd5 property: If the blob has an MD5 hash and this operation is to read the full blob, this response header is returned so that the client can check for message content integrity."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setContentRange(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setContentRange(String contentRange)"
name: "setContentRange(String contentRange)"
nameWithType: "BlobQueryHeaders.setContentRange(String contentRange)"
summary: "Set the content<wbr>Range property: Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header."
parameters:
- description: "the contentRange value to set."
name: "contentRange"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setContentRange(String contentRange)"
desc: "Set the contentRange property: Indicates the range of bytes returned in the event that the client requested a subset of the blob by setting the 'Range' request header."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setContentType(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setContentType(String contentType)"
name: "setContentType(String contentType)"
nameWithType: "BlobQueryHeaders.setContentType(String contentType)"
summary: "Set the content<wbr>Type property: The media type of the body of the response."
parameters:
- description: "the contentType value to set."
name: "contentType"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setContentType(String contentType)"
desc: "Set the contentType property: The media type of the body of the response. For Download Blob this is 'application/octet-stream'."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setCopyCompletionTime(java.time.OffsetDateTime)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setCopyCompletionTime(OffsetDateTime copyCompletionTime)"
name: "setCopyCompletionTime(OffsetDateTime copyCompletionTime)"
nameWithType: "BlobQueryHeaders.setCopyCompletionTime(OffsetDateTime copyCompletionTime)"
summary: "Set the copy<wbr>Completion<wbr>Time property: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob."
parameters:
- description: "the copyCompletionTime value to set."
name: "copyCompletionTime"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public BlobQueryHeaders setCopyCompletionTime(OffsetDateTime copyCompletionTime)"
desc: "Set the copyCompletionTime property: Conclusion time of the last attempted Copy Blob operation where this blob was the destination blob. This value can specify the time of a completed, aborted, or failed copy attempt. This header does not appear if a copy is pending, if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setCopyId(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setCopyId(String copyId)"
name: "setCopyId(String copyId)"
nameWithType: "BlobQueryHeaders.setCopyId(String copyId)"
summary: "Set the copy<wbr>Id property: String identifier for this copy operation."
parameters:
- description: "the copyId value to set."
name: "copyId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setCopyId(String copyId)"
desc: "Set the copyId property: String identifier for this copy operation. Use with Get Blob Properties to check the status of this copy operation, or pass to Abort Copy Blob to abort a pending copy."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setCopyProgress(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setCopyProgress(String copyProgress)"
name: "setCopyProgress(String copyProgress)"
nameWithType: "BlobQueryHeaders.setCopyProgress(String copyProgress)"
summary: "Set the copy<wbr>Progress property: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob."
parameters:
- description: "the copyProgress value to set."
name: "copyProgress"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setCopyProgress(String copyProgress)"
desc: "Set the copyProgress property: Contains the number of bytes copied and the total bytes in the source in the last attempted Copy Blob operation where this blob was the destination blob. Can show between 0 and Content-Length bytes copied. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setCopySource(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setCopySource(String copySource)"
name: "setCopySource(String copySource)"
nameWithType: "BlobQueryHeaders.setCopySource(String copySource)"
summary: "Set the copy<wbr>Source property: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob."
parameters:
- description: "the copySource value to set."
name: "copySource"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setCopySource(String copySource)"
desc: "Set the copySource property: URL up to 2 KB in length that specifies the source blob or file used in the last attempted Copy Blob operation where this blob was the destination blob. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setCopyStatus(com.azure.storage.blob.models.CopyStatusType)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setCopyStatus(CopyStatusType copyStatus)"
name: "setCopyStatus(CopyStatusType copyStatus)"
nameWithType: "BlobQueryHeaders.setCopyStatus(CopyStatusType copyStatus)"
summary: "Set the copy<wbr>Status property: State of the copy operation identified by x-ms-copy-id."
parameters:
- description: "the copyStatus value to set."
name: "copyStatus"
type: "<xref href=\"com.azure.storage.blob.models.CopyStatusType?alt=com.azure.storage.blob.models.CopyStatusType&text=CopyStatusType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobQueryHeaders setCopyStatus(CopyStatusType copyStatus)"
desc: "Set the copyStatus property: State of the copy operation identified by x-ms-copy-id. Possible values include: 'pending', 'success', 'aborted', 'failed'."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setCopyStatusDescription(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setCopyStatusDescription(String copyStatusDescription)"
name: "setCopyStatusDescription(String copyStatusDescription)"
nameWithType: "BlobQueryHeaders.setCopyStatusDescription(String copyStatusDescription)"
summary: "Set the copy<wbr>Status<wbr>Description property: Only appears when x-ms-copy-status is failed or pending."
parameters:
- description: "the copyStatusDescription value to set."
name: "copyStatusDescription"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setCopyStatusDescription(String copyStatusDescription)"
desc: "Set the copyStatusDescription property: Only appears when x-ms-copy-status is failed or pending. Describes the cause of the last fatal or non-fatal copy operation failure. This header does not appear if this blob has never been the destination in a Copy Blob operation, or if this blob has been modified after a concluded Copy Blob operation using Set Blob Properties, Put Blob, or Put Block List."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setDateProperty(java.time.OffsetDateTime)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setDateProperty(OffsetDateTime dateProperty)"
name: "setDateProperty(OffsetDateTime dateProperty)"
nameWithType: "BlobQueryHeaders.setDateProperty(OffsetDateTime dateProperty)"
summary: "Set the date<wbr>Property property: UTC date/time value generated by the service that indicates the time at which the response was initiated."
parameters:
- description: "the dateProperty value to set."
name: "dateProperty"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public BlobQueryHeaders setDateProperty(OffsetDateTime dateProperty)"
desc: "Set the dateProperty property: UTC date/time value generated by the service that indicates the time at which the response was initiated."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setETag(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setETag(String eTag)"
name: "setETag(String eTag)"
nameWithType: "BlobQueryHeaders.setETag(String eTag)"
summary: "Set the e<wbr>Tag property: The ETag contains a value that you can use to perform operations conditionally."
parameters:
- description: "the eTag value to set."
name: "eTag"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setETag(String eTag)"
desc: "Set the eTag property: The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setEncryptionKeySha256(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setEncryptionKeySha256(String encryptionKeySha256)"
name: "setEncryptionKeySha256(String encryptionKeySha256)"
nameWithType: "BlobQueryHeaders.setEncryptionKeySha256(String encryptionKeySha256)"
summary: "Set the encryption<wbr>Key<wbr>Sha256 property: The SHA-256 hash of the encryption key used to encrypt the blob."
parameters:
- description: "the encryptionKeySha256 value to set."
name: "encryptionKeySha256"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setEncryptionKeySha256(String encryptionKeySha256)"
desc: "Set the encryptionKeySha256 property: The SHA-256 hash of the encryption key used to encrypt the blob. This header is only returned when the blob was encrypted with a customer-provided key."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setEncryptionScope(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setEncryptionScope(String encryptionScope)"
name: "setEncryptionScope(String encryptionScope)"
nameWithType: "BlobQueryHeaders.setEncryptionScope(String encryptionScope)"
summary: "Set the encryption<wbr>Scope property: Returns the name of the encryption scope used to encrypt the blob contents and application metadata."
parameters:
- description: "the encryptionScope value to set."
name: "encryptionScope"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setEncryptionScope(String encryptionScope)"
desc: "Set the encryptionScope property: Returns the name of the encryption scope used to encrypt the blob contents and application metadata. Note that the absence of this header implies use of the default account encryption scope."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setErrorCode(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setErrorCode(String errorCode)"
name: "setErrorCode(String errorCode)"
nameWithType: "BlobQueryHeaders.setErrorCode(String errorCode)"
summary: "Set the error<wbr>Code property: The error<wbr>Code property."
parameters:
- description: "the errorCode value to set."
name: "errorCode"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setErrorCode(String errorCode)"
desc: "Set the errorCode property: The errorCode property."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setLastModified(java.time.OffsetDateTime)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setLastModified(OffsetDateTime lastModified)"
name: "setLastModified(OffsetDateTime lastModified)"
nameWithType: "BlobQueryHeaders.setLastModified(OffsetDateTime lastModified)"
summary: "Set the last<wbr>Modified property: Returns the date and time the container was last modified."
parameters:
- description: "the lastModified value to set."
name: "lastModified"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public BlobQueryHeaders setLastModified(OffsetDateTime lastModified)"
desc: "Set the lastModified property: Returns the date and time the container was last modified. Any operation that modifies the blob, including an update of the blob's metadata or properties, changes the last-modified time of the blob."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setLeaseDuration(com.azure.storage.blob.models.LeaseDurationType)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setLeaseDuration(LeaseDurationType leaseDuration)"
name: "setLeaseDuration(LeaseDurationType leaseDuration)"
nameWithType: "BlobQueryHeaders.setLeaseDuration(LeaseDurationType leaseDuration)"
summary: "Set the lease<wbr>Duration property: When a blob is leased, specifies whether the lease is of infinite or fixed duration."
parameters:
- description: "the leaseDuration value to set."
name: "leaseDuration"
type: "<xref href=\"com.azure.storage.blob.models.LeaseDurationType?alt=com.azure.storage.blob.models.LeaseDurationType&text=LeaseDurationType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobQueryHeaders setLeaseDuration(LeaseDurationType leaseDuration)"
desc: "Set the leaseDuration property: When a blob is leased, specifies whether the lease is of infinite or fixed duration. Possible values include: 'infinite', 'fixed'."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setLeaseState(com.azure.storage.blob.models.LeaseStateType)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setLeaseState(LeaseStateType leaseState)"
name: "setLeaseState(LeaseStateType leaseState)"
nameWithType: "BlobQueryHeaders.setLeaseState(LeaseStateType leaseState)"
summary: "Set the lease<wbr>State property: Lease state of the blob."
parameters:
- description: "the leaseState value to set."
name: "leaseState"
type: "<xref href=\"com.azure.storage.blob.models.LeaseStateType?alt=com.azure.storage.blob.models.LeaseStateType&text=LeaseStateType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobQueryHeaders setLeaseState(LeaseStateType leaseState)"
desc: "Set the leaseState property: Lease state of the blob. Possible values include: 'available', 'leased', 'expired', 'breaking', 'broken'."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setLeaseStatus(com.azure.storage.blob.models.LeaseStatusType)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setLeaseStatus(LeaseStatusType leaseStatus)"
name: "setLeaseStatus(LeaseStatusType leaseStatus)"
nameWithType: "BlobQueryHeaders.setLeaseStatus(LeaseStatusType leaseStatus)"
summary: "Set the lease<wbr>Status property: The current lease status of the blob."
parameters:
- description: "the leaseStatus value to set."
name: "leaseStatus"
type: "<xref href=\"com.azure.storage.blob.models.LeaseStatusType?alt=com.azure.storage.blob.models.LeaseStatusType&text=LeaseStatusType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public BlobQueryHeaders setLeaseStatus(LeaseStatusType leaseStatus)"
desc: "Set the leaseStatus property: The current lease status of the blob. Possible values include: 'locked', 'unlocked'."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setMetadata(java.util.Map<java.lang.String,java.lang.String>)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setMetadata(Map<String,String> metadata)"
name: "setMetadata(Map<String,String> metadata)"
nameWithType: "BlobQueryHeaders.setMetadata(Map<String,String> metadata)"
summary: "Set the metadata property: The metadata property."
parameters:
- description: "the metadata value to set."
name: "metadata"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
syntax: "public BlobQueryHeaders setMetadata(Map<String,String> metadata)"
desc: "Set the metadata property: The metadata property."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setRequestId(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setRequestId(String requestId)"
name: "setRequestId(String requestId)"
nameWithType: "BlobQueryHeaders.setRequestId(String requestId)"
summary: "Set the request<wbr>Id property: This header uniquely identifies the request that was made and can be used for troubleshooting the request."
parameters:
- description: "the requestId value to set."
name: "requestId"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setRequestId(String requestId)"
desc: "Set the requestId property: This header uniquely identifies the request that was made and can be used for troubleshooting the request."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setServerEncrypted(java.lang.Boolean)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setServerEncrypted(Boolean serverEncrypted)"
name: "setServerEncrypted(Boolean serverEncrypted)"
nameWithType: "BlobQueryHeaders.setServerEncrypted(Boolean serverEncrypted)"
summary: "Set the server<wbr>Encrypted property: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm."
parameters:
- description: "the serverEncrypted value to set."
name: "serverEncrypted"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
syntax: "public BlobQueryHeaders setServerEncrypted(Boolean serverEncrypted)"
desc: "Set the serverEncrypted property: The value of this header is set to true if the blob data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the blob is unencrypted, or if only parts of the blob/application metadata are encrypted)."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.models.BlobQueryHeaders.setVersion(java.lang.String)"
fullName: "com.azure.storage.blob.models.BlobQueryHeaders.setVersion(String version)"
name: "setVersion(String version)"
nameWithType: "BlobQueryHeaders.setVersion(String version)"
summary: "Set the version property: Indicates the version of the Blob service used to execute the request."
parameters:
- description: "the version value to set."
name: "version"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobQueryHeaders setVersion(String version)"
desc: "Set the version property: Indicates the version of the Blob service used to execute the request. This header is returned for requests made against version 2009-09-19 and above."
returns:
description: "the BlobQueryHeaders object itself."
type: "<xref href=\"com.azure.storage.blob.models.BlobQueryHeaders?alt=com.azure.storage.blob.models.BlobQueryHeaders&text=BlobQueryHeaders\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Defines headers for Query operation."
metadata: {}
package: "com.azure.storage.blob.models"
artifact: com.azure:azure-storage-blob:12.28.1