PublishOptions.Builder (NATS.IO Java API)

java.lang.Object
- io.nats.client.PublishOptions.Builder

Enclosing class:

PublishOptions
```
public static class PublishOptions.Builder
extends java.lang.Object
```
PublishOptions are created using a Builder. The builder supports chaining and will create a default set of options if no methods are calls. The builder can also be created from a properties object using the property names defined with the prefix PROP_ in this class.

Constructor Summary

Constructors
Constructor and Description
`Builder()` Constructs a new publish options Builder with the default values.
`Builder(java.util.Properties properties)` Constructs a builder from properties

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`PublishOptions`	`build()` Builds the publish options.
`PublishOptions.Builder`	`clearExpected()` Clears the expected so the build can be re-used.
`PublishOptions.Builder`	`expectedLastMsgId(java.lang.String lastMsgId)` Sets the expected last ID of the previously published message.
`PublishOptions.Builder`	`expectedLastSequence(long sequence)` Sets the expected message sequence of the publish
`PublishOptions.Builder`	`expectedLastSubjectSequence(long sequence)` Sets the expected subject message sequence of the publish
`PublishOptions.Builder`	`expectedLastSubjectSequenceSubject(java.lang.String expectedLastSubSeqSubject)` Sets the filter subject for the expected last subject sequence This can be used for a wildcard since it is used in place of the message subject along with expectedLastSubjectSequence
`PublishOptions.Builder`	`expectedStream(java.lang.String stream)` Sets the expected stream for the publish.
`PublishOptions.Builder`	`messageId(java.lang.String msgId)` Sets the message id.
`PublishOptions.Builder`	`messageTtl(MessageTtl messageTtl)` Sets the TTL for this specific message to be published
`PublishOptions.Builder`	`messageTtlCustom(java.lang.String msgTtlCustom)` Sets the TTL for this specific message to be published.
`PublishOptions.Builder`	`messageTtlNever()` Sets the TTL for this specific message to be published and never be expired
`PublishOptions.Builder`	`messageTtlSeconds(int msgTtlSeconds)` Sets the TTL for this specific message to be published.
`PublishOptions.Builder`	`stream(java.lang.String stream)` Deprecated. Not a very useful function Sets the stream name to expect the pub ack to have. This really should never be an issue and it does not prevent the message from being published, it's an exception after the fact
`PublishOptions.Builder`	`streamTimeout(java.time.Duration timeout)` Sets the timeout to wait for a publish acknowledgement from a JetStream enabled NATS server.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
    Constructs a new publish options Builder with the default values.
  - Builder
```
public Builder(java.util.Properties properties)
```
    Constructs a builder from properties
    
    Parameters:
    
    properties - properties
- Method Detail
  - stream
```
@Deprecated
public PublishOptions.Builder stream(java.lang.String stream)
```
    Deprecated. Not a very useful function Sets the stream name to expect the pub ack to have. This really should never be an issue and it does not prevent the message from being published, it's an exception after the fact
    
    Parameters:
    
    stream - The name of the stream.
    
    Returns:
    
    The Builder
  - streamTimeout
```
public PublishOptions.Builder streamTimeout(java.time.Duration timeout)
```
    Sets the timeout to wait for a publish acknowledgement from a JetStream enabled NATS server.
    
    Parameters:
    
    timeout - the publish timeout.
    
    Returns:
    
    The Builder
  - expectedStream
```
public PublishOptions.Builder expectedStream(java.lang.String stream)
```
    Sets the expected stream for the publish. If the stream does not match the server will not save the message.
    
    Parameters:
    
    stream - expected stream
    
    Returns:
    
    The Builder
  - expectedLastMsgId
```
public PublishOptions.Builder expectedLastMsgId(java.lang.String lastMsgId)
```
    Sets the expected last ID of the previously published message. If the message ID does not match the server will not save the message.
    
    Parameters:
    
    lastMsgId - the stream
    
    Returns:
    
    The Builder
  - expectedLastSequence
```
public PublishOptions.Builder expectedLastSequence(long sequence)
```
    Sets the expected message sequence of the publish
    
    Parameters:
    
    sequence - the expected last sequence number
    
    Returns:
    
    The Builder
  - expectedLastSubjectSequence
```
public PublishOptions.Builder expectedLastSubjectSequence(long sequence)
```
    Sets the expected subject message sequence of the publish
    
    Parameters:
    
    sequence - the expected last subject sequence number
    
    Returns:
    
    The Builder
  - expectedLastSubjectSequenceSubject
```
public PublishOptions.Builder expectedLastSubjectSequenceSubject(java.lang.String expectedLastSubSeqSubject)
```
    Sets the filter subject for the expected last subject sequence This can be used for a wildcard since it is used in place of the message subject along with expectedLastSubjectSequence
    
    Parameters:
    
    expectedLastSubSeqSubject - the filter subject
    
    Returns:
    
    The Builder
  - messageId
```
public PublishOptions.Builder messageId(java.lang.String msgId)
```
    Sets the message id. Message IDs are used for de-duplication and should be unique to each message payload.
    
    Parameters:
    
    msgId - the unique message id.
    
    Returns:
    
    The Builder
  - messageTtlSeconds
```
public PublishOptions.Builder messageTtlSeconds(int msgTtlSeconds)
```
    Sets the TTL for this specific message to be published. Less than 1 has the effect of clearing the message ttl
    
    Parameters:
    
    msgTtlSeconds - the ttl in seconds
    
    Returns:
    
    The Builder
  - messageTtlCustom
```
public PublishOptions.Builder messageTtlCustom(java.lang.String msgTtlCustom)
```
    Sets the TTL for this specific message to be published. Use at your own risk. The current specification can be found here @see JetStream Per-Message TTL Null or empty has the effect of clearing the message ttl
    
    Parameters:
    
    msgTtlCustom - the custom ttl string
    
    Returns:
    
    The Builder
  - messageTtlNever
```
public PublishOptions.Builder messageTtlNever()
```
    Sets the TTL for this specific message to be published and never be expired
    
    Returns:
    
    The Builder
  - messageTtl
```
public PublishOptions.Builder messageTtl(MessageTtl messageTtl)
```
    Sets the TTL for this specific message to be published
    
    Parameters:
    
    messageTtl - the message ttl instance
    
    Returns:
    
    The Builder
  - clearExpected
```
public PublishOptions.Builder clearExpected()
```
    Clears the expected so the build can be re-used. Clears the following fields:
    - expectedLastId
    - expectedLastSequence
    - expectedLastSubSeq
    - expectedLastSubSeqSubject
    - messageId
    Does not clear the following fields:
    - stream
    - expectedStream
    - streamTimeout
    - messageTtl
    Returns:
    
    The Builder
  - build
```
public PublishOptions build()
```
    Builds the publish options.
    
    Returns:
    
    publish options

Class PublishOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Builder

Method Detail

stream

streamTimeout

expectedStream

expectedLastMsgId

expectedLastSequence

expectedLastSubjectSequence

expectedLastSubjectSequenceSubject

messageId

messageTtlSeconds

messageTtlCustom

messageTtlNever

messageTtl

clearExpected

build