Package com.google.cloud.pubsub.v1

Class SubscriberShutdownSettings

java.lang.Object

com.google.cloud.pubsub.v1.SubscriberShutdownSettings

public final class SubscriberShutdownSettings
extends Object

Settings for configuring the shutdown behavior of a Subscriber.

This class allows customization of how the subscriber handles outstanding messages during shutdown, including whether to wait for processing to complete or to immediately nack messages, and an optional timeout for the shutdown process.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SubscriberShutdownSettings.Builder	Builder for SubscriberShutdownSettings.
static enum	SubscriberShutdownSettings.ShutdownMode	Defines the behavior for handling outstanding messages during subscriber shutdown.

Method Summary

Modifier and Type	Method	Description
SubscriberShutdownSettings.ShutdownMode	getMode()	Returns the configured shutdown mode.
Duration	getTimeout()	Returns the configured shutdown timeout.
static SubscriberShutdownSettings.Builder	newBuilder()	Returns a new builder for SubscriberShutdownSettings.

Methods inherited from class java.lang.Object

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

Method Details

getMode

public SubscriberShutdownSettings.ShutdownMode getMode()

Returns the configured shutdown mode.

getTimeout

public Duration getTimeout()

Returns the configured shutdown timeout. A negative duration indicates no timeout.

newBuilder

public static SubscriberShutdownSettings.Builder newBuilder()

Returns a new builder for SubscriberShutdownSettings.