Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class SubscriberShutdownSettings (1.149.0)

public final class SubscriberShutdownSettings

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.

Inheritance

java.lang.Object > SubscriberShutdownSettings

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

newBuilder()

public static SubscriberShutdownSettings.Builder newBuilder()

Returns a new builder for SubscriberShutdownSettings.

Returns
Type	Description
`SubscriberShutdownSettings.Builder`

Methods

getMode()

public SubscriberShutdownSettings.ShutdownMode getMode()

Returns the configured shutdown mode.

Returns
Type	Description
`SubscriberShutdownSettings.ShutdownMode`

getTimeout()

public Duration getTimeout()

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

Returns
Type	Description
`Duration`