Package com.google.cloud.firestore

Class BulkWriterOptions

java.lang.Object

com.google.cloud.firestore.BulkWriterOptions

public abstract class BulkWriterOptions
extends Object

Options used to configure request throttling in BulkWriter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BulkWriterOptions.Builder

Constructor Summary

Constructors

Constructor	Description
BulkWriterOptions()

Method Summary

Modifier and Type	Method	Description
static BulkWriterOptions.Builder	builder()
abstract ScheduledExecutorService	getExecutor()
abstract Double	getInitialOpsPerSecond()	Returns the initial maximum number of operations per second allowed by the throttler.
abstract Double	getMaxOpsPerSecond()	Returns the maximum number of operations per second allowed by the throttler.
abstract boolean	getThrottlingEnabled()	Return whether throttling is enabled.
abstract BulkWriterOptions.Builder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BulkWriterOptions

public BulkWriterOptions()

Method Details

getThrottlingEnabled

public abstract boolean getThrottlingEnabled()

Return whether throttling is enabled.

Returns:

Whether throttling is enabled.

getInitialOpsPerSecond

@Nullable
public abstract Double 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

@Nullable
public abstract Double 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

@Nullable
public abstract ScheduledExecutorService getExecutor()

Returns:

The ScheduledExecutorService that BulkWriter uses to schedule all operations. If null, the default executor will be used.

builder

public static BulkWriterOptions.Builder builder()

toBuilder

public abstract BulkWriterOptions.Builder toBuilder()