88 строки
8.2 KiB
YAML
88 строки
8.2 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.common.ProgressReporter"
|
|
fullName: "com.azure.storage.common.ProgressReporter"
|
|
name: "ProgressReporter"
|
|
nameWithType: "ProgressReporter"
|
|
summary: "`ProgressReporter` offers a convenient way to add progress tracking to a given Flux."
|
|
deprecatedTag: "Use <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.core.util.ProgressReporter\"></xref>"
|
|
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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public final class **ProgressReporter**"
|
|
constructors:
|
|
- uid: "com.azure.storage.common.ProgressReporter.ProgressReporter()"
|
|
fullName: "com.azure.storage.common.ProgressReporter.ProgressReporter()"
|
|
name: "ProgressReporter()"
|
|
nameWithType: "ProgressReporter.ProgressReporter()"
|
|
summary: "Creates a new instance of <xref uid=\"com.azure.storage.common.ProgressReporter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProgressReporter\"></xref>."
|
|
syntax: "public ProgressReporter()"
|
|
desc: "Creates a new instance of <xref uid=\"com.azure.storage.common.ProgressReporter\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ProgressReporter\"></xref>."
|
|
methods:
|
|
- uid: "com.azure.storage.common.ProgressReporter.addParallelProgressReporting(reactor.core.publisher.Flux<java.nio.ByteBuffer>,com.azure.storage.common.ProgressReceiver,java.util.concurrent.locks.Lock,java.util.concurrent.atomic.AtomicLong)"
|
|
fullName: "com.azure.storage.common.ProgressReporter.addParallelProgressReporting(Flux<ByteBuffer> data, ProgressReceiver progressReceiver, Lock lock, AtomicLong totalProgress)"
|
|
name: "addParallelProgressReporting(Flux<ByteBuffer> data, ProgressReceiver progressReceiver, Lock lock, AtomicLong totalProgress)"
|
|
nameWithType: "ProgressReporter.addParallelProgressReporting(Flux<ByteBuffer> data, ProgressReceiver progressReceiver, Lock lock, AtomicLong totalProgress)"
|
|
summary: "Adds parallel progress reporting functionality to the given `Flux`."
|
|
deprecatedTag: "Use <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.core.util.ProgressReporter\"></xref>"
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The data whose transfer progress is to be tracked."
|
|
name: "data"
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Flux.html\">Flux</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html\">ByteBuffer</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: "This lock will be instantiated by the operation initiating the whole transfer to coordinate each\n ProgressReporterImpl."
|
|
name: "lock"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/locks/Lock.html\">Lock</a>"
|
|
- description: "We need an AtomicLong to be able to update the value referenced. Because we are already\n synchronizing with the lock, we don't incur any additional performance hit here by the synchronization."
|
|
name: "totalProgress"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/atomic/AtomicLong.html\">AtomicLong</a>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public static Flux<ByteBuffer> addParallelProgressReporting(Flux<ByteBuffer> data, ProgressReceiver progressReceiver, Lock lock, AtomicLong totalProgress)"
|
|
desc: "Adds parallel progress reporting functionality to the given `Flux`. Each subscription (and therefore each retry) will rewind the progress reported so as not to over-report. The data reported will be the total amount of data emitted so far, or the \"current position\" of the Flux in parallel."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "A <code>Flux</code> that emits the same data as the source but calls a callback to report the total amount of\n data emitted so far."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Flux.html\">Flux</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html\">ByteBuffer</a>>"
|
|
- uid: "com.azure.storage.common.ProgressReporter.addProgressReporting(reactor.core.publisher.Flux<java.nio.ByteBuffer>,com.azure.storage.common.ProgressReceiver)"
|
|
fullName: "com.azure.storage.common.ProgressReporter.addProgressReporting(Flux<ByteBuffer> data, ProgressReceiver progressReceiver)"
|
|
name: "addProgressReporting(Flux<ByteBuffer> data, ProgressReceiver progressReceiver)"
|
|
nameWithType: "ProgressReporter.addProgressReporting(Flux<ByteBuffer> data, ProgressReceiver progressReceiver)"
|
|
summary: "Adds progress reporting functionality to the given `Flux`."
|
|
deprecatedTag: "Use <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"com.azure.core.util.ProgressReporter\"></xref>"
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "The data whose transfer progress is to be tracked."
|
|
name: "data"
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Flux.html\">Flux</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html\">ByteBuffer</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\" />"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public static Flux<ByteBuffer> addProgressReporting(Flux<ByteBuffer> data, ProgressReceiver progressReceiver)"
|
|
desc: "Adds progress reporting functionality to the given `Flux`. Each subscription (and therefore each retry) will rewind the progress reported so as not to over-report. The data reported will be the total amount of data emitted so far, or the \"current position\" of the Flux."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "A <code>Flux</code> that emits the same data as the source but calls a callback to report the total amount of\n data emitted so far."
|
|
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Flux.html\">Flux</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html\">ByteBuffer</a>>"
|
|
type: "class"
|
|
desc: "`ProgressReporter` offers a convenient way to add progress tracking to a given Flux."
|
|
hasDeprecatedTag: true
|
|
metadata: {}
|
|
package: "com.azure.storage.common"
|
|
artifact: com.azure:azure-storage-common:12.26.1
|