Class FileParallelUploadOptions
- java.lang.Object
-
- com.azure.storage.file.datalake.options.FileParallelUploadOptions
-
public class FileParallelUploadOptions extends Object
Extended options that may be passed when uploading a file in parallel.
-
-
Constructor Summary
Constructors Constructor Description FileParallelUploadOptions(InputStream dataStream)
Constructs a newFileParallelUploadOptions
.FileParallelUploadOptions(InputStream dataStream, long length)
Deprecated.length is no longer necessary; useFileParallelUploadOptions(InputStream)
instead.FileParallelUploadOptions(Flux<ByteBuffer> dataFlux)
Constructs a newFileParallelUploadOptions
.
-
Method Summary
-
-
-
Constructor Detail
-
FileParallelUploadOptions
public FileParallelUploadOptions(Flux<ByteBuffer> dataFlux)
Constructs a newFileParallelUploadOptions
.- Parameters:
dataFlux
- The data to write to the file. Unlike other upload methods, this method does not require that theFlux
be replayable. In other words, it does not have to support multiple subscribers and is not expected to produce the same values across subscriptions.
-
FileParallelUploadOptions
@Deprecated public FileParallelUploadOptions(InputStream dataStream, long length)
Deprecated.length is no longer necessary; useFileParallelUploadOptions(InputStream)
instead.Constructs a newFileParallelUploadOptions
. UseFileParallelUploadOptions(InputStream)
instead to supply an InputStream without knowing the exact length beforehand.- Parameters:
dataStream
- The data to write to the blob. The data must be markable. This is in order to support retries. If the data is not markable, consider wrapping your data source in aBufferedInputStream
to add mark support.length
- The exact length of the data. It is important that this value match precisely the length of the data provided in theInputStream
.
-
FileParallelUploadOptions
public FileParallelUploadOptions(InputStream dataStream)
Constructs a newFileParallelUploadOptions
.- Parameters:
dataStream
- The data to write to the blob. The data must be markable. This is in order to support retries. If the data is not markable, consider wrapping your data source in aBufferedInputStream
to add mark support.
-
-
Method Detail
-
getDataFlux
public Flux<ByteBuffer> getDataFlux()
Gets the data source.- Returns:
- The data to write to the file.
-
getDataStream
public InputStream getDataStream()
Gets the data source.- Returns:
- The data to write to the file.
-
getLength
@Deprecated public long getLength()
Deprecated.usegetOptionalLength()
to have safe access to a length that will not always exist.Gets the length of the data.- Returns:
- The exact length of the data. It is important that this value match precisely the length of the
data provided in the
InputStream
.
-
getOptionalLength
public Long getOptionalLength()
Gets the length of the data.- Returns:
- The exact length of the data. It is important that this value match precisely the length of the
data provided in the
InputStream
.
-
getParallelTransferOptions
public com.azure.storage.common.ParallelTransferOptions getParallelTransferOptions()
Gets theParallelTransferOptions
.- Returns:
ParallelTransferOptions
-
setParallelTransferOptions
public FileParallelUploadOptions setParallelTransferOptions(com.azure.storage.common.ParallelTransferOptions parallelTransferOptions)
Sets theParallelTransferOptions
.- Parameters:
parallelTransferOptions
-ParallelTransferOptions
- Returns:
- The updated options.
-
getHeaders
public PathHttpHeaders getHeaders()
Gets thePathHttpHeaders
.- Returns:
PathHttpHeaders
-
setHeaders
public FileParallelUploadOptions setHeaders(PathHttpHeaders headers)
Sets thePathHttpHeaders
.- Parameters:
headers
-PathHttpHeaders
- Returns:
- The updated options
-
getMetadata
public Map<String,String> getMetadata()
Gets the metadata.- Returns:
- The metadata to associate with the file.
-
setMetadata
public FileParallelUploadOptions setMetadata(Map<String,String> metadata)
Sets the metadata.- Parameters:
metadata
- The metadata to associate with the blob.- Returns:
- The updated options.
-
getPermissions
public String getPermissions()
Gets the permissions.- Returns:
- the POSIX access permissions for the resource owner, the resource owning group, and others.
-
setPermissions
public FileParallelUploadOptions setPermissions(String permissions)
Sets the permissions.- Parameters:
permissions
- the POSIX access permissions for the resource owner, the resource owning group, and others.- Returns:
- The updated options
-
getUmask
public String getUmask()
Gets the umask.- Returns:
- the umask.
-
setUmask
public FileParallelUploadOptions setUmask(String umask)
Sets the umask.- Parameters:
umask
- Restricts permissions of the resource to be created.- Returns:
- The updated options
-
getRequestConditions
public DataLakeRequestConditions getRequestConditions()
Gets theDataLakeRequestConditions
.- Returns:
DataLakeRequestConditions
-
setRequestConditions
public FileParallelUploadOptions setRequestConditions(DataLakeRequestConditions requestConditions)
Sets theDataLakeRequestConditions
.- Parameters:
requestConditions
-DataLakeRequestConditions
- Returns:
- The updated options.
-
-