BatchPublishOptions.Builder (Synadia Communications Inc. Batch Publish)

java.lang.Object
- io.synadia.bp.BatchPublishOptions.Builder

Enclosing class:

BatchPublishOptions
```
public static class BatchPublishOptions.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.

Constructors
Constructor and Description
`Builder()` Constructs a new publish options Builder with the default values.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`BatchPublishOptions.Builder`	`ackEvery(int ackEvery)` The interval to ack when adding a message, after the first message.
`BatchPublishOptions.Builder`	`ackFirst(boolean ackFirst)` Whether to ack the first message.
`BatchPublishOptions.Builder`	`ackTimeout(java.time.Duration ackTimeout)` Sets the timeout to wait for the acknowledgement for acks when adding or the commit.
`BatchPublishOptions.Builder`	`ackTimeout(long ackTimeoutMillis)` Sets the timeout im milliseconds to wait for the acknowledgement for acks when adding or the commit.
`BatchPublishOptions`	`build()` Builds the publish options.
`BatchPublishOptions.Builder`	`clearExpected()` Clears the expected so the build can be re-used.
`BatchPublishOptions.Builder`	`expectedLastSequence(long sequence)` Sets the expected message sequence of the publish
`BatchPublishOptions.Builder`	`expectedLastSubjectSequence(long sequence)` Sets the expected subject message sequence of the publish
`BatchPublishOptions.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
`BatchPublishOptions.Builder`	`expectedStream(java.lang.String stream)` Sets the expected stream for the publish.
`BatchPublishOptions.Builder`	`messageTtl(io.nats.client.MessageTtl messageTtl)` Sets the TTL for this specific message to be published
`BatchPublishOptions.Builder`	`messageTtlCustom(java.lang.String msgTtlCustom)` Sets the TTL for this specific message to be published.
`BatchPublishOptions.Builder`	`messageTtlNever()` Sets the TTL for this specific message to be published and never be expired
`BatchPublishOptions.Builder`	`messageTtlSeconds(int msgTtlSeconds)` Sets the TTL for this specific message to be published.

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

- Constructor Detail
  - Builder
```
public Builder()
```
    Constructs a new publish options Builder with the default values.
- Method Detail
  - ackTimeout
```
public BatchPublishOptions.Builder ackTimeout(java.time.Duration ackTimeout)
```
    Sets the timeout to wait for the acknowledgement for acks when adding or the commit.
    
    Parameters:
    
    ackTimeout - the ack timeout.
    
    Returns:
    
    The Builder
  - ackTimeout
```
public BatchPublishOptions.Builder ackTimeout(long ackTimeoutMillis)
```
    Sets the timeout im milliseconds to wait for the acknowledgement for acks when adding or the commit.
    
    Parameters:
    
    ackTimeoutMillis - the ack timeout.
    
    Returns:
    
    The Builder
  - ackFirst
```
public BatchPublishOptions.Builder ackFirst(boolean ackFirst)
```
    Whether to ack the first message. Defaults to true
    
    Parameters:
    
    ackFirst - the flag
    
    Returns:
    
    The Builder
  - ackEvery
```
public BatchPublishOptions.Builder ackEvery(int ackEvery)
```
    The interval to ack when adding a message, after the first message. Defaults to 0 (never).
    
    Parameters:
    
    ackEvery - the ack every value
    
    Returns:
    
    The Builder
  - expectedStream
```
public BatchPublishOptions.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
  - expectedLastSequence
```
public BatchPublishOptions.Builder expectedLastSequence(long sequence)
```
    Sets the expected message sequence of the publish
    
    Parameters:
    
    sequence - the expected last sequence number
    
    Returns:
    
    The Builder
  - expectedLastSubjectSequence
```
public BatchPublishOptions.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 BatchPublishOptions.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
  - messageTtlSeconds
```
public BatchPublishOptions.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 BatchPublishOptions.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 BatchPublishOptions.Builder messageTtlNever()
```
    Sets the TTL for this specific message to be published and never be expired
    
    Returns:
    
    The Builder
  - messageTtl
```
public BatchPublishOptions.Builder messageTtl(io.nats.client.MessageTtl messageTtl)
```
    Sets the TTL for this specific message to be published
    
    Parameters:
    
    messageTtl - the message ttl instance
    
    Returns:
    
    The Builder
  - clearExpected
```
public BatchPublishOptions.Builder clearExpected()
```
    Clears the expected so the build can be re-used. Clears the following fields:
    - expectedLastSequence
    - expectedLastSubSeq
    - expectedLastSubSeqSubject
    Does not clear the following fields:
    - ackTimeout
    - ackFirst
    - ackEvery
    - expectedStream
    - messageTtl
    Returns:
    
    The Builder
  - build
```
public BatchPublishOptions build()
```
    Builds the publish options.
    
    Returns:
    
    publish options

Class BatchPublishOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

ackTimeout

ackTimeout

ackFirst

ackEvery

expectedStream

expectedLastSequence

expectedLastSubjectSequence

expectedLastSubjectSequenceSubject

messageTtlSeconds

messageTtlCustom

messageTtlNever

messageTtl

clearExpected

build