Package com.google.cloud.firestore
Class BulkWriterOptions
java.lang.Object
com.google.cloud.firestore.BulkWriterOptions
Options used to configure request throttling in BulkWriter.
-
Nested Class Summary
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic BulkWriterOptions.Builder
builder()
abstract ScheduledExecutorService
abstract Double
Returns the initial maximum number of operations per second allowed by the throttler.abstract Double
Returns the maximum number of operations per second allowed by the throttler.abstract boolean
Return whether throttling is enabled.abstract BulkWriterOptions.Builder
-
Constructor Details
-
BulkWriterOptions
public BulkWriterOptions()
-
-
Method Details
-
getThrottlingEnabled
public abstract boolean getThrottlingEnabled()Return whether throttling is enabled.- Returns:
- Whether throttling is enabled.
-
getInitialOpsPerSecond
Returns the initial maximum number of operations per second allowed by the throttler.- Returns:
- The initial maximum number of operations per second allowed by the throttler.
-
getMaxOpsPerSecond
Returns the maximum number of operations per second allowed by the throttler.The throttler's allowed operations per second does not ramp up past the specified operations per second.
- Returns:
- The maximum number of operations per second allowed by the throttler.
-
getExecutor
- Returns:
- The
ScheduledExecutorService
that BulkWriter uses to schedule all operations. If null, the default executor will be used.
-
builder
-
toBuilder
-