org.apache.beam.sdk.io.gcp.pubsublite

Class SubscriberOptions

java.lang.Object

org.apache.beam.sdk.io.gcp.pubsublite.SubscriberOptions

All Implemented Interfaces:

java.io.Serializable

public abstract class SubscriberOptions
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SubscriberOptions.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static com.google.cloud.pubsublite.cloudpubsub.FlowControlSettings	DEFAULT_FLOW_CONTROL

Constructor Summary

Constructors

Constructor and Description
SubscriberOptions()

Method Summary

Modifier and Type	Method and Description
abstract com.google.cloud.pubsublite.cloudpubsub.FlowControlSettings	flowControlSettings() Per-partition flow control parameters for this subscription.
abstract Duration	minBundleTimeout() The minimum wall time to pass before allowing bundle closure.
static SubscriberOptions.Builder	newBuilder()
abstract java.util.Set<com.google.cloud.pubsublite.Partition>	partitions() A set of partitions.
abstract com.google.cloud.pubsublite.SubscriptionPath	subscriptionPath()
abstract SubscriberOptions.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FLOW_CONTROL

public static final com.google.cloud.pubsublite.cloudpubsub.FlowControlSettings DEFAULT_FLOW_CONTROL

Constructor Detail

SubscriberOptions

public SubscriberOptions()

Method Detail

subscriptionPath

public abstract com.google.cloud.pubsublite.SubscriptionPath subscriptionPath()

flowControlSettings

public abstract com.google.cloud.pubsublite.cloudpubsub.FlowControlSettings flowControlSettings()

Per-partition flow control parameters for this subscription.

partitions

public abstract java.util.Set<com.google.cloud.pubsublite.Partition> partitions()

A set of partitions. If empty, continuously poll the set of partitions using an admin client.

minBundleTimeout

public abstract Duration minBundleTimeout()

The minimum wall time to pass before allowing bundle closure.

Setting this to too small of a value will result in increased compute costs and lower throughput per byte. Immediate timeouts (Duration.ZERO) may be useful for testing.

newBuilder

public static SubscriberOptions.Builder newBuilder()

toBuilder

public abstract SubscriberOptions.Builder toBuilder()