Class NexusClientOptions

java.lang.Object

io.temporal.client.NexusClientOptions

@Experimental
public class NexusClientOptions
extends Object

Options that configure a NexusClient (and the service-bound clients it produces).

Carries only client-wide settings (namespace, data converter, interceptors). Per-call settings — operation ID, timeouts, search attributes, summary, id-reuse/conflict policies — belong on StartNexusOperationOptions.

Obtain a builder via newBuilder() or copy an existing instance via newBuilder(NexusClientOptions). The default instance (getDefaultInstance()) targets the "default" namespace and uses the GlobalDataConverter.

 NexusClientOptions options =
     NexusClientOptions.newBuilder()
         .setNamespace("default")
         .setDataConverter(myDataConverter)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NexusClientOptions.Builder	Builder for NexusClientOptions.

Method Summary

Modifier and Type	Method	Description
DataConverter	getDataConverter()	Get the data converter used to serialize Nexus operation inputs and deserialize results.
static NexusClientOptions	getDefaultInstance()	Returns an options instance with all defaults.
ExternalStorage	getExternalStorage()	Get the external storage used to offload large operation payloads, or null if payloads are sent inline.
String	getIdentity()	Human-readable identity of this client.
List<NexusClientInterceptor>	getInterceptors()	Get the interceptors of this client.
String	getNamespace()	Get the namespace this client will operate on.
static NexusClientOptions.Builder	newBuilder()	Returns a fresh builder.
static NexusClientOptions.Builder	newBuilder(NexusClientOptions options)	Returns a builder seeded with the values from options.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

getNamespace

public String getNamespace()

Get the namespace this client will operate on.

getInterceptors

public List<NexusClientInterceptor> getInterceptors()

Get the interceptors of this client.

getDataConverter

public DataConverter getDataConverter()

Get the data converter used to serialize Nexus operation inputs and deserialize results.

getExternalStorage

@Nullable
public ExternalStorage getExternalStorage()

Get the external storage used to offload large operation payloads, or null if payloads are sent inline.

getIdentity

public String getIdentity()

Human-readable identity of this client. Stamped onto outgoing write requests (start, cancel, terminate) so server-side history and audit trails can attribute the action to a caller.

newBuilder

public static NexusClientOptions.Builder newBuilder()

Returns a fresh builder.

newBuilder

public static NexusClientOptions.Builder newBuilder(NexusClientOptions options)

Returns a builder seeded with the values from options.

getDefaultInstance

public static NexusClientOptions getDefaultInstance()

Returns an options instance with all defaults. The namespace defaults to "default"; set it explicitly via NexusClientOptions.Builder.setNamespace(String) to target a different namespace.