io.nats.client.api

Class Placement

java.lang.Object

io.nats.client.api.Placement

All Implemented Interfaces:

io.nats.client.support.JsonSerializable

public class Placement
extends java.lang.Object
implements io.nats.client.support.JsonSerializable

Placement directives to consider when placing replicas of a stream

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Placement.Builder Placement can be created using a Builder.

Constructor Summary

Constructors

Constructor and Description
Placement(java.lang.String cluster, java.util.List<java.lang.String> tags) Construct a placement object

Method Summary

Modifier and Type	Method and Description
static Placement.Builder	builder() Creates a builder for a placements object.
@Nullable java.lang.String	getCluster() The desired cluster name to place the stream.
@Nullable java.util.List<java.lang.String>	getTags() Tags required on servers hosting this stream
boolean	hasData() Whether the Placement has either a cluster or tags
@NonNull java.lang.String	toJson()
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.nats.client.support.JsonSerializable

serialize, toJsonValue

Constructor Detail

Placement

public Placement(java.lang.String cluster,
                 java.util.List<java.lang.String> tags)

Construct a placement object

Parameters:

cluster - the cluster name

tags - the list of tags, may be null

Method Detail

hasData

public boolean hasData()

Whether the Placement has either a cluster or tags

Returns:

true if the Placement has data

getCluster

public @Nullable java.lang.String getCluster()

The desired cluster name to place the stream.

Returns:

The cluster name

getTags

public @Nullable java.util.List<java.lang.String> getTags()

Tags required on servers hosting this stream

Returns:

the list of tags

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

toJson

public @NonNull java.lang.String toJson()

Specified by:

toJson in interface io.nats.client.support.JsonSerializable

builder

public static Placement.Builder builder()

Creates a builder for a placements object.

Returns:

the builder.