797 строки
120 KiB
YAML
797 строки
120 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.blob.specialized.BlockBlobClient"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient"
|
|
name: "BlockBlobClient"
|
|
nameWithType: "BlockBlobClient"
|
|
summary: "Client to a block blob."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase?alt=com.azure.storage.blob.specialized.BlobClientBase&text=BlobClientBase\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.abortCopyFromUrl(java.lang.String)?alt=com.azure.storage.blob.specialized.BlobClientBase.abortCopyFromUrl&text=abortCopyFromUrl\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.abortCopyFromUrlWithResponse(java.lang.String,java.lang.String,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.abortCopyFromUrlWithResponse&text=abortCopyFromUrlWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.beginCopy(com.azure.storage.blob.options.BlobBeginCopyOptions)?alt=com.azure.storage.blob.specialized.BlobClientBase.beginCopy&text=beginCopy\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.beginCopy(java.lang.String,java.time.Duration)?alt=com.azure.storage.blob.specialized.BlobClientBase.beginCopy&text=beginCopy\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.beginCopy(java.lang.String,java.util.Map<java.lang.String,java.lang.String>,com.azure.storage.blob.models.AccessTier,com.azure.storage.blob.models.RehydratePriority,com.azure.core.http.RequestConditions,com.azure.storage.blob.models.BlobRequestConditions,java.time.Duration)?alt=com.azure.storage.blob.specialized.BlobClientBase.beginCopy&text=beginCopy\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.copyFromUrl(java.lang.String)?alt=com.azure.storage.blob.specialized.BlobClientBase.copyFromUrl&text=copyFromUrl\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.copyFromUrlWithResponse(com.azure.storage.blob.options.BlobCopyFromUrlOptions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.copyFromUrlWithResponse&text=copyFromUrlWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.copyFromUrlWithResponse(java.lang.String,java.util.Map<java.lang.String,java.lang.String>,com.azure.storage.blob.models.AccessTier,com.azure.core.http.RequestConditions,com.azure.storage.blob.models.BlobRequestConditions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.copyFromUrlWithResponse&text=copyFromUrlWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.createSnapshot()?alt=com.azure.storage.blob.specialized.BlobClientBase.createSnapshot&text=createSnapshot\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.createSnapshotWithResponse(java.util.Map<java.lang.String,java.lang.String>,com.azure.storage.blob.models.BlobRequestConditions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.createSnapshotWithResponse&text=createSnapshotWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.delete()?alt=com.azure.storage.blob.specialized.BlobClientBase.delete&text=delete\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.deleteIfExists()?alt=com.azure.storage.blob.specialized.BlobClientBase.deleteIfExists&text=deleteIfExists\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.deleteIfExistsWithResponse(com.azure.storage.blob.models.DeleteSnapshotsOptionType,com.azure.storage.blob.models.BlobRequestConditions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.deleteIfExistsWithResponse&text=deleteIfExistsWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.deleteImmutabilityPolicy()?alt=com.azure.storage.blob.specialized.BlobClientBase.deleteImmutabilityPolicy&text=deleteImmutabilityPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.deleteImmutabilityPolicyWithResponse(java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.deleteImmutabilityPolicyWithResponse&text=deleteImmutabilityPolicyWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.deleteWithResponse(com.azure.storage.blob.models.DeleteSnapshotsOptionType,com.azure.storage.blob.models.BlobRequestConditions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.deleteWithResponse&text=deleteWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.download(java.io.OutputStream)?alt=com.azure.storage.blob.specialized.BlobClientBase.download&text=download\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.downloadContent()?alt=com.azure.storage.blob.specialized.BlobClientBase.downloadContent&text=downloadContent\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.downloadContentWithResponse(com.azure.storage.blob.models.DownloadRetryOptions,com.azure.storage.blob.models.BlobRequestConditions,com.azure.storage.blob.models.BlobRange,boolean,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.downloadContentWithResponse&text=downloadContentWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.downloadContentWithResponse(com.azure.storage.blob.models.DownloadRetryOptions,com.azure.storage.blob.models.BlobRequestConditions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.downloadContentWithResponse&text=downloadContentWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.downloadStream(java.io.OutputStream)?alt=com.azure.storage.blob.specialized.BlobClientBase.downloadStream&text=downloadStream\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.downloadStreamWithResponse(java.io.OutputStream,com.azure.storage.blob.models.BlobRange,com.azure.storage.blob.models.DownloadRetryOptions,com.azure.storage.blob.models.BlobRequestConditions,boolean,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.downloadStreamWithResponse&text=downloadStreamWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.downloadToFile(java.lang.String)?alt=com.azure.storage.blob.specialized.BlobClientBase.downloadToFile&text=downloadToFile\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.downloadToFile(java.lang.String,boolean)?alt=com.azure.storage.blob.specialized.BlobClientBase.downloadToFile&text=downloadToFile\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.downloadToFileWithResponse(com.azure.storage.blob.options.BlobDownloadToFileOptions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.downloadToFileWithResponse&text=downloadToFileWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.downloadToFileWithResponse(java.lang.String,com.azure.storage.blob.models.BlobRange,com.azure.storage.blob.models.ParallelTransferOptions,com.azure.storage.blob.models.DownloadRetryOptions,com.azure.storage.blob.models.BlobRequestConditions,boolean,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.downloadToFileWithResponse&text=downloadToFileWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.downloadToFileWithResponse(java.lang.String,com.azure.storage.blob.models.BlobRange,com.azure.storage.blob.models.ParallelTransferOptions,com.azure.storage.blob.models.DownloadRetryOptions,com.azure.storage.blob.models.BlobRequestConditions,boolean,java.util.Set<java.nio.file.OpenOption>,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.downloadToFileWithResponse&text=downloadToFileWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.downloadWithResponse(java.io.OutputStream,com.azure.storage.blob.models.BlobRange,com.azure.storage.blob.models.DownloadRetryOptions,com.azure.storage.blob.models.BlobRequestConditions,boolean,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.downloadWithResponse&text=downloadWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.exists()?alt=com.azure.storage.blob.specialized.BlobClientBase.exists&text=exists\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.existsWithResponse(java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.existsWithResponse&text=existsWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.generateSas(com.azure.storage.blob.sas.BlobServiceSasSignatureValues)?alt=com.azure.storage.blob.specialized.BlobClientBase.generateSas&text=generateSas\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.generateSas(com.azure.storage.blob.sas.BlobServiceSasSignatureValues,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.generateSas&text=generateSas\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.generateSas(com.azure.storage.blob.sas.BlobServiceSasSignatureValues,java.util.function.Consumer<java.lang.String>,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.generateSas&text=generateSas\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.generateUserDelegationSas(com.azure.storage.blob.sas.BlobServiceSasSignatureValues,com.azure.storage.blob.models.UserDelegationKey)?alt=com.azure.storage.blob.specialized.BlobClientBase.generateUserDelegationSas&text=generateUserDelegationSas\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.generateUserDelegationSas(com.azure.storage.blob.sas.BlobServiceSasSignatureValues,com.azure.storage.blob.models.UserDelegationKey,java.lang.String,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.generateUserDelegationSas&text=generateUserDelegationSas\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.generateUserDelegationSas(com.azure.storage.blob.sas.BlobServiceSasSignatureValues,com.azure.storage.blob.models.UserDelegationKey,java.lang.String,java.util.function.Consumer<java.lang.String>,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.generateUserDelegationSas&text=generateUserDelegationSas\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getAccountInfo()?alt=com.azure.storage.blob.specialized.BlobClientBase.getAccountInfo&text=getAccountInfo\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getAccountInfoWithResponse(java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.getAccountInfoWithResponse&text=getAccountInfoWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getAccountName()?alt=com.azure.storage.blob.specialized.BlobClientBase.getAccountName&text=getAccountName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getAccountUrl()?alt=com.azure.storage.blob.specialized.BlobClientBase.getAccountUrl&text=getAccountUrl\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getBlobName()?alt=com.azure.storage.blob.specialized.BlobClientBase.getBlobName&text=getBlobName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getBlobUrl()?alt=com.azure.storage.blob.specialized.BlobClientBase.getBlobUrl&text=getBlobUrl\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getContainerClient()?alt=com.azure.storage.blob.specialized.BlobClientBase.getContainerClient&text=getContainerClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getContainerName()?alt=com.azure.storage.blob.specialized.BlobClientBase.getContainerName&text=getContainerName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getCustomerProvidedKey()?alt=com.azure.storage.blob.specialized.BlobClientBase.getCustomerProvidedKey&text=getCustomerProvidedKey\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getCustomerProvidedKeyClient(com.azure.storage.blob.models.CustomerProvidedKey)?alt=com.azure.storage.blob.specialized.BlobClientBase.getCustomerProvidedKeyClient&text=getCustomerProvidedKeyClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getEncryptionScope()?alt=com.azure.storage.blob.specialized.BlobClientBase.getEncryptionScope&text=getEncryptionScope\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getEncryptionScopeClient(java.lang.String)?alt=com.azure.storage.blob.specialized.BlobClientBase.getEncryptionScopeClient&text=getEncryptionScopeClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getHttpPipeline()?alt=com.azure.storage.blob.specialized.BlobClientBase.getHttpPipeline&text=getHttpPipeline\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getProperties()?alt=com.azure.storage.blob.specialized.BlobClientBase.getProperties&text=getProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getPropertiesWithResponse(com.azure.storage.blob.models.BlobRequestConditions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.getPropertiesWithResponse&text=getPropertiesWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getServiceVersion()?alt=com.azure.storage.blob.specialized.BlobClientBase.getServiceVersion&text=getServiceVersion\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getSnapshotClient(java.lang.String)?alt=com.azure.storage.blob.specialized.BlobClientBase.getSnapshotClient&text=getSnapshotClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getSnapshotId()?alt=com.azure.storage.blob.specialized.BlobClientBase.getSnapshotId&text=getSnapshotId\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getTags()?alt=com.azure.storage.blob.specialized.BlobClientBase.getTags&text=getTags\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getTagsWithResponse(com.azure.storage.blob.options.BlobGetTagsOptions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.getTagsWithResponse&text=getTagsWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getVersionClient(java.lang.String)?alt=com.azure.storage.blob.specialized.BlobClientBase.getVersionClient&text=getVersionClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.getVersionId()?alt=com.azure.storage.blob.specialized.BlobClientBase.getVersionId&text=getVersionId\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.isSnapshot()?alt=com.azure.storage.blob.specialized.BlobClientBase.isSnapshot&text=isSnapshot\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.openInputStream()?alt=com.azure.storage.blob.specialized.BlobClientBase.openInputStream&text=openInputStream\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.openInputStream(com.azure.storage.blob.models.BlobRange,com.azure.storage.blob.models.BlobRequestConditions)?alt=com.azure.storage.blob.specialized.BlobClientBase.openInputStream&text=openInputStream\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.openInputStream(com.azure.storage.blob.options.BlobInputStreamOptions)?alt=com.azure.storage.blob.specialized.BlobClientBase.openInputStream&text=openInputStream\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.openInputStream(com.azure.storage.blob.options.BlobInputStreamOptions,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.openInputStream&text=openInputStream\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.openQueryInputStream(java.lang.String)?alt=com.azure.storage.blob.specialized.BlobClientBase.openQueryInputStream&text=openQueryInputStream\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.openQueryInputStreamWithResponse(com.azure.storage.blob.options.BlobQueryOptions)?alt=com.azure.storage.blob.specialized.BlobClientBase.openQueryInputStreamWithResponse&text=openQueryInputStreamWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.openSeekableByteChannelRead(com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.openSeekableByteChannelRead&text=openSeekableByteChannelRead\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.query(java.io.OutputStream,java.lang.String)?alt=com.azure.storage.blob.specialized.BlobClientBase.query&text=query\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.queryWithResponse(com.azure.storage.blob.options.BlobQueryOptions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.queryWithResponse&text=queryWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.setAccessTier(com.azure.storage.blob.models.AccessTier)?alt=com.azure.storage.blob.specialized.BlobClientBase.setAccessTier&text=setAccessTier\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.setAccessTierWithResponse(com.azure.storage.blob.models.AccessTier,com.azure.storage.blob.models.RehydratePriority,java.lang.String,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.setAccessTierWithResponse&text=setAccessTierWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.setAccessTierWithResponse(com.azure.storage.blob.options.BlobSetAccessTierOptions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.setAccessTierWithResponse&text=setAccessTierWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.setHttpHeaders(com.azure.storage.blob.models.BlobHttpHeaders)?alt=com.azure.storage.blob.specialized.BlobClientBase.setHttpHeaders&text=setHttpHeaders\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.setHttpHeadersWithResponse(com.azure.storage.blob.models.BlobHttpHeaders,com.azure.storage.blob.models.BlobRequestConditions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.setHttpHeadersWithResponse&text=setHttpHeadersWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.setImmutabilityPolicy(com.azure.storage.blob.models.BlobImmutabilityPolicy)?alt=com.azure.storage.blob.specialized.BlobClientBase.setImmutabilityPolicy&text=setImmutabilityPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.setImmutabilityPolicyWithResponse(com.azure.storage.blob.models.BlobImmutabilityPolicy,com.azure.storage.blob.models.BlobRequestConditions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.setImmutabilityPolicyWithResponse&text=setImmutabilityPolicyWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.setLegalHold(boolean)?alt=com.azure.storage.blob.specialized.BlobClientBase.setLegalHold&text=setLegalHold\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.setLegalHoldWithResponse(boolean,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.setLegalHoldWithResponse&text=setLegalHoldWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.setMetadata(java.util.Map<java.lang.String,java.lang.String>)?alt=com.azure.storage.blob.specialized.BlobClientBase.setMetadata&text=setMetadata\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.setMetadataWithResponse(java.util.Map<java.lang.String,java.lang.String>,com.azure.storage.blob.models.BlobRequestConditions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.setMetadataWithResponse&text=setMetadataWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.setTags(java.util.Map<java.lang.String,java.lang.String>)?alt=com.azure.storage.blob.specialized.BlobClientBase.setTags&text=setTags\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.setTagsWithResponse(com.azure.storage.blob.options.BlobSetTagsOptions,java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.setTagsWithResponse&text=setTagsWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.undelete()?alt=com.azure.storage.blob.specialized.BlobClientBase.undelete&text=undelete\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.storage.blob.specialized.BlobClientBase.undeleteWithResponse(java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.undeleteWithResponse&text=undeleteWithResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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 **BlockBlobClient**</br> extends <xref href=\"com.azure.storage.blob.specialized.BlobClientBase?alt=com.azure.storage.blob.specialized.BlobClientBase&text=BlobClientBase\" data-throw-if-not-resolved=\"False\" />"
|
|
fields:
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.MAX_BLOCKS"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.MAX_BLOCKS"
|
|
name: "MAX_BLOCKS"
|
|
nameWithType: "BlockBlobClient.MAX_BLOCKS"
|
|
summary: "Indicates the maximum number of blocks allowed in a block blob."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "50000"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final int MAX_BLOCKS"
|
|
desc: "Indicates the maximum number of blocks allowed in a block blob."
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.MAX_STAGE_BLOCK_BYTES"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.MAX_STAGE_BLOCK_BYTES"
|
|
name: "MAX_STAGE_BLOCK_BYTES"
|
|
nameWithType: "BlockBlobClient.MAX_STAGE_BLOCK_BYTES"
|
|
summary: "Indicates the maximum number of bytes that can be sent in a call to stage<wbr>Block."
|
|
deprecatedTag: "Use <xref uid=\"com.azure.storage.blob.specialized.BlockBlobClient.MAX_STAGE_BLOCK_BYTES_LONG\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#MAX_STAGE_BLOCK_BYTES_LONG\"></xref>"
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "104857600"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public static final int MAX_STAGE_BLOCK_BYTES"
|
|
desc: "Indicates the maximum number of bytes that can be sent in a call to stageBlock."
|
|
hasDeprecatedTag: true
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.MAX_STAGE_BLOCK_BYTES_LONG"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.MAX_STAGE_BLOCK_BYTES_LONG"
|
|
name: "MAX_STAGE_BLOCK_BYTES_LONG"
|
|
nameWithType: "BlockBlobClient.MAX_STAGE_BLOCK_BYTES_LONG"
|
|
summary: "Indicates the maximum number of bytes that can be sent in a call to stage<wbr>Block."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "4194304000"
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final long MAX_STAGE_BLOCK_BYTES_LONG"
|
|
desc: "Indicates the maximum number of bytes that can be sent in a call to stageBlock."
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.MAX_UPLOAD_BLOB_BYTES"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.MAX_UPLOAD_BLOB_BYTES"
|
|
name: "MAX_UPLOAD_BLOB_BYTES"
|
|
nameWithType: "BlockBlobClient.MAX_UPLOAD_BLOB_BYTES"
|
|
summary: "Indicates the maximum number of bytes that can be sent in a call to upload."
|
|
deprecatedTag: "Use <xref uid=\"com.azure.storage.blob.specialized.BlockBlobClient.MAX_STAGE_BLOCK_BYTES_LONG\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#MAX_STAGE_BLOCK_BYTES_LONG\"></xref>."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "268435456"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public static final int MAX_UPLOAD_BLOB_BYTES"
|
|
desc: "Indicates the maximum number of bytes that can be sent in a call to upload."
|
|
hasDeprecatedTag: true
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.MAX_UPLOAD_BLOB_BYTES_LONG"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.MAX_UPLOAD_BLOB_BYTES_LONG"
|
|
name: "MAX_UPLOAD_BLOB_BYTES_LONG"
|
|
nameWithType: "BlockBlobClient.MAX_UPLOAD_BLOB_BYTES_LONG"
|
|
summary: "Indicates the maximum number of bytes that can be sent in a call to upload."
|
|
modifiers:
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "5242880000"
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static final long MAX_UPLOAD_BLOB_BYTES_LONG"
|
|
desc: "Indicates the maximum number of bytes that can be sent in a call to upload."
|
|
methods:
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.commitBlockList(java.util.List<java.lang.String>)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.commitBlockList(List<String> base64BlockIds)"
|
|
name: "commitBlockList(List<String> base64BlockIds)"
|
|
nameWithType: "BlockBlobClient.commitBlockList(List<String> base64BlockIds)"
|
|
summary: "Writes a blob by specifying the list of block IDs that are to make up the blob."
|
|
parameters:
|
|
- description: "A list of base64 encode <code>String</code>s that specifies the block IDs to be committed."
|
|
name: "base64BlockIds"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public BlockBlobItem commitBlockList(List<String> base64BlockIds)"
|
|
desc: "Writes a blob by specifying the list of block IDs that are to make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior stageBlock operation. You can call commitBlockList to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. Any blocks not specified in the block list and permanently deleted. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nSystem.out.printf(\"Committing block list completed. Last modified: %s%n\",\n client.commitBlockList(Collections.singletonList(base64BlockId)).getLastModified());\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-block-list"
|
|
returns:
|
|
description: "The information of the block blob."
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlockBlobItem?alt=com.azure.storage.blob.models.BlockBlobItem&text=BlockBlobItem\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.commitBlockList(java.util.List<java.lang.String>,boolean)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.commitBlockList(List<String> base64BlockIds, boolean overwrite)"
|
|
name: "commitBlockList(List<String> base64BlockIds, boolean overwrite)"
|
|
nameWithType: "BlockBlobClient.commitBlockList(List<String> base64BlockIds, boolean overwrite)"
|
|
summary: "Writes a blob by specifying the list of block IDs that are to make up the blob."
|
|
parameters:
|
|
- description: "A list of base64 encode <code>String</code>s that specifies the block IDs to be committed."
|
|
name: "base64BlockIds"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- description: "Whether to overwrite, should data exist on the blob."
|
|
name: "overwrite"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlockBlobItem commitBlockList(List<String> base64BlockIds, boolean overwrite)"
|
|
desc: "Writes a blob by specifying the list of block IDs that are to make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior stageBlock operation. You can call commitBlockList to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. Any blocks not specified in the block list and permanently deleted. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nboolean overwrite = false; // Default behavior\n System.out.printf(\"Committing block list completed. Last modified: %s%n\",\n client.commitBlockList(Collections.singletonList(base64BlockId), overwrite).getLastModified());\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-block-list"
|
|
returns:
|
|
description: "The information of the block blob."
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlockBlobItem?alt=com.azure.storage.blob.models.BlockBlobItem&text=BlockBlobItem\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.commitBlockListWithResponse(com.azure.storage.blob.options.BlockBlobCommitBlockListOptions,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.commitBlockListWithResponse(BlockBlobCommitBlockListOptions options, Duration timeout, Context context)"
|
|
name: "commitBlockListWithResponse(BlockBlobCommitBlockListOptions options, Duration timeout, Context context)"
|
|
nameWithType: "BlockBlobClient.commitBlockListWithResponse(BlockBlobCommitBlockListOptions options, Duration timeout, Context context)"
|
|
summary: "Writes a blob by specifying the list of block IDs that are to make up the blob."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.blob.options.BlockBlobCommitBlockListOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"options\"></xref>"
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.storage.blob.options.BlockBlobCommitBlockListOptions?alt=com.azure.storage.blob.options.BlockBlobCommitBlockListOptions&text=BlockBlobCommitBlockListOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BlockBlobItem> commitBlockListWithResponse(BlockBlobCommitBlockListOptions options, Duration timeout, Context context)"
|
|
desc: "Writes a blob by specifying the list of block IDs that are to make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior stageBlock operation. You can call commitBlockList to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. Any blocks not specified in the block list and permanently deleted. For more information, see the [Azure Docs][].\n\nTo avoid overwriting, pass \"\\*\" to <xref uid=\"com.azure.storage.blob.models.BlobRequestConditions.setIfNoneMatch(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions#setIfNoneMatch(String)\"></xref>.\n\n**Code Samples**\n\n```java\nBlobHttpHeaders headers = new BlobHttpHeaders()\n .setContentMd5(\"data\".getBytes(StandardCharsets.UTF_8))\n .setContentLanguage(\"en-US\")\n .setContentType(\"binary\");\n\n Map<String, String> metadata = Collections.singletonMap(\"metadata\", \"value\");\n Map<String, String> tags = Collections.singletonMap(\"tag\", \"value\");\n BlobRequestConditions requestConditions = new BlobRequestConditions()\n .setLeaseId(leaseId)\n .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));\n Context context = new Context(\"key\", \"value\");\n\n System.out.printf(\"Committing block list completed with status %d%n\",\n client.commitBlockListWithResponse(\n new BlockBlobCommitBlockListOptions(Collections.singletonList(base64BlockId)).setHeaders(headers)\n .setMetadata(metadata).setTags(tags).setTier(AccessTier.HOT)\n .setRequestConditions(requestConditions), timeout, context)\n .getStatusCode());\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-block-list"
|
|
returns:
|
|
description: "The information of the block blob."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.blob.models.BlockBlobItem?alt=com.azure.storage.blob.models.BlockBlobItem&text=BlockBlobItem\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.commitBlockListWithResponse(java.util.List<java.lang.String>,com.azure.storage.blob.models.BlobHttpHeaders,java.util.Map<java.lang.String,java.lang.String>,com.azure.storage.blob.models.AccessTier,com.azure.storage.blob.models.BlobRequestConditions,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.commitBlockListWithResponse(List<String> base64BlockIds, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout, Context context)"
|
|
name: "commitBlockListWithResponse(List<String> base64BlockIds, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout, Context context)"
|
|
nameWithType: "BlockBlobClient.commitBlockListWithResponse(List<String> base64BlockIds, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout, Context context)"
|
|
summary: "Writes a blob by specifying the list of block IDs that are to make up the blob."
|
|
parameters:
|
|
- description: "A list of base64 encode <code>String</code>s that specifies the block IDs to be committed."
|
|
name: "base64BlockIds"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- description: "<xref uid=\"com.azure.storage.blob.models.BlobHttpHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobHttpHeaders\"></xref>"
|
|
name: "headers"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobHttpHeaders?alt=com.azure.storage.blob.models.BlobHttpHeaders&text=BlobHttpHeaders\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Metadata to associate with the blob. If there is leading or trailing whitespace in any\n metadata key or value, it must be removed or encoded."
|
|
name: "metadata"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<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>>"
|
|
- description: "<xref uid=\"com.azure.storage.blob.models.AccessTier\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccessTier\"></xref> for the destination blob."
|
|
name: "tier"
|
|
type: "<xref href=\"com.azure.storage.blob.models.AccessTier?alt=com.azure.storage.blob.models.AccessTier&text=AccessTier\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "<xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref>"
|
|
name: "requestConditions"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobRequestConditions?alt=com.azure.storage.blob.models.BlobRequestConditions&text=BlobRequestConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BlockBlobItem> commitBlockListWithResponse(List<String> base64BlockIds, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout, Context context)"
|
|
desc: "Writes a blob by specifying the list of block IDs that are to make up the blob. In order to be written as part of a blob, a block must have been successfully written to the server in a prior stageBlock operation. You can call commitBlockList to update a blob by uploading only those blocks that have changed, then committing the new and existing blocks together. Any blocks not specified in the block list and permanently deleted. For more information, see the [Azure Docs][].\n\nTo avoid overwriting, pass \"\\*\" to <xref uid=\"com.azure.storage.blob.models.BlobRequestConditions.setIfNoneMatch(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions#setIfNoneMatch(String)\"></xref>.\n\n**Code Samples**\n\n```java\nBlobHttpHeaders headers = new BlobHttpHeaders()\n .setContentMd5(MessageDigest.getInstance(\"MD5\").digest(\"data\".getBytes(StandardCharsets.UTF_8)))\n .setContentLanguage(\"en-US\")\n .setContentType(\"binary\");\n\n Map<String, String> metadata = Collections.singletonMap(\"metadata\", \"value\");\n BlobRequestConditions requestConditions = new BlobRequestConditions()\n .setLeaseId(leaseId)\n .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));\n Context context = new Context(\"key\", \"value\");\n\n System.out.printf(\"Committing block list completed with status %d%n\",\n client.commitBlockListWithResponse(Collections.singletonList(base64BlockId), headers, metadata,\n AccessTier.HOT, requestConditions, timeout, context).getStatusCode());\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-block-list"
|
|
returns:
|
|
description: "The information of the block blob."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.blob.models.BlockBlobItem?alt=com.azure.storage.blob.models.BlockBlobItem&text=BlockBlobItem\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream()"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream()"
|
|
name: "getBlobOutputStream()"
|
|
nameWithType: "BlockBlobClient.getBlobOutputStream()"
|
|
summary: "Creates and opens an output stream to write data to the block blob."
|
|
syntax: "public BlobOutputStream getBlobOutputStream()"
|
|
desc: "Creates and opens an output stream to write data to the block blob.\n\nNote: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream obtained below with a [BufferedOutputStream][].\n\n\n[BufferedOutputStream]: https://docs.oracle.com/javase/8/docs/api/java/io/BufferedOutputStream.html"
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.storage.blob.specialized.BlobOutputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobOutputStream\"></xref> object used to write data to the blob."
|
|
type: "<xref href=\"com.azure.storage.blob.specialized.BlobOutputStream?alt=com.azure.storage.blob.specialized.BlobOutputStream&text=BlobOutputStream\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream(boolean)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream(boolean overwrite)"
|
|
name: "getBlobOutputStream(boolean overwrite)"
|
|
nameWithType: "BlockBlobClient.getBlobOutputStream(boolean overwrite)"
|
|
summary: "Creates and opens an output stream to write data to the block blob."
|
|
parameters:
|
|
- description: "Whether to overwrite, should data exist on the blob."
|
|
name: "overwrite"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlobOutputStream getBlobOutputStream(boolean overwrite)"
|
|
desc: "Creates and opens an output stream to write data to the block blob.\n\nNote: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream obtained below with a [BufferedOutputStream][].\n\n\n[BufferedOutputStream]: https://docs.oracle.com/javase/8/docs/api/java/io/BufferedOutputStream.html"
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.storage.blob.specialized.BlobOutputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobOutputStream\"></xref> object used to write data to the blob."
|
|
type: "<xref href=\"com.azure.storage.blob.specialized.BlobOutputStream?alt=com.azure.storage.blob.specialized.BlobOutputStream&text=BlobOutputStream\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream(com.azure.storage.blob.models.BlobRequestConditions)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream(BlobRequestConditions requestConditions)"
|
|
name: "getBlobOutputStream(BlobRequestConditions requestConditions)"
|
|
nameWithType: "BlockBlobClient.getBlobOutputStream(BlobRequestConditions requestConditions)"
|
|
summary: "Creates and opens an output stream to write data to the block blob."
|
|
parameters:
|
|
- description: "A <xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref> object that represents the access conditions for the\n blob."
|
|
name: "requestConditions"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobRequestConditions?alt=com.azure.storage.blob.models.BlobRequestConditions&text=BlobRequestConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlobOutputStream getBlobOutputStream(BlobRequestConditions requestConditions)"
|
|
desc: "Creates and opens an output stream to write data to the block blob. If the blob already exists on the service, it will be overwritten.\n\nTo avoid overwriting, pass \"\\*\" to <xref uid=\"com.azure.storage.blob.models.BlobRequestConditions.setIfNoneMatch(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions#setIfNoneMatch(String)\"></xref>.\n\nNote: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream obtained below with a [BufferedOutputStream][].\n\n\n[BufferedOutputStream]: https://docs.oracle.com/javase/8/docs/api/java/io/BufferedOutputStream.html"
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.storage.blob.specialized.BlobOutputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobOutputStream\"></xref> object used to write data to the blob."
|
|
type: "<xref href=\"com.azure.storage.blob.specialized.BlobOutputStream?alt=com.azure.storage.blob.specialized.BlobOutputStream&text=BlobOutputStream\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream(com.azure.storage.blob.models.ParallelTransferOptions,com.azure.storage.blob.models.BlobHttpHeaders,java.util.Map<java.lang.String,java.lang.String>,com.azure.storage.blob.models.AccessTier,com.azure.storage.blob.models.BlobRequestConditions)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream(ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, BlobRequestConditions requestConditions)"
|
|
name: "getBlobOutputStream(ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, BlobRequestConditions requestConditions)"
|
|
nameWithType: "BlockBlobClient.getBlobOutputStream(ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, BlobRequestConditions requestConditions)"
|
|
summary: "Creates and opens an output stream to write data to the block blob."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.blob.models.ParallelTransferOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ParallelTransferOptions\"></xref> used to configure buffered uploading."
|
|
name: "parallelTransferOptions"
|
|
type: "<xref href=\"com.azure.storage.blob.models.ParallelTransferOptions?alt=com.azure.storage.blob.models.ParallelTransferOptions&text=ParallelTransferOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "<xref uid=\"com.azure.storage.blob.models.BlobHttpHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobHttpHeaders\"></xref>"
|
|
name: "headers"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobHttpHeaders?alt=com.azure.storage.blob.models.BlobHttpHeaders&text=BlobHttpHeaders\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Metadata to associate with the blob. If there is leading or trailing whitespace in any\n metadata key or value, it must be removed or encoded."
|
|
name: "metadata"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<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>>"
|
|
- description: "<xref uid=\"com.azure.storage.blob.models.AccessTier\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccessTier\"></xref> for the destination blob."
|
|
name: "tier"
|
|
type: "<xref href=\"com.azure.storage.blob.models.AccessTier?alt=com.azure.storage.blob.models.AccessTier&text=AccessTier\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "<xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref>"
|
|
name: "requestConditions"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobRequestConditions?alt=com.azure.storage.blob.models.BlobRequestConditions&text=BlobRequestConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlobOutputStream getBlobOutputStream(ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, BlobRequestConditions requestConditions)"
|
|
desc: "Creates and opens an output stream to write data to the block blob. If the blob already exists on the service, it will be overwritten.\n\nTo avoid overwriting, pass \"\\*\" to <xref uid=\"com.azure.storage.blob.models.BlobRequestConditions.setIfNoneMatch(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions#setIfNoneMatch(String)\"></xref>.\n\nNote: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream obtained below with a [BufferedOutputStream][].\n\n\n[BufferedOutputStream]: https://docs.oracle.com/javase/8/docs/api/java/io/BufferedOutputStream.html"
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.storage.blob.specialized.BlobOutputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobOutputStream\"></xref> object used to write data to the blob."
|
|
type: "<xref href=\"com.azure.storage.blob.specialized.BlobOutputStream?alt=com.azure.storage.blob.specialized.BlobOutputStream&text=BlobOutputStream\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream(com.azure.storage.blob.options.BlockBlobOutputStreamOptions)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream(BlockBlobOutputStreamOptions options)"
|
|
name: "getBlobOutputStream(BlockBlobOutputStreamOptions options)"
|
|
nameWithType: "BlockBlobClient.getBlobOutputStream(BlockBlobOutputStreamOptions options)"
|
|
summary: "Creates and opens an output stream to write data to the block blob."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.blob.options.BlockBlobOutputStreamOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlockBlobOutputStreamOptions\"></xref>"
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.storage.blob.options.BlockBlobOutputStreamOptions?alt=com.azure.storage.blob.options.BlockBlobOutputStreamOptions&text=BlockBlobOutputStreamOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlobOutputStream getBlobOutputStream(BlockBlobOutputStreamOptions options)"
|
|
desc: "Creates and opens an output stream to write data to the block blob. If the blob already exists on the service, it will be overwritten.\n\nTo avoid overwriting, pass \"\\*\" to <xref uid=\"com.azure.storage.blob.models.BlobRequestConditions.setIfNoneMatch(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions#setIfNoneMatch(String)\"></xref>.\n\nNote: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream obtained below with a [BufferedOutputStream][].\n\n\n[BufferedOutputStream]: https://docs.oracle.com/javase/8/docs/api/java/io/BufferedOutputStream.html"
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.storage.blob.specialized.BlobOutputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobOutputStream\"></xref> object used to write data to the blob."
|
|
type: "<xref href=\"com.azure.storage.blob.specialized.BlobOutputStream?alt=com.azure.storage.blob.specialized.BlobOutputStream&text=BlobOutputStream\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream(com.azure.storage.blob.options.BlockBlobOutputStreamOptions,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream(BlockBlobOutputStreamOptions options, Context context)"
|
|
name: "getBlobOutputStream(BlockBlobOutputStreamOptions options, Context context)"
|
|
nameWithType: "BlockBlobClient.getBlobOutputStream(BlockBlobOutputStreamOptions options, Context context)"
|
|
summary: "Creates and opens an output stream to write data to the block blob."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.blob.options.BlockBlobOutputStreamOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlockBlobOutputStreamOptions\"></xref>"
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.storage.blob.options.BlockBlobOutputStreamOptions?alt=com.azure.storage.blob.options.BlockBlobOutputStreamOptions&text=BlockBlobOutputStreamOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlobOutputStream getBlobOutputStream(BlockBlobOutputStreamOptions options, Context context)"
|
|
desc: "Creates and opens an output stream to write data to the block blob. If the blob already exists on the service, it will be overwritten.\n\nTo avoid overwriting, pass \"\\*\" to <xref uid=\"com.azure.storage.blob.models.BlobRequestConditions.setIfNoneMatch(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions#setIfNoneMatch(String)\"></xref>.\n\nNote: We recommend you call write with reasonably sized buffers, you can do so by wrapping the BlobOutputStream obtained below with a [BufferedOutputStream][].\n\n\n[BufferedOutputStream]: https://docs.oracle.com/javase/8/docs/api/java/io/BufferedOutputStream.html"
|
|
returns:
|
|
description: "A <xref uid=\"com.azure.storage.blob.specialized.BlobOutputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobOutputStream\"></xref> object used to write data to the blob."
|
|
type: "<xref href=\"com.azure.storage.blob.specialized.BlobOutputStream?alt=com.azure.storage.blob.specialized.BlobOutputStream&text=BlobOutputStream\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.getCustomerProvidedKeyClient(com.azure.storage.blob.models.CustomerProvidedKey)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)"
|
|
name: "getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)"
|
|
nameWithType: "BlockBlobClient.getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)"
|
|
summary: "Creates a new <xref uid=\"com.azure.storage.blob.specialized.BlockBlobClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlockBlobClient\"></xref> with the specified `customerProvidedKey`."
|
|
overridden: "com.azure.storage.blob.specialized.BlobClientBase.getCustomerProvidedKeyClient(com.azure.storage.blob.models.CustomerProvidedKey)"
|
|
parameters:
|
|
- description: "the <xref uid=\"com.azure.storage.blob.models.CustomerProvidedKey\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CustomerProvidedKey\"></xref> for the blob,\n pass <code>null</code> to use no customer provided key."
|
|
name: "customerProvidedKey"
|
|
type: "<xref href=\"com.azure.storage.blob.models.CustomerProvidedKey?alt=com.azure.storage.blob.models.CustomerProvidedKey&text=CustomerProvidedKey\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlockBlobClient getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)"
|
|
desc: "Creates a new <xref uid=\"com.azure.storage.blob.specialized.BlockBlobClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlockBlobClient\"></xref> with the specified `customerProvidedKey`."
|
|
returns:
|
|
description: "a <xref uid=\"com.azure.storage.blob.specialized.BlockBlobClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlockBlobClient\"></xref> with the specified <code>customerProvidedKey</code>."
|
|
type: "<xref href=\"com.azure.storage.blob.specialized.BlockBlobClient?alt=com.azure.storage.blob.specialized.BlockBlobClient&text=BlockBlobClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.getEncryptionScopeClient(java.lang.String)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.getEncryptionScopeClient(String encryptionScope)"
|
|
name: "getEncryptionScopeClient(String encryptionScope)"
|
|
nameWithType: "BlockBlobClient.getEncryptionScopeClient(String encryptionScope)"
|
|
summary: "Creates a new <xref uid=\"com.azure.storage.blob.specialized.BlockBlobClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlockBlobClient\"></xref> with the specified `encryptionScope`."
|
|
overridden: "com.azure.storage.blob.specialized.BlobClientBase.getEncryptionScopeClient(java.lang.String)"
|
|
parameters:
|
|
- description: "the encryption scope for the blob, pass <code>null</code> to use no encryption scope."
|
|
name: "encryptionScope"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public BlockBlobClient getEncryptionScopeClient(String encryptionScope)"
|
|
desc: "Creates a new <xref uid=\"com.azure.storage.blob.specialized.BlockBlobClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlockBlobClient\"></xref> with the specified `encryptionScope`."
|
|
returns:
|
|
description: "a <xref uid=\"com.azure.storage.blob.specialized.BlockBlobClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlockBlobClient\"></xref> with the specified <code>encryptionScope</code>."
|
|
type: "<xref href=\"com.azure.storage.blob.specialized.BlockBlobClient?alt=com.azure.storage.blob.specialized.BlockBlobClient&text=BlockBlobClient\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.listBlocks(com.azure.storage.blob.models.BlockListType)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.listBlocks(BlockListType listType)"
|
|
name: "listBlocks(BlockListType listType)"
|
|
nameWithType: "BlockBlobClient.listBlocks(BlockListType listType)"
|
|
summary: "Returns the list of blocks that have been uploaded as part of a block blob using the specified block list filter."
|
|
parameters:
|
|
- description: "Specifies which type of blocks to return."
|
|
name: "listType"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlockListType?alt=com.azure.storage.blob.models.BlockListType&text=BlockListType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlockList listBlocks(BlockListType listType)"
|
|
desc: "Returns the list of blocks that have been uploaded as part of a block blob using the specified block list filter. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nBlockList block = client.listBlocks(BlockListType.ALL);\n\n System.out.println(\"Committed Blocks:\");\n block.getCommittedBlocks().forEach(b -> System.out.printf(\"Name: %s, Size: %d\", b.getName(), b.getSizeLong()));\n\n System.out.println(\"Uncommitted Blocks:\");\n block.getUncommittedBlocks().forEach(b -> System.out.printf(\"Name: %s, Size: %d\", b.getName(), b.getSizeLong()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/get-block-list"
|
|
returns:
|
|
description: "The list of blocks."
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlockList?alt=com.azure.storage.blob.models.BlockList&text=BlockList\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.listBlocksWithResponse(com.azure.storage.blob.models.BlockListType,java.lang.String,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.listBlocksWithResponse(BlockListType listType, String leaseId, Duration timeout, Context context)"
|
|
name: "listBlocksWithResponse(BlockListType listType, String leaseId, Duration timeout, Context context)"
|
|
nameWithType: "BlockBlobClient.listBlocksWithResponse(BlockListType listType, String leaseId, Duration timeout, Context context)"
|
|
summary: "Returns the list of blocks that have been uploaded as part of a block blob using the specified block list filter."
|
|
parameters:
|
|
- description: "Specifies which type of blocks to return."
|
|
name: "listType"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlockListType?alt=com.azure.storage.blob.models.BlockListType&text=BlockListType\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "The lease ID the active lease on the blob must match."
|
|
name: "leaseId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BlockList> listBlocksWithResponse(BlockListType listType, String leaseId, Duration timeout, Context context)"
|
|
desc: "Returns the list of blocks that have been uploaded as part of a block blob using the specified block list filter. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nContext context = new Context(\"key\", \"value\");\n BlockList block = client.listBlocksWithResponse(BlockListType.ALL, leaseId, timeout, context).getValue();\n\n System.out.println(\"Committed Blocks:\");\n block.getCommittedBlocks().forEach(b -> System.out.printf(\"Name: %s, Size: %d\", b.getName(), b.getSizeLong()));\n\n System.out.println(\"Uncommitted Blocks:\");\n block.getUncommittedBlocks().forEach(b -> System.out.printf(\"Name: %s, Size: %d\", b.getName(), b.getSizeLong()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/get-block-list"
|
|
returns:
|
|
description: "The list of blocks."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.blob.models.BlockList?alt=com.azure.storage.blob.models.BlockList&text=BlockList\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.listBlocksWithResponse(com.azure.storage.blob.options.BlockBlobListBlocksOptions,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.listBlocksWithResponse(BlockBlobListBlocksOptions options, Duration timeout, Context context)"
|
|
name: "listBlocksWithResponse(BlockBlobListBlocksOptions options, Duration timeout, Context context)"
|
|
nameWithType: "BlockBlobClient.listBlocksWithResponse(BlockBlobListBlocksOptions options, Duration timeout, Context context)"
|
|
summary: "Returns the list of blocks that have been uploaded as part of a block blob using the specified block list filter."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.blob.options.BlockBlobListBlocksOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlockBlobListBlocksOptions\"></xref>"
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.storage.blob.options.BlockBlobListBlocksOptions?alt=com.azure.storage.blob.options.BlockBlobListBlocksOptions&text=BlockBlobListBlocksOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BlockList> listBlocksWithResponse(BlockBlobListBlocksOptions options, Duration timeout, Context context)"
|
|
desc: "Returns the list of blocks that have been uploaded as part of a block blob using the specified block list filter. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nContext context = new Context(\"key\", \"value\");\n BlockList block = client.listBlocksWithResponse(new BlockBlobListBlocksOptions(BlockListType.ALL)\n .setLeaseId(leaseId)\n .setIfTagsMatch(tags), timeout, context).getValue();\n\n System.out.println(\"Committed Blocks:\");\n block.getCommittedBlocks().forEach(b -> System.out.printf(\"Name: %s, Size: %d\", b.getName(), b.getSizeLong()));\n\n System.out.println(\"Uncommitted Blocks:\");\n block.getUncommittedBlocks().forEach(b -> System.out.printf(\"Name: %s, Size: %d\", b.getName(), b.getSizeLong()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/get-block-list"
|
|
returns:
|
|
description: "The list of blocks."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.blob.models.BlockList?alt=com.azure.storage.blob.models.BlockList&text=BlockList\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.openSeekableByteChannelWrite(com.azure.storage.blob.options.BlockBlobSeekableByteChannelWriteOptions)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.openSeekableByteChannelWrite(BlockBlobSeekableByteChannelWriteOptions options)"
|
|
name: "openSeekableByteChannelWrite(BlockBlobSeekableByteChannelWriteOptions options)"
|
|
nameWithType: "BlockBlobClient.openSeekableByteChannelWrite(BlockBlobSeekableByteChannelWriteOptions options)"
|
|
summary: "Opens a seekable byte channel in write-only mode to upload the blob."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.blob.options.BlobSeekableByteChannelReadOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobSeekableByteChannelReadOptions\"></xref>"
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.storage.blob.options.BlockBlobSeekableByteChannelWriteOptions?alt=com.azure.storage.blob.options.BlockBlobSeekableByteChannelWriteOptions&text=BlockBlobSeekableByteChannelWriteOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public SeekableByteChannel openSeekableByteChannelWrite(BlockBlobSeekableByteChannelWriteOptions options)"
|
|
desc: "Opens a seekable byte channel in write-only mode to upload the blob."
|
|
returns:
|
|
description: "A <code>SeekableByteChannel</code> object that represents the channel to use for writing to the blob."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/nio/channels/SeekableByteChannel.html\">SeekableByteChannel</a>"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.stageBlock(java.lang.String,com.azure.core.util.BinaryData)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.stageBlock(String base64BlockId, BinaryData data)"
|
|
name: "stageBlock(String base64BlockId, BinaryData data)"
|
|
nameWithType: "BlockBlobClient.stageBlock(String base64BlockId, BinaryData data)"
|
|
summary: "Uploads the specified block to the block blob's \"staging area\" to be later committed by a call to commit<wbr>Block<wbr>List."
|
|
parameters:
|
|
- description: "A Base64 encoded <code>String</code> that specifies the ID for this block. Note that all block\n ids for a given blob must be the same length."
|
|
name: "base64BlockId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The data to write to the block. Note that this <code>BinaryData</code> must have defined length\n and must be replayable if retries are enabled (the default), see <xref uid=\"com.azure.core.util.BinaryData.isReplayable*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BinaryData#isReplayable()\"></xref>."
|
|
name: "data"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void stageBlock(String base64BlockId, BinaryData data)"
|
|
desc: "Uploads the specified block to the block blob's \"staging area\" to be later committed by a call to commitBlockList. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nBinaryData binaryData = BinaryData.fromStream(data, length);\n client.stageBlock(base64BlockId, binaryData);\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-block"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.stageBlock(java.lang.String,java.io.InputStream,long)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.stageBlock(String base64BlockId, InputStream data, long length)"
|
|
name: "stageBlock(String base64BlockId, InputStream data, long length)"
|
|
nameWithType: "BlockBlobClient.stageBlock(String base64BlockId, InputStream data, long length)"
|
|
summary: "Uploads the specified block to the block blob's \"staging area\" to be later committed by a call to commit<wbr>Block<wbr>List."
|
|
parameters:
|
|
- description: "A Base64 encoded <code>String</code> that specifies the ID for this block. Note that all block\n ids for a given blob must be the same length."
|
|
name: "base64BlockId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The data to write to the block. The data must be markable. This is in order to support retries. If\n the data is not markable, consider using <xref uid=\"com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getBlobOutputStream()\"></xref> and writing to the returned OutputStream.\n Alternatively, consider wrapping your data source in a <a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/BufferedInputStream.html\">BufferedInputStream</a> to add mark support."
|
|
name: "data"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html\">InputStream</a>"
|
|
- description: "The exact length of the data. It is important that this value match precisely the length of the\n data provided in the <xref uid=\"java.io.InputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"InputStream\"></xref>."
|
|
name: "length"
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void stageBlock(String base64BlockId, InputStream data, long length)"
|
|
desc: "Uploads the specified block to the block blob's \"staging area\" to be later committed by a call to commitBlockList. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nclient.stageBlock(base64BlockId, data, length);\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-block"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.stageBlockFromUrl(java.lang.String,java.lang.String,com.azure.storage.blob.models.BlobRange)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.stageBlockFromUrl(String base64BlockId, String sourceUrl, BlobRange sourceRange)"
|
|
name: "stageBlockFromUrl(String base64BlockId, String sourceUrl, BlobRange sourceRange)"
|
|
nameWithType: "BlockBlobClient.stageBlockFromUrl(String base64BlockId, String sourceUrl, BlobRange sourceRange)"
|
|
summary: "Creates a new block to be committed as part of a blob where the contents are read from a URL."
|
|
parameters:
|
|
- description: "A Base64 encoded <code>String</code> that specifies the ID for this block. Note that all block\n ids for a given blob must be the same length."
|
|
name: "base64BlockId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The url to the blob that will be the source of the copy. A source blob in the same storage\n account can be authenticated via Shared Key. However, if the source is a blob in another account, the source blob\n must either be public or must be authenticated via a shared access signature. If the source blob is public, no\n authentication is required to perform the operation."
|
|
name: "sourceUrl"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "<xref uid=\"com.azure.storage.blob.models.BlobRange\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRange\"></xref>"
|
|
name: "sourceRange"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobRange?alt=com.azure.storage.blob.models.BlobRange&text=BlobRange\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void stageBlockFromUrl(String base64BlockId, String sourceUrl, BlobRange sourceRange)"
|
|
desc: "Creates a new block to be committed as part of a blob where the contents are read from a URL. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nclient.stageBlockFromUrl(base64BlockId, sourceUrl, new BlobRange(offset, count));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-block-from-url"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.stageBlockFromUrlWithResponse(com.azure.storage.blob.options.BlockBlobStageBlockFromUrlOptions,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.stageBlockFromUrlWithResponse(BlockBlobStageBlockFromUrlOptions options, Duration timeout, Context context)"
|
|
name: "stageBlockFromUrlWithResponse(BlockBlobStageBlockFromUrlOptions options, Duration timeout, Context context)"
|
|
nameWithType: "BlockBlobClient.stageBlockFromUrlWithResponse(BlockBlobStageBlockFromUrlOptions options, Duration timeout, Context context)"
|
|
summary: "Creates a new block to be committed as part of a blob where the contents are read from a URL."
|
|
parameters:
|
|
- description: "Parameters for the operation"
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.storage.blob.options.BlockBlobStageBlockFromUrlOptions?alt=com.azure.storage.blob.options.BlockBlobStageBlockFromUrlOptions&text=BlockBlobStageBlockFromUrlOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> stageBlockFromUrlWithResponse(BlockBlobStageBlockFromUrlOptions options, Duration timeout, Context context)"
|
|
desc: "Creates a new block to be committed as part of a blob where the contents are read from a URL. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nBlobRequestConditions sourceRequestConditions = new BlobRequestConditions()\n .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));\n Context context = new Context(\"key\", \"value\");\n\n System.out.printf(\"Staging block from URL completed with status %d%n\",\n client.stageBlockFromUrlWithResponse(new BlockBlobStageBlockFromUrlOptions(base64BlockId, sourceUrl)\n .setSourceRange(new BlobRange(offset, count)).setLeaseId(leaseId)\n .setSourceRequestConditions(sourceRequestConditions), timeout, context).getStatusCode());\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-block-from-url"
|
|
returns:
|
|
description: "A response containing status code and HTTP headers"
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.stageBlockFromUrlWithResponse(java.lang.String,java.lang.String,com.azure.storage.blob.models.BlobRange,byte[],java.lang.String,com.azure.storage.blob.models.BlobRequestConditions,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.stageBlockFromUrlWithResponse(String base64BlockId, String sourceUrl, BlobRange sourceRange, byte[] sourceContentMd5, String leaseId, BlobRequestConditions sourceRequestConditions, Duration timeout, Context context)"
|
|
name: "stageBlockFromUrlWithResponse(String base64BlockId, String sourceUrl, BlobRange sourceRange, byte[] sourceContentMd5, String leaseId, BlobRequestConditions sourceRequestConditions, Duration timeout, Context context)"
|
|
nameWithType: "BlockBlobClient.stageBlockFromUrlWithResponse(String base64BlockId, String sourceUrl, BlobRange sourceRange, byte[] sourceContentMd5, String leaseId, BlobRequestConditions sourceRequestConditions, Duration timeout, Context context)"
|
|
summary: "Creates a new block to be committed as part of a blob where the contents are read from a URL."
|
|
parameters:
|
|
- description: "A Base64 encoded <code>String</code> that specifies the ID for this block. Note that all block\n ids for a given blob must be the same length."
|
|
name: "base64BlockId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The url to the blob that will be the source of the copy. A source blob in the same storage\n account can be authenticated via Shared Key. However, if the source is a blob in another account, the source blob\n must either be public or must be authenticated via a shared access signature. If the source blob is public, no\n authentication is required to perform the operation."
|
|
name: "sourceUrl"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "<xref uid=\"com.azure.storage.blob.models.BlobRange\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRange\"></xref>"
|
|
name: "sourceRange"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobRange?alt=com.azure.storage.blob.models.BlobRange&text=BlobRange\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An MD5 hash of the block content. This hash is used to verify the integrity of the block\n during transport. When this header is specified, the storage service compares the hash of the content that has\n arrived with this header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not\n match, the operation will fail."
|
|
name: "sourceContentMd5"
|
|
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
|
|
- description: "The lease ID that the active lease on the blob must match."
|
|
name: "leaseId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "<xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref>"
|
|
name: "sourceRequestConditions"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobRequestConditions?alt=com.azure.storage.blob.models.BlobRequestConditions&text=BlobRequestConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> stageBlockFromUrlWithResponse(String base64BlockId, String sourceUrl, BlobRange sourceRange, byte[] sourceContentMd5, String leaseId, BlobRequestConditions sourceRequestConditions, Duration timeout, Context context)"
|
|
desc: "Creates a new block to be committed as part of a blob where the contents are read from a URL. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nBlobRequestConditions sourceRequestConditions = new BlobRequestConditions()\n .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));\n Context context = new Context(\"key\", \"value\");\n\n System.out.printf(\"Staging block from URL completed with status %d%n\",\n client.stageBlockFromUrlWithResponse(base64BlockId, sourceUrl, new BlobRange(offset, count), null,\n leaseId, sourceRequestConditions, timeout, context).getStatusCode());\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-block-from-url"
|
|
returns:
|
|
description: "A response containing status code and HTTP headers"
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.stageBlockWithResponse(com.azure.storage.blob.options.BlockBlobStageBlockOptions,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.stageBlockWithResponse(BlockBlobStageBlockOptions options, Duration timeout, Context context)"
|
|
name: "stageBlockWithResponse(BlockBlobStageBlockOptions options, Duration timeout, Context context)"
|
|
nameWithType: "BlockBlobClient.stageBlockWithResponse(BlockBlobStageBlockOptions options, Duration timeout, Context context)"
|
|
summary: "Uploads the specified block to the block blob's \"staging area\" to be later committed by a call to commit<wbr>Block<wbr>List."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.blob.options.BlockBlobStageBlockOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlockBlobStageBlockOptions\"></xref>"
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.storage.blob.options.BlockBlobStageBlockOptions?alt=com.azure.storage.blob.options.BlockBlobStageBlockOptions&text=BlockBlobStageBlockOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> stageBlockWithResponse(BlockBlobStageBlockOptions options, Duration timeout, Context context)"
|
|
desc: "Uploads the specified block to the block blob's \"staging area\" to be later committed by a call to commitBlockList. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nContext context = new Context(\"key\", \"value\");\n BinaryData binaryData = BinaryData.fromStream(data, length);\n BlockBlobStageBlockOptions options = new BlockBlobStageBlockOptions(base64BlockId, binaryData)\n .setContentMd5(md5)\n .setLeaseId(leaseId);\n System.out.printf(\"Staging block completed with status %d%n\",\n client.stageBlockWithResponse(options, timeout, context).getStatusCode());\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-block"
|
|
returns:
|
|
description: "A response containing status code and HTTP headers"
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.stageBlockWithResponse(java.lang.String,java.io.InputStream,long,byte[],java.lang.String,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.stageBlockWithResponse(String base64BlockId, InputStream data, long length, byte[] contentMd5, String leaseId, Duration timeout, Context context)"
|
|
name: "stageBlockWithResponse(String base64BlockId, InputStream data, long length, byte[] contentMd5, String leaseId, Duration timeout, Context context)"
|
|
nameWithType: "BlockBlobClient.stageBlockWithResponse(String base64BlockId, InputStream data, long length, byte[] contentMd5, String leaseId, Duration timeout, Context context)"
|
|
summary: "Uploads the specified block to the block blob's \"staging area\" to be later committed by a call to commit<wbr>Block<wbr>List."
|
|
parameters:
|
|
- description: "A Base64 encoded <code>String</code> that specifies the ID for this block. Note that all block\n ids for a given blob must be the same length."
|
|
name: "base64BlockId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The data to write to the block. The data must be markable. This is in order to support retries. If\n the data is not markable, consider using <xref uid=\"com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getBlobOutputStream()\"></xref> and writing to the returned OutputStream.\n Alternatively, consider wrapping your data source in a <a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/BufferedInputStream.html\">BufferedInputStream</a> to add mark support."
|
|
name: "data"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html\">InputStream</a>"
|
|
- description: "The exact length of the data. It is important that this value match precisely the length of the\n data provided in the <xref uid=\"java.io.InputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"InputStream\"></xref>."
|
|
name: "length"
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An MD5 hash of the block content. This hash is used to verify the integrity of the block during\n transport. When this header is specified, the storage service compares the hash of the content that has arrived\n with this header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the\n operation will fail."
|
|
name: "contentMd5"
|
|
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
|
|
- description: "The lease ID the active lease on the blob must match."
|
|
name: "leaseId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<Void> stageBlockWithResponse(String base64BlockId, InputStream data, long length, byte[] contentMd5, String leaseId, Duration timeout, Context context)"
|
|
desc: "Uploads the specified block to the block blob's \"staging area\" to be later committed by a call to commitBlockList. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nContext context = new Context(\"key\", \"value\");\n System.out.printf(\"Staging block completed with status %d%n\",\n client.stageBlockWithResponse(base64BlockId, data, length, md5, leaseId, timeout, context).getStatusCode());\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-block"
|
|
returns:
|
|
description: "A response containing status code and HTTP headers"
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.upload(com.azure.core.util.BinaryData)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.upload(BinaryData data)"
|
|
name: "upload(BinaryData data)"
|
|
nameWithType: "BlockBlobClient.upload(BinaryData data)"
|
|
summary: "Creates a new block blob."
|
|
parameters:
|
|
- description: "The data to write to the block. Note that this <code>BinaryData</code> must have defined length\n and must be replayable if retries are enabled (the default), see <xref uid=\"com.azure.core.util.BinaryData.isReplayable*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BinaryData#isReplayable()\"></xref>."
|
|
name: "data"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlockBlobItem upload(BinaryData data)"
|
|
desc: "Creates a new block blob. By default, this method will not overwrite an existing blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with PutBlob; the content of the existing blob is overwritten with the new content. To perform a partial update of a block blob's, use PutBlock and PutBlockList. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nBinaryData binaryData = BinaryData.fromStream(data, length);\n System.out.printf(\"Uploaded BlockBlob MD5 is %s%n\",\n Base64.getEncoder().encodeToString(client.upload(binaryData).getContentMd5()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-blob"
|
|
returns:
|
|
description: "The information of the uploaded block blob."
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlockBlobItem?alt=com.azure.storage.blob.models.BlockBlobItem&text=BlockBlobItem\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.upload(com.azure.core.util.BinaryData,boolean)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.upload(BinaryData data, boolean overwrite)"
|
|
name: "upload(BinaryData data, boolean overwrite)"
|
|
nameWithType: "BlockBlobClient.upload(BinaryData data, boolean overwrite)"
|
|
summary: "Creates a new block blob, or updates the content of an existing block blob."
|
|
parameters:
|
|
- description: "The data to write to the block. Note that this <code>BinaryData</code> must have defined length\n and must be replayable if retries are enabled (the default), see <xref uid=\"com.azure.core.util.BinaryData.isReplayable*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BinaryData#isReplayable()\"></xref>."
|
|
name: "data"
|
|
type: "<xref href=\"com.azure.core.util.BinaryData?alt=com.azure.core.util.BinaryData&text=BinaryData\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Whether to overwrite, should data exist on the blob."
|
|
name: "overwrite"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlockBlobItem upload(BinaryData data, boolean overwrite)"
|
|
desc: "Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with PutBlob; the content of the existing blob is overwritten with the new content. To perform a partial update of a block blob's, use PutBlock and PutBlockList. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nboolean overwrite = false;\n BinaryData binaryData = BinaryData.fromStream(data, length);\n System.out.printf(\"Uploaded BlockBlob MD5 is %s%n\",\n Base64.getEncoder().encodeToString(client.upload(binaryData, overwrite).getContentMd5()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-blob"
|
|
returns:
|
|
description: "The information of the uploaded block blob."
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlockBlobItem?alt=com.azure.storage.blob.models.BlockBlobItem&text=BlockBlobItem\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.upload(java.io.InputStream,long)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.upload(InputStream data, long length)"
|
|
name: "upload(InputStream data, long length)"
|
|
nameWithType: "BlockBlobClient.upload(InputStream data, long length)"
|
|
summary: "Creates a new block blob."
|
|
parameters:
|
|
- description: "The data to write to the blob. The data must be markable. This is in order to support retries. If\n the data is not markable, consider using <xref uid=\"com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getBlobOutputStream()\"></xref> and writing to the returned OutputStream.\n Alternatively, consider wrapping your data source in a <a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/BufferedInputStream.html\">BufferedInputStream</a> to add mark support."
|
|
name: "data"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html\">InputStream</a>"
|
|
- description: "The exact length of the data. It is important that this value match precisely the length of the\n data provided in the <xref uid=\"java.io.InputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"InputStream\"></xref>."
|
|
name: "length"
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlockBlobItem upload(InputStream data, long length)"
|
|
desc: "Creates a new block blob. By default, this method will not overwrite an existing blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with PutBlob; the content of the existing blob is overwritten with the new content. To perform a partial update of a block blob's, use PutBlock and PutBlockList. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nSystem.out.printf(\"Uploaded BlockBlob MD5 is %s%n\",\n Base64.getEncoder().encodeToString(client.upload(data, length).getContentMd5()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-blob"
|
|
returns:
|
|
description: "The information of the uploaded block blob."
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlockBlobItem?alt=com.azure.storage.blob.models.BlockBlobItem&text=BlockBlobItem\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.upload(java.io.InputStream,long,boolean)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.upload(InputStream data, long length, boolean overwrite)"
|
|
name: "upload(InputStream data, long length, boolean overwrite)"
|
|
nameWithType: "BlockBlobClient.upload(InputStream data, long length, boolean overwrite)"
|
|
summary: "Creates a new block blob, or updates the content of an existing block blob."
|
|
parameters:
|
|
- description: "The data to write to the blob. The data must be markable. This is in order to support retries. If\n the data is not markable, consider using <xref uid=\"com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getBlobOutputStream()\"></xref> and writing to the returned OutputStream.\n Alternatively, consider wrapping your data source in a <a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/BufferedInputStream.html\">BufferedInputStream</a> to add mark support."
|
|
name: "data"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html\">InputStream</a>"
|
|
- description: "The exact length of the data. It is important that this value match precisely the length of the\n data provided in the <xref uid=\"java.io.InputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"InputStream\"></xref>."
|
|
name: "length"
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Whether to overwrite, should data exist on the blob."
|
|
name: "overwrite"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlockBlobItem upload(InputStream data, long length, boolean overwrite)"
|
|
desc: "Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with PutBlob; the content of the existing blob is overwritten with the new content. To perform a partial update of a block blob's, use PutBlock and PutBlockList. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nboolean overwrite = false;\n System.out.printf(\"Uploaded BlockBlob MD5 is %s%n\",\n Base64.getEncoder().encodeToString(client.upload(data, length, overwrite).getContentMd5()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-blob"
|
|
returns:
|
|
description: "The information of the uploaded block blob."
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlockBlobItem?alt=com.azure.storage.blob.models.BlockBlobItem&text=BlockBlobItem\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.uploadFromUrl(java.lang.String)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.uploadFromUrl(String sourceUrl)"
|
|
name: "uploadFromUrl(String sourceUrl)"
|
|
nameWithType: "BlockBlobClient.uploadFromUrl(String sourceUrl)"
|
|
summary: "Creates a new block blob, or updates the content of an existing block blob."
|
|
parameters:
|
|
- description: "The source URL to upload from."
|
|
name: "sourceUrl"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public BlockBlobItem uploadFromUrl(String sourceUrl)"
|
|
desc: "Creates a new block blob, or updates the content of an existing block blob.\n\nUpdating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with PutBlobFromUrl; the content of the existing blob is overwritten with the new content. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nSystem.out.printf(\"Uploaded BlockBlob from URL, MD5 is %s%n\",\n Base64.getEncoder().encodeToString(client.uploadFromUrl(sourceUrl).getContentMd5()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-blob-from-url"
|
|
returns:
|
|
description: "The information of the uploaded block blob."
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlockBlobItem?alt=com.azure.storage.blob.models.BlockBlobItem&text=BlockBlobItem\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.uploadFromUrl(java.lang.String,boolean)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.uploadFromUrl(String sourceUrl, boolean overwrite)"
|
|
name: "uploadFromUrl(String sourceUrl, boolean overwrite)"
|
|
nameWithType: "BlockBlobClient.uploadFromUrl(String sourceUrl, boolean overwrite)"
|
|
summary: "Creates a new block blob, or updates the content of an existing block blob."
|
|
parameters:
|
|
- description: "The source URL to upload from."
|
|
name: "sourceUrl"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Whether to overwrite, should data exist on the blob."
|
|
name: "overwrite"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public BlockBlobItem uploadFromUrl(String sourceUrl, boolean overwrite)"
|
|
desc: "Creates a new block blob, or updates the content of an existing block blob.\n\nUpdating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with PutBlobFromUrl; the content of the existing blob is overwritten with the new content. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nboolean overwrite = false;\n System.out.printf(\"Uploaded BlockBlob from URL, MD5 is %s%n\",\n Base64.getEncoder().encodeToString(client.uploadFromUrl(sourceUrl, overwrite).getContentMd5()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-blob-from-url"
|
|
returns:
|
|
description: "The information of the uploaded block blob."
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlockBlobItem?alt=com.azure.storage.blob.models.BlockBlobItem&text=BlockBlobItem\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.uploadFromUrlWithResponse(com.azure.storage.blob.options.BlobUploadFromUrlOptions,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.uploadFromUrlWithResponse(BlobUploadFromUrlOptions options, Duration timeout, Context context)"
|
|
name: "uploadFromUrlWithResponse(BlobUploadFromUrlOptions options, Duration timeout, Context context)"
|
|
nameWithType: "BlockBlobClient.uploadFromUrlWithResponse(BlobUploadFromUrlOptions options, Duration timeout, Context context)"
|
|
summary: "Creates a new block blob, or updates the content of an existing block blob."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.blob.options.BlobUploadFromUrlOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobUploadFromUrlOptions\"></xref>"
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.storage.blob.options.BlobUploadFromUrlOptions?alt=com.azure.storage.blob.options.BlobUploadFromUrlOptions&text=BlobUploadFromUrlOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BlockBlobItem> uploadFromUrlWithResponse(BlobUploadFromUrlOptions options, Duration timeout, Context context)"
|
|
desc: "Creates a new block blob, or updates the content of an existing block blob.\n\nUpdating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with PutBlobFromUrl; the content of the existing blob is overwritten with the new content. For more information, see the [Azure Docs][].\n\nTo avoid overwriting, pass \"\\*\" to <xref uid=\"com.azure.storage.blob.models.BlobRequestConditions.setIfNoneMatch(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions#setIfNoneMatch(String)\"></xref>.\n\n**Code Samples**\n\n```java\nBlobHttpHeaders headers = new BlobHttpHeaders()\n .setContentMd5(MessageDigest.getInstance(\"MD5\").digest(\"data\".getBytes(StandardCharsets.UTF_8)))\n .setContentLanguage(\"en-US\")\n .setContentType(\"binary\");\n\n Map<String, String> metadata = Collections.singletonMap(\"metadata\", \"value\");\n Map<String, String> tags = Collections.singletonMap(\"tag\", \"value\");\n\n byte[] md5 = MessageDigest.getInstance(\"MD5\").digest(\"data\".getBytes(StandardCharsets.UTF_8));\n\n BlobRequestConditions requestConditions = new BlobRequestConditions()\n .setLeaseId(leaseId)\n .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));\n Context context = new Context(\"key\", \"value\");\n\n System.out.printf(\"Uploaded BlockBlob MD5 is %s%n\", Base64.getEncoder()\n .encodeToString(client.uploadFromUrlWithResponse(new BlobUploadFromUrlOptions(sourceUrl)\n .setHeaders(headers).setTags(tags).setTier(AccessTier.HOT).setContentMd5(md5)\n .setDestinationRequestConditions(requestConditions), timeout, context)\n .getValue()\n .getContentMd5()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-blob-from-url"
|
|
returns:
|
|
description: "The information of the uploaded block blob."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.blob.models.BlockBlobItem?alt=com.azure.storage.blob.models.BlockBlobItem&text=BlockBlobItem\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.uploadWithResponse(com.azure.storage.blob.options.BlockBlobSimpleUploadOptions,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.uploadWithResponse(BlockBlobSimpleUploadOptions options, Duration timeout, Context context)"
|
|
name: "uploadWithResponse(BlockBlobSimpleUploadOptions options, Duration timeout, Context context)"
|
|
nameWithType: "BlockBlobClient.uploadWithResponse(BlockBlobSimpleUploadOptions options, Duration timeout, Context context)"
|
|
summary: "Creates a new block blob, or updates the content of an existing block blob."
|
|
parameters:
|
|
- description: "<xref uid=\"com.azure.storage.blob.options.BlockBlobSimpleUploadOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlockBlobSimpleUploadOptions\"></xref>"
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.storage.blob.options.BlockBlobSimpleUploadOptions?alt=com.azure.storage.blob.options.BlockBlobSimpleUploadOptions&text=BlockBlobSimpleUploadOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BlockBlobItem> uploadWithResponse(BlockBlobSimpleUploadOptions options, Duration timeout, Context context)"
|
|
desc: "Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with PutBlob; the content of the existing blob is overwritten with the new content. To perform a partial update of a block blob's, use PutBlock and PutBlockList. For more information, see the [Azure Docs][].\n\nTo avoid overwriting, pass \"\\*\" to <xref uid=\"com.azure.storage.blob.models.BlobRequestConditions.setIfNoneMatch(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions#setIfNoneMatch(String)\"></xref>.\n\n**Code Samples**\n\n```java\nBlobHttpHeaders headers = new BlobHttpHeaders()\n .setContentMd5(MessageDigest.getInstance(\"MD5\").digest(\"data\".getBytes(StandardCharsets.UTF_8)))\n .setContentLanguage(\"en-US\")\n .setContentType(\"binary\");\n\n Map<String, String> metadata = Collections.singletonMap(\"metadata\", \"value\");\n Map<String, String> tags = Collections.singletonMap(\"tag\", \"value\");\n\n byte[] md5 = MessageDigest.getInstance(\"MD5\").digest(\"data\".getBytes(StandardCharsets.UTF_8));\n\n BlobRequestConditions requestConditions = new BlobRequestConditions()\n .setLeaseId(leaseId)\n .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));\n Context context = new Context(\"key\", \"value\");\n\n System.out.printf(\"Uploaded BlockBlob MD5 is %s%n\", Base64.getEncoder()\n .encodeToString(client.uploadWithResponse(new BlockBlobSimpleUploadOptions(data, length)\n .setHeaders(headers).setMetadata(metadata).setTags(tags).setTier(AccessTier.HOT).setContentMd5(md5)\n .setRequestConditions(requestConditions), timeout, context)\n .getValue()\n .getContentMd5()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-blob"
|
|
returns:
|
|
description: "The information of the uploaded block blob."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.blob.models.BlockBlobItem?alt=com.azure.storage.blob.models.BlockBlobItem&text=BlockBlobItem\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.storage.blob.specialized.BlockBlobClient.uploadWithResponse(java.io.InputStream,long,com.azure.storage.blob.models.BlobHttpHeaders,java.util.Map<java.lang.String,java.lang.String>,com.azure.storage.blob.models.AccessTier,byte[],com.azure.storage.blob.models.BlobRequestConditions,java.time.Duration,com.azure.core.util.Context)"
|
|
fullName: "com.azure.storage.blob.specialized.BlockBlobClient.uploadWithResponse(InputStream data, long length, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, byte[] contentMd5, BlobRequestConditions requestConditions, Duration timeout, Context context)"
|
|
name: "uploadWithResponse(InputStream data, long length, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, byte[] contentMd5, BlobRequestConditions requestConditions, Duration timeout, Context context)"
|
|
nameWithType: "BlockBlobClient.uploadWithResponse(InputStream data, long length, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, byte[] contentMd5, BlobRequestConditions requestConditions, Duration timeout, Context context)"
|
|
summary: "Creates a new block blob, or updates the content of an existing block blob."
|
|
parameters:
|
|
- description: "The data to write to the blob. The data must be markable. This is in order to support retries. If\n the data is not markable, consider using <xref uid=\"com.azure.storage.blob.specialized.BlockBlobClient.getBlobOutputStream()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getBlobOutputStream()\"></xref> and writing to the returned OutputStream.\n Alternatively, consider wrapping your data source in a <a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/BufferedInputStream.html\">BufferedInputStream</a> to add mark support."
|
|
name: "data"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html\">InputStream</a>"
|
|
- description: "The exact length of the data. It is important that this value match precisely the length of the\n data provided in the <xref uid=\"java.io.InputStream\" data-throw-if-not-resolved=\"false\" data-raw-source=\"InputStream\"></xref>."
|
|
name: "length"
|
|
type: "<xref href=\"long?alt=long&text=long\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "<xref uid=\"com.azure.storage.blob.models.BlobHttpHeaders\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobHttpHeaders\"></xref>"
|
|
name: "headers"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobHttpHeaders?alt=com.azure.storage.blob.models.BlobHttpHeaders&text=BlobHttpHeaders\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Metadata to associate with the blob. If there is leading or trailing whitespace in any\n metadata key or value, it must be removed or encoded."
|
|
name: "metadata"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<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>>"
|
|
- description: "<xref uid=\"com.azure.storage.blob.models.AccessTier\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccessTier\"></xref> for the destination blob."
|
|
name: "tier"
|
|
type: "<xref href=\"com.azure.storage.blob.models.AccessTier?alt=com.azure.storage.blob.models.AccessTier&text=AccessTier\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An MD5 hash of the block content. This hash is used to verify the integrity of the block during\n transport. When this header is specified, the storage service compares the hash of the content that has arrived\n with this header value. Note that this MD5 hash is not stored with the blob. If the two hashes do not match, the\n operation will fail."
|
|
name: "contentMd5"
|
|
type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
|
|
- description: "<xref uid=\"com.azure.storage.blob.models.BlobRequestConditions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions\"></xref>"
|
|
name: "requestConditions"
|
|
type: "<xref href=\"com.azure.storage.blob.models.BlobRequestConditions?alt=com.azure.storage.blob.models.BlobRequestConditions&text=BlobRequestConditions\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "An optional timeout value beyond which a <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"RuntimeException\"></xref> will be raised."
|
|
name: "timeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- description: "Additional context that is passed through the Http pipeline during the service call."
|
|
name: "context"
|
|
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public Response<BlockBlobItem> uploadWithResponse(InputStream data, long length, BlobHttpHeaders headers, Map<String,String> metadata, AccessTier tier, byte[] contentMd5, BlobRequestConditions requestConditions, Duration timeout, Context context)"
|
|
desc: "Creates a new block blob, or updates the content of an existing block blob. Updating an existing block blob overwrites any existing metadata on the blob. Partial updates are not supported with PutBlob; the content of the existing blob is overwritten with the new content. To perform a partial update of a block blob's, use PutBlock and PutBlockList. For more information, see the [Azure Docs][].\n\nTo avoid overwriting, pass \"\\*\" to <xref uid=\"com.azure.storage.blob.models.BlobRequestConditions.setIfNoneMatch(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobRequestConditions#setIfNoneMatch(String)\"></xref>.\n\n**Code Samples**\n\n```java\nBlobHttpHeaders headers = new BlobHttpHeaders()\n .setContentMd5(MessageDigest.getInstance(\"MD5\").digest(\"data\".getBytes(StandardCharsets.UTF_8)))\n .setContentLanguage(\"en-US\")\n .setContentType(\"binary\");\n\n Map<String, String> metadata = Collections.singletonMap(\"metadata\", \"value\");\n\n byte[] md5 = MessageDigest.getInstance(\"MD5\").digest(\"data\".getBytes(StandardCharsets.UTF_8));\n\n BlobRequestConditions requestConditions = new BlobRequestConditions()\n .setLeaseId(leaseId)\n .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));\n Context context = new Context(\"key\", \"value\");\n\n System.out.printf(\"Uploaded BlockBlob MD5 is %s%n\", Base64.getEncoder()\n .encodeToString(client.uploadWithResponse(data, length, headers, metadata, AccessTier.HOT, md5,\n requestConditions, timeout, context)\n .getValue()\n .getContentMd5()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/put-blob"
|
|
returns:
|
|
description: "The information of the uploaded block blob."
|
|
type: "<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.storage.blob.models.BlockBlobItem?alt=com.azure.storage.blob.models.BlockBlobItem&text=BlockBlobItem\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "class"
|
|
desc: "Client to a block blob. It may only be instantiated through a <xref uid=\"com.azure.storage.blob.specialized.SpecializedBlobClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SpecializedBlobClientBuilder\"></xref> or via the method <xref uid=\"com.azure.storage.blob.BlobClient.getBlockBlobClient()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobClient#getBlockBlobClient()\"></xref>. This class does not hold any state about a particular blob, but is instead a convenient way of sending appropriate requests to the resource on the service.\n\nPlease refer to the [Azure Docs][] for more information.\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs"
|
|
metadata: {}
|
|
package: "com.azure.storage.blob.specialized"
|
|
artifact: com.azure:azure-storage-blob:12.28.1
|