### YamlMime:JavaType
uid: "com.azure.storage.blob.BlobClient"
fullName: "com.azure.storage.blob.BlobClient"
name: "BlobClient"
nameWithType: "BlobClient"
summary: "This class provides a client that contains generic blob operations for Azure Storage Blobs."
inheritances:
- ""
- ""
inheritedClassMethods:
- classRef: ""
methodsRef:
- ""
- ""
- ""
- ""
- ",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\" />"
- ""
- ""
- ",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\" />"
- ""
- ",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\" />"
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ",java.time.Duration,com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.downloadToFileWithResponse&text=downloadToFileWithResponse\" data-throw-if-not-resolved=\"False\" />"
- ""
- ""
- ""
- ""
- ""
- ",com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.generateSas&text=generateSas\" data-throw-if-not-resolved=\"False\" />"
- ""
- ""
- ",com.azure.core.util.Context)?alt=com.azure.storage.blob.specialized.BlobClientBase.generateUserDelegationSas&text=generateUserDelegationSas\" data-throw-if-not-resolved=\"False\" />"
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ""
- ")?alt=com.azure.storage.blob.specialized.BlobClientBase.setMetadata&text=setMetadata\" data-throw-if-not-resolved=\"False\" />"
- ",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\" />"
- ")?alt=com.azure.storage.blob.specialized.BlobClientBase.setTags&text=setTags\" data-throw-if-not-resolved=\"False\" />"
- ""
- ""
- ""
- classRef: "java.lang.Object"
methodsRef:
- "clone"
- "equals"
- "finalize"
- "getClass"
- "hashCode"
- "notify"
- "notifyAll"
- "toString"
- "wait"
- "wait"
- "wait"
syntax: "public class **BlobClient** extends "
constructors:
- uid: "com.azure.storage.blob.BlobClient.BlobClient(com.azure.storage.blob.BlobAsyncClient)"
fullName: "com.azure.storage.blob.BlobClient.BlobClient(BlobAsyncClient client)"
name: "BlobClient(BlobAsyncClient client)"
nameWithType: "BlobClient.BlobClient(BlobAsyncClient client)"
summary: "Protected constructor for use by ."
modifiers:
- "protected"
parameters:
- description: "the async blob client"
name: "client"
type: ""
syntax: "protected BlobClient(BlobAsyncClient client)"
desc: "Protected constructor for use by ."
fields:
- uid: "com.azure.storage.blob.BlobClient.BLOB_DEFAULT_HTBB_UPLOAD_BLOCK_SIZE"
fullName: "com.azure.storage.blob.BlobClient.BLOB_DEFAULT_HTBB_UPLOAD_BLOCK_SIZE"
name: "BLOB_DEFAULT_HTBB_UPLOAD_BLOCK_SIZE"
nameWithType: "BlobClient.BLOB_DEFAULT_HTBB_UPLOAD_BLOCK_SIZE"
summary: "If a blob is known to be greater than 100MB, using a larger block size will trigger some server-side optimizations."
modifiers:
- "static"
- "final"
field:
value: "8388608"
type: ""
syntax: "public static final int BLOB_DEFAULT_HTBB_UPLOAD_BLOCK_SIZE"
desc: "If a blob is known to be greater than 100MB, using a larger block size will trigger some server-side optimizations. If the block size is not set and the size of the blob is known to be greater than 100MB, this value will be used."
- uid: "com.azure.storage.blob.BlobClient.BLOB_DEFAULT_NUMBER_OF_BUFFERS"
fullName: "com.azure.storage.blob.BlobClient.BLOB_DEFAULT_NUMBER_OF_BUFFERS"
name: "BLOB_DEFAULT_NUMBER_OF_BUFFERS"
nameWithType: "BlobClient.BLOB_DEFAULT_NUMBER_OF_BUFFERS"
summary: "The number of buffers to use if none is specied on the buffered upload method."
modifiers:
- "static"
- "final"
field:
value: "8"
type: ""
syntax: "public static final int BLOB_DEFAULT_NUMBER_OF_BUFFERS"
desc: "The number of buffers to use if none is specied on the buffered upload method."
- uid: "com.azure.storage.blob.BlobClient.BLOB_DEFAULT_UPLOAD_BLOCK_SIZE"
fullName: "com.azure.storage.blob.BlobClient.BLOB_DEFAULT_UPLOAD_BLOCK_SIZE"
name: "BLOB_DEFAULT_UPLOAD_BLOCK_SIZE"
nameWithType: "BlobClient.BLOB_DEFAULT_UPLOAD_BLOCK_SIZE"
summary: "The block size to use if none is specified in parallel operations."
modifiers:
- "static"
- "final"
field:
value: "4194304"
type: ""
syntax: "public static final int BLOB_DEFAULT_UPLOAD_BLOCK_SIZE"
desc: "The block size to use if none is specified in parallel operations."
methods:
- uid: "com.azure.storage.blob.BlobClient.getAppendBlobClient()"
fullName: "com.azure.storage.blob.BlobClient.getAppendBlobClient()"
name: "getAppendBlobClient()"
nameWithType: "BlobClient.getAppendBlobClient()"
summary: "Creates a new associated with this blob."
syntax: "public AppendBlobClient getAppendBlobClient()"
desc: "Creates a new associated with this blob."
returns:
description: "A associated with this blob."
type: ""
- uid: "com.azure.storage.blob.BlobClient.getBlockBlobClient()"
fullName: "com.azure.storage.blob.BlobClient.getBlockBlobClient()"
name: "getBlockBlobClient()"
nameWithType: "BlobClient.getBlockBlobClient()"
summary: "Creates a new associated with this blob."
syntax: "public BlockBlobClient getBlockBlobClient()"
desc: "Creates a new associated with this blob."
returns:
description: "A associated with this blob."
type: ""
- uid: "com.azure.storage.blob.BlobClient.getCustomerProvidedKeyClient(com.azure.storage.blob.models.CustomerProvidedKey)"
fullName: "com.azure.storage.blob.BlobClient.getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)"
name: "getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)"
nameWithType: "BlobClient.getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)"
summary: "Creates a new with the specified `customerProvidedKey`."
overridden: "com.azure.storage.blob.specialized.BlobClientBase.getCustomerProvidedKeyClient(com.azure.storage.blob.models.CustomerProvidedKey)"
parameters:
- description: "the for the blob,\n pass null
to use no customer provided key."
name: "customerProvidedKey"
type: ""
syntax: "public BlobClient getCustomerProvidedKeyClient(CustomerProvidedKey customerProvidedKey)"
desc: "Creates a new with the specified `customerProvidedKey`."
returns:
description: "a with the specified customerProvidedKey
."
type: ""
- uid: "com.azure.storage.blob.BlobClient.getEncryptionScopeClient(java.lang.String)"
fullName: "com.azure.storage.blob.BlobClient.getEncryptionScopeClient(String encryptionScope)"
name: "getEncryptionScopeClient(String encryptionScope)"
nameWithType: "BlobClient.getEncryptionScopeClient(String encryptionScope)"
summary: "Creates a new with the specified `encryptionScope`."
overridden: "com.azure.storage.blob.specialized.BlobClientBase.getEncryptionScopeClient(java.lang.String)"
parameters:
- description: "the encryption scope for the blob, pass null
to use no encryption scope."
name: "encryptionScope"
type: "String"
syntax: "public BlobClient getEncryptionScopeClient(String encryptionScope)"
desc: "Creates a new with the specified `encryptionScope`."
returns:
description: "a with the specified encryptionScope
."
type: ""
- uid: "com.azure.storage.blob.BlobClient.getPageBlobClient()"
fullName: "com.azure.storage.blob.BlobClient.getPageBlobClient()"
name: "getPageBlobClient()"
nameWithType: "BlobClient.getPageBlobClient()"
summary: "Creates a new associated with this blob."
syntax: "public PageBlobClient getPageBlobClient()"
desc: "Creates a new associated with this blob."
returns:
description: "A associated with this blob."
type: ""
- uid: "com.azure.storage.blob.BlobClient.getSnapshotClient(java.lang.String)"
fullName: "com.azure.storage.blob.BlobClient.getSnapshotClient(String snapshot)"
name: "getSnapshotClient(String snapshot)"
nameWithType: "BlobClient.getSnapshotClient(String snapshot)"
summary: "Creates a new linked to the `snapshot` of this blob resource."
overridden: "com.azure.storage.blob.specialized.BlobClientBase.getSnapshotClient(java.lang.String)"
parameters:
- description: "the identifier for a specific snapshot of this blob"
name: "snapshot"
type: "String"
syntax: "public BlobClient getSnapshotClient(String snapshot)"
desc: "Creates a new linked to the `snapshot` of this blob resource."
returns:
description: "A used to interact with the specific snapshot."
type: ""
- uid: "com.azure.storage.blob.BlobClient.getVersionClient(java.lang.String)"
fullName: "com.azure.storage.blob.BlobClient.getVersionClient(String versionId)"
name: "getVersionClient(String versionId)"
nameWithType: "BlobClient.getVersionClient(String versionId)"
summary: "Creates a new linked to the `version` of this blob resource."
overridden: "com.azure.storage.blob.specialized.BlobClientBase.getVersionClient(java.lang.String)"
parameters:
- description: "the identifier for a specific version of this blob,\n pass null
to interact with the latest blob version."
name: "versionId"
type: "String"
syntax: "public BlobClient getVersionClient(String versionId)"
desc: "Creates a new linked to the `version` of this blob resource."
returns:
description: "A used to interact with the specific version."
type: ""
- uid: "com.azure.storage.blob.BlobClient.upload(com.azure.core.util.BinaryData)"
fullName: "com.azure.storage.blob.BlobClient.upload(BinaryData data)"
name: "upload(BinaryData data)"
nameWithType: "BlobClient.upload(BinaryData data)"
summary: "Creates a new blob."
parameters:
- description: "The data to write to the blob."
name: "data"
type: ""
syntax: "public void upload(BinaryData data)"
desc: "Creates a new blob. By default this method will not overwrite an existing blob."
- uid: "com.azure.storage.blob.BlobClient.upload(com.azure.core.util.BinaryData,boolean)"
fullName: "com.azure.storage.blob.BlobClient.upload(BinaryData data, boolean overwrite)"
name: "upload(BinaryData data, boolean overwrite)"
nameWithType: "BlobClient.upload(BinaryData data, boolean overwrite)"
summary: "Creates a new blob, or updates the content of an existing blob."
parameters:
- description: "The data to write to the blob."
name: "data"
type: ""
- description: "Whether or not to overwrite, should data exist on the blob."
name: "overwrite"
type: ""
syntax: "public void upload(BinaryData data, boolean overwrite)"
desc: "Creates a new blob, or updates the content of an existing blob."
- uid: "com.azure.storage.blob.BlobClient.upload(java.io.InputStream)"
fullName: "com.azure.storage.blob.BlobClient.upload(InputStream data)"
name: "upload(InputStream data)"
nameWithType: "BlobClient.upload(InputStream data)"
summary: "Creates a new 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 opening a and\n writing to the returned stream. Alternatively, consider wrapping your data source in a\n BufferedInputStream to add mark support."
name: "data"
type: "InputStream"
syntax: "public void upload(InputStream data)"
desc: "Creates a new blob. By default this method will not overwrite an existing blob."
- uid: "com.azure.storage.blob.BlobClient.upload(java.io.InputStream,boolean)"
fullName: "com.azure.storage.blob.BlobClient.upload(InputStream data, boolean overwrite)"
name: "upload(InputStream data, boolean overwrite)"
nameWithType: "BlobClient.upload(InputStream data, boolean overwrite)"
summary: "Creates a new blob, or updates the content of an existing 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 opening a and\n writing to the returned stream. Alternatively, consider wrapping your data source in a\n BufferedInputStream to add mark support."
name: "data"
type: "InputStream"
- description: "Whether or not to overwrite, should data exist on the blob."
name: "overwrite"
type: ""
syntax: "public void upload(InputStream data, boolean overwrite)"
desc: "Creates a new blob, or updates the content of an existing blob."
- uid: "com.azure.storage.blob.BlobClient.upload(java.io.InputStream,long)"
fullName: "com.azure.storage.blob.BlobClient.upload(InputStream data, long length)"
name: "upload(InputStream data, long length)"
nameWithType: "BlobClient.upload(InputStream data, long length)"
summary: "Creates a new 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 opening a and\n writing to the returned stream. Alternatively, consider wrapping your data source in a\n BufferedInputStream to add mark support."
name: "data"
type: "InputStream"
- description: "The exact length of the data. It is important that this value match precisely the length of the\n data provided in the ."
name: "length"
type: ""
syntax: "public void upload(InputStream data, long length)"
desc: "Creates a new blob. By default this method will not overwrite an existing blob."
- uid: "com.azure.storage.blob.BlobClient.upload(java.io.InputStream,long,boolean)"
fullName: "com.azure.storage.blob.BlobClient.upload(InputStream data, long length, boolean overwrite)"
name: "upload(InputStream data, long length, boolean overwrite)"
nameWithType: "BlobClient.upload(InputStream data, long length, boolean overwrite)"
summary: "Creates a new blob, or updates the content of an existing 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 opening a and\n writing to the returned stream. Alternatively, consider wrapping your data source in a\n BufferedInputStream to add mark support."
name: "data"
type: "InputStream"
- description: "The exact length of the data. It is important that this value match precisely the length of the\n data provided in the ."
name: "length"
type: ""
- description: "Whether or not to overwrite, should data exist on the blob."
name: "overwrite"
type: ""
syntax: "public void upload(InputStream data, long length, boolean overwrite)"
desc: "Creates a new blob, or updates the content of an existing blob."
- uid: "com.azure.storage.blob.BlobClient.uploadFromFile(java.lang.String)"
fullName: "com.azure.storage.blob.BlobClient.uploadFromFile(String filePath)"
name: "uploadFromFile(String filePath)"
nameWithType: "BlobClient.uploadFromFile(String filePath)"
summary: "Creates a new block blob."
parameters:
- description: "Path of the file to upload"
name: "filePath"
type: "String"
syntax: "public void uploadFromFile(String filePath)"
desc: "Creates a new block blob. By default this method will not overwrite an existing blob.\n\n**Code Samples**\n\n```java\ntry {\n client.uploadFromFile(filePath);\n System.out.println(\"Upload from file succeeded\");\n } catch (UncheckedIOException ex) {\n System.err.printf(\"Failed to upload from file %s%n\", ex.getMessage());\n }\n```"
- uid: "com.azure.storage.blob.BlobClient.uploadFromFile(java.lang.String,boolean)"
fullName: "com.azure.storage.blob.BlobClient.uploadFromFile(String filePath, boolean overwrite)"
name: "uploadFromFile(String filePath, boolean overwrite)"
nameWithType: "BlobClient.uploadFromFile(String filePath, boolean overwrite)"
summary: "Creates a new block blob, or updates the content of an existing block blob."
parameters:
- description: "Path of the file to upload"
name: "filePath"
type: "String"
- description: "Whether or not to overwrite, should the blob already exist"
name: "overwrite"
type: ""
syntax: "public void uploadFromFile(String filePath, boolean overwrite)"
desc: "Creates a new block blob, or updates the content of an existing block blob.\n\n**Code Samples**\n\n```java\ntry {\n boolean overwrite = false;\n client.uploadFromFile(filePath, overwrite);\n System.out.println(\"Upload from file succeeded\");\n } catch (UncheckedIOException ex) {\n System.err.printf(\"Failed to upload from file %s%n\", ex.getMessage());\n }\n```"
- uid: "com.azure.storage.blob.BlobClient.uploadFromFile(java.lang.String,com.azure.storage.blob.models.ParallelTransferOptions,com.azure.storage.blob.models.BlobHttpHeaders,java.util.Map,com.azure.storage.blob.models.AccessTier,com.azure.storage.blob.models.BlobRequestConditions,java.time.Duration)"
fullName: "com.azure.storage.blob.BlobClient.uploadFromFile(String filePath, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout)"
name: "uploadFromFile(String filePath, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout)"
nameWithType: "BlobClient.uploadFromFile(String filePath, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout)"
summary: "Creates a new block blob, or updates the content of an existing block blob."
parameters:
- description: "Path of the file to upload"
name: "filePath"
type: "String"
- description: " to use to upload from file. Number of parallel\n transfers parameter is ignored."
name: "parallelTransferOptions"
type: ""
- description: ""
name: "headers"
type: ""
- 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: "Map<String,String>"
- description: " for the uploaded blob"
name: "tier"
type: ""
- description: ""
name: "requestConditions"
type: ""
- description: "An optional timeout value beyond which a will be raised."
name: "timeout"
type: "Duration"
syntax: "public void uploadFromFile(String filePath, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout)"
desc: "Creates a new block blob, or updates the content of an existing block blob.\n\nTo avoid overwriting, pass \"\\*\" to .\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 metadata = Collections.singletonMap(\"metadata\", \"value\");\n BlobRequestConditions requestConditions = new BlobRequestConditions()\n .setLeaseId(leaseId)\n .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));\n Long blockSize = 100L * 1024L * 1024L; // 100 MB;\n ParallelTransferOptions parallelTransferOptions = new ParallelTransferOptions().setBlockSizeLong(blockSize);\n\n try {\n client.uploadFromFile(filePath, parallelTransferOptions, headers, metadata,\n AccessTier.HOT, requestConditions, timeout);\n System.out.println(\"Upload from file succeeded\");\n } catch (UncheckedIOException ex) {\n System.err.printf(\"Failed to upload from file %s%n\", ex.getMessage());\n }\n```"
- uid: "com.azure.storage.blob.BlobClient.uploadFromFileWithResponse(com.azure.storage.blob.options.BlobUploadFromFileOptions,java.time.Duration,com.azure.core.util.Context)"
fullName: "com.azure.storage.blob.BlobClient.uploadFromFileWithResponse(BlobUploadFromFileOptions options, Duration timeout, Context context)"
name: "uploadFromFileWithResponse(BlobUploadFromFileOptions options, Duration timeout, Context context)"
nameWithType: "BlobClient.uploadFromFileWithResponse(BlobUploadFromFileOptions options, Duration timeout, Context context)"
summary: "Creates a new block blob, or updates the content of an existing block blob."
parameters:
- description: ""
name: "options"
type: ""
- description: "An optional timeout value beyond which a will be raised."
name: "timeout"
type: "Duration"
- description: "Additional context that is passed through the Http pipeline during the service call."
name: "context"
type: ""
syntax: "public Response uploadFromFileWithResponse(BlobUploadFromFileOptions options, Duration timeout, Context context)"
desc: "Creates a new block blob, or updates the content of an existing block blob.\n\nTo avoid overwriting, pass \"\\*\" to .\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 metadata = Collections.singletonMap(\"metadata\", \"value\");\n Map tags = Collections.singletonMap(\"tag\", \"value\");\n BlobRequestConditions requestConditions = new BlobRequestConditions()\n .setLeaseId(leaseId)\n .setIfUnmodifiedSince(OffsetDateTime.now().minusDays(3));\n Long blockSize = 100 * 1024 * 1024L; // 100 MB;\n ParallelTransferOptions parallelTransferOptions = new ParallelTransferOptions().setBlockSizeLong(blockSize);\n\n try {\n client.uploadFromFileWithResponse(new BlobUploadFromFileOptions(filePath)\n .setParallelTransferOptions(parallelTransferOptions).setHeaders(headers).setMetadata(metadata)\n .setTags(tags).setTier(AccessTier.HOT).setRequestConditions(requestConditions), timeout,\n new Context(key2, value2));\n System.out.println(\"Upload from file succeeded\");\n } catch (UncheckedIOException ex) {\n System.err.printf(\"Failed to upload from file %s%n\", ex.getMessage());\n }\n```"
returns:
description: "Information about the uploaded block blob."
type: "<>"
- uid: "com.azure.storage.blob.BlobClient.uploadWithResponse(com.azure.storage.blob.options.BlobParallelUploadOptions,com.azure.core.util.Context)"
fullName: "com.azure.storage.blob.BlobClient.uploadWithResponse(BlobParallelUploadOptions options, Context context)"
name: "uploadWithResponse(BlobParallelUploadOptions options, Context context)"
nameWithType: "BlobClient.uploadWithResponse(BlobParallelUploadOptions options, Context context)"
summary: "Creates a new blob, or updates the content of an existing blob."
deprecatedTag: "Use "
parameters:
- description: ""
name: "options"
type: ""
- description: "Additional context that is passed through the Http pipeline during the service call."
name: "context"
type: ""
syntax: "@Deprecatedpublic Response uploadWithResponse(BlobParallelUploadOptions options, Context context)"
desc: "Creates a new blob, or updates the content of an existing blob.\n\nTo avoid overwriting, pass \"\\*\" to ."
hasDeprecatedTag: true
returns:
description: "Information about the uploaded block blob."
type: "<>"
- uid: "com.azure.storage.blob.BlobClient.uploadWithResponse(com.azure.storage.blob.options.BlobParallelUploadOptions,java.time.Duration,com.azure.core.util.Context)"
fullName: "com.azure.storage.blob.BlobClient.uploadWithResponse(BlobParallelUploadOptions options, Duration timeout, Context context)"
name: "uploadWithResponse(BlobParallelUploadOptions options, Duration timeout, Context context)"
nameWithType: "BlobClient.uploadWithResponse(BlobParallelUploadOptions options, Duration timeout, Context context)"
summary: "Creates a new blob, or updates the content of an existing blob."
parameters:
- description: ""
name: "options"
type: ""
- description: "An optional timeout value beyond which a will be raised."
name: "timeout"
type: "Duration"
- description: "Additional context that is passed through the Http pipeline during the service call."
name: "context"
type: ""
syntax: "public Response uploadWithResponse(BlobParallelUploadOptions options, Duration timeout, Context context)"
desc: "Creates a new blob, or updates the content of an existing blob.\n\nTo avoid overwriting, pass \"\\*\" to ."
returns:
description: "Information about the uploaded block blob."
type: "<>"
- uid: "com.azure.storage.blob.BlobClient.uploadWithResponse(java.io.InputStream,long,com.azure.storage.blob.models.ParallelTransferOptions,com.azure.storage.blob.models.BlobHttpHeaders,java.util.Map,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.BlobClient.uploadWithResponse(InputStream data, long length, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout, Context context)"
name: "uploadWithResponse(InputStream data, long length, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout, Context context)"
nameWithType: "BlobClient.uploadWithResponse(InputStream data, long length, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout, Context context)"
summary: "Creates a new blob, or updates the content of an existing blob."
deprecatedTag: "See instead"
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 opening a and\n writing to the returned stream. Alternatively, consider wrapping your data source in a\n BufferedInputStream to add mark support."
name: "data"
type: "InputStream"
- description: "The exact length of the data. It is important that this value match precisely the length of the\n data provided in the ."
name: "length"
type: ""
- description: " used to configure buffered uploading."
name: "parallelTransferOptions"
type: ""
- description: ""
name: "headers"
type: ""
- 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: "Map<String,String>"
- description: " for the destination blob."
name: "tier"
type: ""
- description: ""
name: "requestConditions"
type: ""
- description: "An optional timeout value beyond which a will be raised."
name: "timeout"
type: "Duration"
- description: "Additional context that is passed through the Http pipeline during the service call."
name: "context"
type: ""
syntax: "@Deprecatedpublic void uploadWithResponse(InputStream data, long length, ParallelTransferOptions parallelTransferOptions, BlobHttpHeaders headers, Map metadata, AccessTier tier, BlobRequestConditions requestConditions, Duration timeout, Context context)"
desc: "Creates a new blob, or updates the content of an existing blob.\n\nTo avoid overwriting, pass \"\\*\" to ."
hasDeprecatedTag: true
type: "class"
desc: "This class provides a client that contains generic blob operations for Azure Storage Blobs. Operations allowed by the client are uploading and downloading, copying a blob, retrieving and setting metadata, retrieving and setting HTTP headers, and deleting and un-deleting a blob.\n\nThis client is instantiated through or retrieved via .\n\nFor operations on a specific blob type (i.e append, block, or page) use , , or to construct a client that allows blob specific operations.\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"
artifact: com.azure:azure-storage-blob:12.28.1