Skip to main content

tcld nexus command reference

The tcld nexus commands manage Nexus resources in Temporal Cloud.

Alias: nxs

endpoint​

The tcld nexus endpoint commands manage Nexus Endpoints in Temporal Cloud.

Alias: ep

allowed-namespace​

The tcld nexus endpoint allowed-namespace commands manage the allowed namespaces for a Nexus Endpoint.

Alias: an

add​

The tcld nexus endpoint allowed-namespace add command adds allowed namespaces to a Nexus Endpoint.

Alias: a

--name​

Endpoint name.

Alias: n

--namespace​

Namespace that is allowed to call this endpoint.

Alias: ns

--request-id​

The request-id to use for the asynchronous operation, if not set the server will assign one (optional).

Alias: r

--resource-version​

The resource-version (etag) to update from, if not set the cli will use the latest (optional).

Alias: v

list​

The tcld nexus endpoint allowed-namespace list command lists the allowed namespaces of a Nexus Endpoint.

Alias: l

--name​

Endpoint name.

Alias: n

remove​

The tcld nexus endpoint allowed-namespace remove command removes allowed namespaces from a Nexus Endpoint.

Alias: r

--name​

Endpoint name.

Alias: n

--namespace​

Namespace that is allowed to call this endpoint.

Alias: ns

--request-id​

The request-id to use for the asynchronous operation, if not set the server will assign one (optional).

Alias: r

--resource-version​

The resource-version (etag) to update from, if not set the cli will use the latest (optional).

Alias: v

set​

The tcld nexus endpoint allowed-namespace set command sets the allowed namespaces of a Nexus Endpoint.

Alias: s

--name​

Endpoint name.

Alias: n

--namespace​

Namespace that is allowed to call this endpoint.

Alias: ns

--request-id​

The request-id to use for the asynchronous operation, if not set the server will assign one (optional).

Alias: r

--resource-version​

The resource-version (etag) to update from, if not set the cli will use the latest (optional).

Alias: v

create​

The tcld nexus endpoint create command creates a new Nexus Endpoint on the Cloud Account. An endpoint name is used by in workflow code to invoke Nexus operations. The endpoint target is a worker and --target-namespace and --target-task-queue must both be provided. This will fail if an endpoint with the same name is already registered.

Alias: c

--allow-namespace​

Namespace that is allowed to call this endpoint (optional).

Alias: ans

--description​

Endpoint description in markdown format (optional).

Alias: d

--description-file​

Endpoint description file in markdown format (optional).

Alias: df

--name​

Endpoint name.

Alias: n

--request-id​

The request-id to use for the asynchronous operation, if not set the server will assign one (optional).

Alias: r

--target-namespace​

Namespace in which a handler worker will be polling for Nexus tasks on.

Alias: tns

--target-task-queue​

Task Queue in which a handler worker will be polling for Nexus tasks on.

Alias: ttq

delete​

The tcld nexus endpoint delete command deletes a Nexus Endpoint on the Cloud Account. .

Alias: d

--name​

Endpoint name.

Alias: n

--request-id​

The request-id to use for the asynchronous operation, if not set the server will assign one (optional).

Alias: r

--resource-version​

The resource-version (etag) to update from, if not set the cli will use the latest (optional).

Alias: v

get​

The tcld nexus endpoint get command gets a Nexus Endpoint configuration by name from the Cloud Account.

Alias: g

--name​

Endpoint name.

Alias: n

list​

The tcld nexus endpoint list command lists all Nexus Endpoint configurations on the Cloud Account.

Alias: l

update​

The tcld nexus endpoint update command updates an existing Nexus Endpoint on the Cloud Account. An endpoint name is used by in workflow code to invoke Nexus operations. The endpoint target is a worker and --target-namespace and --target-task-queue must both be provided.

The endpoint is patched leaving any existing fields for which flags are not provided as they were.

Alias: u

--description​

Endpoint description in markdown format (optional).

Alias: d

--description-file​

Endpoint description file in markdown format (optional).

Alias: df

--name​

Endpoint name.

Alias: n

--request-id​

The request-id to use for the asynchronous operation, if not set the server will assign one (optional).

Alias: r

--resource-version​

The resource-version (etag) to update from, if not set the cli will use the latest (optional).

Alias: v

--target-namespace​

Namespace in which a handler worker will be polling for Nexus tasks on (optional).

Alias: tns

--target-task-queue​

Task Queue in which a handler worker will be polling for Nexus tasks on (optional).

Alias: ttq

--unset-description​

Unset endpoint description.