220 строки
21 KiB
YAML
220 строки
21 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.common.ParallelTransferOptions"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions"
|
|
name: "ParallelTransferOptions"
|
|
nameWithType: "ParallelTransferOptions"
|
|
summary: "This class contains configuration used to parallelize data transfer operations."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **ParallelTransferOptions**"
|
|
constructors:
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.ParallelTransferOptions()"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.ParallelTransferOptions()"
|
|
name: "ParallelTransferOptions()"
|
|
nameWithType: "ParallelTransferOptions.ParallelTransferOptions()"
|
|
summary: "Creates a new <xref uid=\"com.azure.storage.common.ParallelTransferOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ParallelTransferOptions\"></xref> with default parameters applied."
|
|
syntax: "public ParallelTransferOptions()"
|
|
desc: "Creates a new <xref uid=\"com.azure.storage.common.ParallelTransferOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ParallelTransferOptions\"></xref> with default parameters applied."
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.ParallelTransferOptions(java.lang.Integer,java.lang.Integer,com.azure.storage.common.ProgressReceiver,java.lang.Integer)"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.ParallelTransferOptions(Integer blockSize, Integer maxConcurrency, ProgressReceiver progressReceiver, Integer maxSingleUploadSize)"
|
|
name: "ParallelTransferOptions(Integer blockSize, Integer maxConcurrency, ProgressReceiver progressReceiver, Integer maxSingleUploadSize)"
|
|
nameWithType: "ParallelTransferOptions.ParallelTransferOptions(Integer blockSize, Integer maxConcurrency, ProgressReceiver progressReceiver, Integer maxSingleUploadSize)"
|
|
summary: "Creates a new <xref uid=\"com.azure.storage.common.ParallelTransferOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ParallelTransferOptions\"></xref> with default parameters applied."
|
|
deprecatedTag: "Use fluent interface to set properties instead."
|
|
parameters:
|
|
- description: "The block size.\n For upload, The block size is the size of each block that will be staged. This value also determines the number\n of requests that need to be made. This parameter also determines the size that each buffer uses when buffering\n is required and consequently amount of memory consumed by such methods may be up to blockSize * numBuffers.\n For download to file, the block size is the size of each data chunk returned from the service.\n For both applications, If block size is large, upload will make fewer network calls, but each\n individual call will send more data and will therefore take longer."
|
|
name: "blockSize"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- description: "The maximum number of parallel requests that will be issued at any given time as a part of\n a single parallel transfer. This value applies per api. For example, if two calls to uploadFromFile are made at\n the same time, and each specifies a maxConcurrency of 5, there may be up to 10 outstanding, concurrent requests,\n up to 5 for each of the upload operations. For buffered uploads only, the maximum number of buffers to be\n allocated as part of the transfer will be <code>maxConcurrency + 1</code>. In those cases, memory will be allocated\n lazily as needed. The amount of memory consumed by methods which buffer may be up to blockSize * maxConcurrency.\n In general, upload methods which do not accept a length parameter must perform some buffering."
|
|
name: "maxConcurrency"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- description: "<xref uid=\"com.azure.storage.common.ProgressReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProgressReceiver\"></xref>"
|
|
name: "progressReceiver"
|
|
type: "<xref href=\"com.azure.storage.common.ProgressReceiver?alt=com.azure.storage.common.ProgressReceiver&text=ProgressReceiver\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "If the size of the data is less than or equal to this value, it will be uploaded in a\n single put rather than broken up into chunks. If the data is uploaded in a single shot, the block size will be\n ignored. Some constraints to consider are that more requests cost more, but several small or mid-sized requests\n may sometimes perform better. In the case of buffered upload, up to this amount of data may be buffered before\n any data is sent. Must be greater than 0. May be null to accept default behavior, which is the maximum value the\n service accepts for uploading in a single requests, which varies depending on the service."
|
|
name: "maxSingleUploadSize"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ParallelTransferOptions(Integer blockSize, Integer maxConcurrency, ProgressReceiver progressReceiver, Integer maxSingleUploadSize)"
|
|
desc: "Creates a new <xref uid=\"com.azure.storage.common.ParallelTransferOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ParallelTransferOptions\"></xref> with default parameters applied."
|
|
hasDeprecatedTag: true
|
|
methods:
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.getBlockSize()"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.getBlockSize()"
|
|
name: "getBlockSize()"
|
|
nameWithType: "ParallelTransferOptions.getBlockSize()"
|
|
summary: "Gets the block size (chunk size) to transfer at a time."
|
|
deprecatedTag: "Use <xref uid=\"com.azure.storage.common.ParallelTransferOptions.getBlockSizeLong()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getBlockSizeLong()\"></xref>."
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public Integer getBlockSize()"
|
|
desc: "Gets the block size (chunk size) to transfer at a time."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The block size."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.getBlockSizeLong()"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.getBlockSizeLong()"
|
|
name: "getBlockSizeLong()"
|
|
nameWithType: "ParallelTransferOptions.getBlockSizeLong()"
|
|
summary: "Gets the block size (chunk size) to transfer at a time."
|
|
syntax: "public Long getBlockSizeLong()"
|
|
desc: "Gets the block size (chunk size) to transfer at a time."
|
|
returns:
|
|
description: "The block size."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.getMaxConcurrency()"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.getMaxConcurrency()"
|
|
name: "getMaxConcurrency()"
|
|
nameWithType: "ParallelTransferOptions.getMaxConcurrency()"
|
|
summary: "Gets the maximum number of parallel requests that will be issued at any given time."
|
|
syntax: "public Integer getMaxConcurrency()"
|
|
desc: "Gets the maximum number of parallel requests that will be issued at any given time."
|
|
returns:
|
|
description: "The max concurrency value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.getMaxSingleUploadSize()"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.getMaxSingleUploadSize()"
|
|
name: "getMaxSingleUploadSize()"
|
|
nameWithType: "ParallelTransferOptions.getMaxSingleUploadSize()"
|
|
summary: "Gets the value above which the upload will be broken into blocks and parallelized."
|
|
deprecatedTag: "Use <xref uid=\"com.azure.storage.common.ParallelTransferOptions.getMaxSingleUploadSizeLong()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getMaxSingleUploadSizeLong()\"></xref>."
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public Integer getMaxSingleUploadSize()"
|
|
desc: "Gets the value above which the upload will be broken into blocks and parallelized."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The threshold value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.getMaxSingleUploadSizeLong()"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.getMaxSingleUploadSizeLong()"
|
|
name: "getMaxSingleUploadSizeLong()"
|
|
nameWithType: "ParallelTransferOptions.getMaxSingleUploadSizeLong()"
|
|
summary: "Gets the value above which the upload will be broken into blocks and parallelized."
|
|
syntax: "public Long getMaxSingleUploadSizeLong()"
|
|
desc: "Gets the value above which the upload will be broken into blocks and parallelized."
|
|
returns:
|
|
description: "The threshold value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.getNumBuffers()"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.getNumBuffers()"
|
|
name: "getNumBuffers()"
|
|
nameWithType: "ParallelTransferOptions.getNumBuffers()"
|
|
summary: "Gets the number of buffers being used for a transfer operation."
|
|
deprecatedTag: "Use <xref uid=\"com.azure.storage.common.ParallelTransferOptions.getMaxConcurrency()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getMaxConcurrency()\"></xref>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public Integer getNumBuffers()"
|
|
desc: "Gets the number of buffers being used for a transfer operation."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The number of buffers."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.getProgressListener()"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.getProgressListener()"
|
|
name: "getProgressListener()"
|
|
nameWithType: "ParallelTransferOptions.getProgressListener()"
|
|
summary: "Gets the Progress listener for parallel reporting"
|
|
syntax: "public ProgressListener getProgressListener()"
|
|
desc: "Gets the Progress listener for parallel reporting"
|
|
returns:
|
|
description: "The progress listener"
|
|
type: "<xref href=\"com.azure.core.util.ProgressListener?alt=com.azure.core.util.ProgressListener&text=ProgressListener\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.getProgressReceiver()"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.getProgressReceiver()"
|
|
name: "getProgressReceiver()"
|
|
nameWithType: "ParallelTransferOptions.getProgressReceiver()"
|
|
summary: "Gets the Progress receiver for parallel reporting"
|
|
deprecatedTag: "Use <xref uid=\"com.azure.storage.common.ParallelTransferOptions.getProgressListener()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getProgressListener()\"></xref>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ProgressReceiver getProgressReceiver()"
|
|
desc: "Gets the Progress receiver for parallel reporting"
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The progress reporter"
|
|
type: "<xref href=\"com.azure.storage.common.ProgressReceiver?alt=com.azure.storage.common.ProgressReceiver&text=ProgressReceiver\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.setBlockSizeLong(java.lang.Long)"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.setBlockSizeLong(Long blockSize)"
|
|
name: "setBlockSizeLong(Long blockSize)"
|
|
nameWithType: "ParallelTransferOptions.setBlockSizeLong(Long blockSize)"
|
|
summary: "Sets the block size."
|
|
parameters:
|
|
- description: "The block size."
|
|
name: "blockSize"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
syntax: "public ParallelTransferOptions setBlockSizeLong(Long blockSize)"
|
|
desc: "Sets the block size. For upload, The block size is the size of each block that will be staged. This value also determines the number of requests that need to be made. This parameter also determines the size that each buffer uses when buffering is required and consequently amount of memory consumed by such methods may be up to blockSize \\* numBuffers. For download to file, the block size is the size of each data chunk returned from the service. For both applications, If block size is large, upload will make fewer network calls, but each individual call will send more data and will therefore take longer."
|
|
returns:
|
|
description: "The ParallelTransferOptions object itself."
|
|
type: "<xref href=\"com.azure.storage.common.ParallelTransferOptions?alt=com.azure.storage.common.ParallelTransferOptions&text=ParallelTransferOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.setMaxConcurrency(java.lang.Integer)"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.setMaxConcurrency(Integer maxConcurrency)"
|
|
name: "setMaxConcurrency(Integer maxConcurrency)"
|
|
nameWithType: "ParallelTransferOptions.setMaxConcurrency(Integer maxConcurrency)"
|
|
summary: "Sets the maximum number of parallel requests that will be issued at any given time."
|
|
parameters:
|
|
- description: "The maximum number of parallel requests that will be issued at any given time as a part of\n a single parallel transfer. This value applies per api. For example, if two calls to uploadFromFile are made at\n the same time, and each specifies a maxConcurrency of 5, there may be up to 10 outstanding, concurrent requests,\n up to 5 for each of the upload operations. For buffered uploads only, the maximum number of buffers to be\n allocated as part of the transfer will be <code>maxConcurrency + 1</code>. In those cases, memory will be allocated\n lazily as needed. The amount of memory consumed by methods which buffer may be up to blockSize * maxConcurrency.\n In general, upload methods which do not accept a length parameter must perform some buffering."
|
|
name: "maxConcurrency"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ParallelTransferOptions setMaxConcurrency(Integer maxConcurrency)"
|
|
desc: "Sets the maximum number of parallel requests that will be issued at any given time."
|
|
returns:
|
|
description: "The ParallelTransferOptions object itself."
|
|
type: "<xref href=\"com.azure.storage.common.ParallelTransferOptions?alt=com.azure.storage.common.ParallelTransferOptions&text=ParallelTransferOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.setMaxSingleUploadSizeLong(java.lang.Long)"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.setMaxSingleUploadSizeLong(Long maxSingleUploadSize)"
|
|
name: "setMaxSingleUploadSizeLong(Long maxSingleUploadSize)"
|
|
nameWithType: "ParallelTransferOptions.setMaxSingleUploadSizeLong(Long maxSingleUploadSize)"
|
|
summary: "If the size of the data is less than or equal to this value, it will be uploaded in a single put rather than broken up into chunks."
|
|
parameters:
|
|
- description: "The threshold value."
|
|
name: "maxSingleUploadSize"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
syntax: "public ParallelTransferOptions setMaxSingleUploadSizeLong(Long maxSingleUploadSize)"
|
|
desc: "If the size of the data is less than or equal to this value, it will be uploaded in a single put rather than broken up into chunks. If the data is uploaded in a single shot, the block size will be ignored. Some constraints to consider are that more requests cost more, but several small or mid-sized requests may sometimes perform better. In the case of buffered upload, up to this amount of data may be buffered before any data is sent. Must be greater than 0. May be null to accept default behavior, which is the maximum value the service accepts for uploading in a single requests, which varies depending on the service."
|
|
returns:
|
|
description: "The ParallelTransferOptions object itself."
|
|
type: "<xref href=\"com.azure.storage.common.ParallelTransferOptions?alt=com.azure.storage.common.ParallelTransferOptions&text=ParallelTransferOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.setProgressListener(com.azure.core.util.ProgressListener)"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.setProgressListener(ProgressListener progressListener)"
|
|
name: "setProgressListener(ProgressListener progressListener)"
|
|
nameWithType: "ParallelTransferOptions.setProgressListener(ProgressListener progressListener)"
|
|
summary: "Sets the <xref uid=\"com.azure.storage.common.ProgressReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProgressReceiver\"></xref>."
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.core.util.ProgressListener\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProgressListener\"></xref>."
|
|
name: "progressListener"
|
|
type: "<xref href=\"com.azure.core.util.ProgressListener?alt=com.azure.core.util.ProgressListener&text=ProgressListener\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ParallelTransferOptions setProgressListener(ProgressListener progressListener)"
|
|
desc: "Sets the <xref uid=\"com.azure.storage.common.ProgressReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProgressReceiver\"></xref>."
|
|
returns:
|
|
description: "The ParallelTransferOptions object itself."
|
|
type: "<xref href=\"com.azure.storage.common.ParallelTransferOptions?alt=com.azure.storage.common.ParallelTransferOptions&text=ParallelTransferOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.ParallelTransferOptions.setProgressReceiver(com.azure.storage.common.ProgressReceiver)"
|
|
fullName: "com.azure.storage.common.ParallelTransferOptions.setProgressReceiver(ProgressReceiver progressReceiver)"
|
|
name: "setProgressReceiver(ProgressReceiver progressReceiver)"
|
|
nameWithType: "ParallelTransferOptions.setProgressReceiver(ProgressReceiver progressReceiver)"
|
|
summary: "Sets the <xref uid=\"com.azure.storage.common.ProgressReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProgressReceiver\"></xref>."
|
|
deprecatedTag: "Use <xref uid=\"com.azure.storage.common.ParallelTransferOptions.setProgressListener(com.azure.core.util.ProgressListener)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#setProgressListener(ProgressListener)\"></xref>"
|
|
parameters:
|
|
- description: "The <xref uid=\"com.azure.storage.common.ProgressReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProgressReceiver\"></xref>."
|
|
name: "progressReceiver"
|
|
type: "<xref href=\"com.azure.storage.common.ProgressReceiver?alt=com.azure.storage.common.ProgressReceiver&text=ProgressReceiver\" 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 ParallelTransferOptions setProgressReceiver(ProgressReceiver progressReceiver)"
|
|
desc: "Sets the <xref uid=\"com.azure.storage.common.ProgressReceiver\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProgressReceiver\"></xref>."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The ParallelTransferOptions object itself."
|
|
type: "<xref href=\"com.azure.storage.common.ParallelTransferOptions?alt=com.azure.storage.common.ParallelTransferOptions&text=ParallelTransferOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "This class contains configuration used to parallelize data transfer operations. Note that not all values are used by every method which accepts this type. Please refer to the javadoc on specific methods for these cases."
|
|
metadata: {}
|
|
package: "com.azure.storage.common"
|
|
artifact: com.azure:azure-storage-common:12.26.1
|