SubscriptionOptions (NATS.IO Java Streaming API)

java.lang.Object
- io.nats.streaming.SubscriptionOptions

```
public class SubscriptionOptions
extends java.lang.Object
```
A SubscriptionOptions object defines the configurable parameters of a STAN Subscription object.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SubscriptionOptions.Builder
A Builder implementation for creating an immutable SubscriptionOptions object.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SubscriptionOptions.Builder` A Builder implementation for creating an immutable `SubscriptionOptions` object.

Field Summary

Fields
Modifier and Type	Field and Description
`static java.time.Duration`	`DEFAULT_ACK_WAIT` Default ack wait time for a subscriptions.
`static int`	`DEFAULT_MAX_IN_FLIGHT` Default max messages in flight for a subscriptions.
`static java.time.Duration`	`DEFAULT_SUBSCRIPTION_TIMEOUT` Default time a connection will wait to create a subscription.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`java.time.Duration`	`getAckWait()` Returns the timeout for waiting for an ACK from the cluster's point of view for delivered messages.
`java.lang.String`	`getDurableName()` Returns the name of the durable subscriber.
`int`	`getMaxInFlight()` Returns the maximum number of messages the cluster will send without an ACK.
`io.nats.streaming.protobuf.StartPosition`	`getStartAt()` Returns the desired start position for the message stream.
`long`	`getStartSequence()` Returns the desired start sequence position.
`java.time.Instant`	`getStartTime()` Returns the desired start time position.
`long`	`getStartTime(java.util.concurrent.TimeUnit unit)` Returns the desired start time position in the requested units.
`java.time.Duration`	`getSubscriptionTimeout()`
`int`	`hashCode()`
`boolean`	`isManualAcks()` Returns whether or not messages for this subscription must be acknowledged individually by calling `Message.ack()`.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_ACK_WAIT
```
public static final java.time.Duration DEFAULT_ACK_WAIT
```
    Default ack wait time for a subscriptions.
  - DEFAULT_MAX_IN_FLIGHT
```
public static final int DEFAULT_MAX_IN_FLIGHT
```
    Default max messages in flight for a subscriptions.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_SUBSCRIPTION_TIMEOUT
```
public static final java.time.Duration DEFAULT_SUBSCRIPTION_TIMEOUT
```
    Default time a connection will wait to create a subscription.
- Method Detail
  - getSubscriptionTimeout
```
public java.time.Duration getSubscriptionTimeout()
```
    Returns:
    
    the time to wait when creating a subscription if there is a network problem
  - getDurableName
```
public java.lang.String getDurableName()
```
    Returns the name of the durable subscriber.
    
    Returns:
    
    the name of the durable subscriber
  - getMaxInFlight
```
public int getMaxInFlight()
```
    Returns the maximum number of messages the cluster will send without an ACK.
    
    Returns:
    
    the maximum number of messages the cluster will send without an ACK
  - getAckWait
```
public java.time.Duration getAckWait()
```
    Returns the timeout for waiting for an ACK from the cluster's point of view for delivered messages.
    
    Returns:
    
    the timeout for waiting for an ACK from the cluster's point of view for delivered messages
  - getStartAt
```
public io.nats.streaming.protobuf.StartPosition getStartAt()
```
    Returns the desired start position for the message stream.
    
    Returns:
    
    the desired start position for the message stream
  - getStartSequence
```
public long getStartSequence()
```
    Returns the desired start sequence position.
    
    Returns:
    
    the desired start sequence position
  - getStartTime
```
public java.time.Instant getStartTime()
```
    Returns the desired start time position.
    
    Returns:
    
    the desired start time position
  - getStartTime
```
public long getStartTime(java.util.concurrent.TimeUnit unit)
```
    Returns the desired start time position in the requested units.
    
    Parameters:
    
    unit - the unit of time
    
    Returns:
    
    the desired start time position
  - isManualAcks
```
public boolean isManualAcks()
```
    Returns whether or not messages for this subscription must be acknowledged individually by calling Message.ack().
    
    Returns:
    
    whether or not manual acks are required for this subscription.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class SubscriptionOptions

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_ACK_WAIT

DEFAULT_MAX_IN_FLIGHT

DEFAULT_SUBSCRIPTION_TIMEOUT

Method Detail

getSubscriptionTimeout

getDurableName

getMaxInFlight

getAckWait

getStartAt

getStartSequence

getStartTime

getStartTime

isManualAcks

toString

equals

hashCode