-
Notifications
You must be signed in to change notification settings - Fork 317
Documentation for Java Nexus Standalone operations #4681
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Evanthx
wants to merge
2
commits into
nexus-stand-alone-operations
Choose a base branch
from
nexus-sano-java-2
base: nexus-stand-alone-operations
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,168 @@ | ||
| --- | ||
| id: standalone-operations | ||
| title: Standalone Nexus Operations - Java SDK | ||
| sidebar_label: Standalone Operations | ||
| toc_max_heading_level: 4 | ||
| keywords: | ||
| - standalone nexus operation | ||
| - nexus operation execution | ||
| - execute nexus operation | ||
| - nexus operation handle | ||
| - list nexus operations | ||
| - count nexus operations | ||
| - java sdk | ||
| tags: | ||
| - Nexus | ||
| - Temporal Client | ||
| - Java SDK | ||
| - Temporal SDKs | ||
| description: Execute Nexus Operations independently without a Workflow using the Temporal Java SDK. | ||
| --- | ||
|
|
||
| :::tip SUPPORT, STABILITY, and DEPENDENCY INFO | ||
|
|
||
| Temporal Java SDK support for Standalone Nexus Operations is at | ||
| [Pre-release](/evaluate/development-production-features/release-stages#pre-release). | ||
|
|
||
| All APIs are experimental and may be subject to backwards-incompatible changes. | ||
|
|
||
| ::: | ||
|
|
||
| [Standalone Nexus Operations](/standalone-nexus-operation) let you run Nexus Operation Executions independently, without | ||
| being orchestrated by a Workflow. Instead of calling a Nexus Operation from within a Workflow Definition using | ||
| `Workflow.newNexusServiceStub()`, you execute a Standalone Nexus Operation directly from a Nexus service client created | ||
| from a `NexusClient` using `NexusClient.newNexusServiceClient()`. | ||
|
|
||
| Standalone Nexus Operations use the same Nexus Service contract, Operation handlers, and Worker setup as | ||
| Workflow-driven Operations — only the execution path differs. See the [Nexus feature guide](/develop/java/nexus/feature-guide) for details on | ||
| [defining a Service contract](/develop/java/nexus/feature-guide#define-nexus-service-contract), | ||
| [developing Operation handlers](/develop/java/nexus/feature-guide#develop-nexus-service-operation-handlers), and | ||
| [registering a Service in a Worker](/develop/java/nexus/feature-guide#register-a-nexus-service-in-a-worker). | ||
|
|
||
| This page focuses on the client-side APIs that are unique to Standalone Nexus Operations: | ||
|
|
||
| - [Execute a Standalone Nexus Operation](#execute-operation) | ||
| - [Start a Standalone Nexus Operation and Wait for the Result](#get-operation-result) | ||
| - [List Standalone Nexus Operations](#list-operations) | ||
| - [Count Standalone Nexus Operations](#count-operations) | ||
|
|
||
| :::note | ||
| This documentation uses source code from the | ||
| [Java Nexus Standalone sample](https://github.com/temporalio/samples-java/tree/main/core/src/main/java/io/temporal/samples/nexusstandalone). | ||
|
|
||
| ::: | ||
|
|
||
| ## Execute a Standalone Nexus Operation {/* #execute-operation */} | ||
|
|
||
| To execute a Standalone Nexus Operation, first create a | ||
| [`NexusClient`](https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/io/temporal/client/NexusClient.html), then | ||
| derive a typed | ||
| [`NexusServiceClient`](https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/io/temporal/client/NexusServiceClient.html) | ||
| from it with `newNexusServiceClient()`, bound to a specific Nexus Endpoint and Service. The endpoint must be | ||
| pre-created on the server. Then call `start()` or `execute()` from application code (for example, a starter program), | ||
| not from inside a Workflow Definition. | ||
|
|
||
| `execute()` waits for the Operation to complete and returns the result. | ||
| Both methods take a [`StartNexusOperationOptions`](https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/io/temporal/client/StartNexusOperationOptions.html) | ||
| whose `id` is required — the SDK never generates one for you. `scheduleToCloseTimeout` is optional and defaults to the | ||
| maximum allowed by the Temporal server. | ||
|
|
||
| ```java | ||
| NexusClient nexusClient = NexusClient.newInstance(stubs, options); | ||
| NexusServiceClient<GreetingNexusService> greetingClient = | ||
| nexusClient.newNexusServiceClient(GreetingNexusService.class, ENDPOINT_NAME); | ||
|
|
||
| // Block until the operation completes and return its result. | ||
| GreetingOutput greeting = | ||
| greetingClient.execute( | ||
| GreetingNexusService::greet, | ||
| StartNexusOperationOptions.newBuilder() | ||
| .setId("greet-" + UUID.randomUUID()) | ||
| .setScheduleToCloseTimeout(Duration.ofSeconds(10)) | ||
| .build(), | ||
| new GreetingInput("World")); | ||
| ``` | ||
|
|
||
| `executeAsync()` is the same but returns a `CompletableFuture` instead of blocking. | ||
|
|
||
| ```java | ||
| CompletableFuture<GreetingOutput> future = | ||
| greetingClient.executeAsync( | ||
| GreetingNexusService::greet, options, new GreetingInput("World")); | ||
| GreetingOutput greeting = future.get(); | ||
| ``` | ||
|
|
||
| See the full | ||
| [starter sample](https://github.com/temporalio/samples-java/blob/main/core/src/main/java/io/temporal/samples/nexusstandalone/StandaloneClientStarter.java) | ||
| for a complete example that executes both synchronous and asynchronous Operations, gets their results, and lists and | ||
| counts Operations. | ||
|
|
||
| ## Start a Standalone Nexus Operation and Wait for the Result {/* #get-operation-result */} | ||
|
|
||
| `start()` returns a | ||
| [`NexusOperationHandle`](https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/io/temporal/client/NexusOperationHandle.html). | ||
| Use `NexusOperationHandle.getResult()` to wait until the Operation completes and retrieve its result. This works for | ||
| both synchronous and asynchronous Operations. | ||
|
|
||
| ```java | ||
| // Start an operation and get a NexusOperationHandle. | ||
| NexusOperationHandle<GreetingOutput> handle = | ||
| greetingClient.start( | ||
| GreetingNexusService::startGreeting, options, new GreetingInput("World")); | ||
|
|
||
| // Block until the operation completes and retrieve its result. | ||
| GreetingOutput greeting = handle.getResult(); | ||
| ``` | ||
|
|
||
| If the Operation completed successfully, the result is returned. If the Operation failed, the failure is thrown as a | ||
| `NexusOperationException`. Use `getResultAsync()` for a non-blocking `CompletableFuture`, or | ||
| `getResult(long timeout, TimeUnit unit)` to bound the wait. | ||
|
|
||
| ## List Standalone Nexus Operations {/* #list-operations */} | ||
|
|
||
| Use [`NexusClient.listNexusOperationExecutions()`](https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/io/temporal/client/NexusClient.html) | ||
| to list Standalone Nexus Operation Executions that match a [List Filter](/list-filter) query. The result is a `Stream` | ||
| of operation metadata entries. | ||
|
|
||
| Note that `listNexusOperationExecutions()` is called on a `NexusClient`, not on the typed `NexusServiceClient`. | ||
|
|
||
| ```java | ||
| String query = "Endpoint = \"" + ENDPOINT_NAME + "\""; | ||
| nexusClient | ||
| .listNexusOperationExecutions(query) | ||
| .forEach( | ||
| op -> | ||
| System.out.printf( | ||
| "OperationId: %s, Operation: %s, Status: %s%n", | ||
| op.getOperationId(), op.getOperation(), op.getStatus())); | ||
| ``` | ||
|
|
||
| The `query` parameter accepts [List Filter](/list-filter) syntax. For example, | ||
| `"Endpoint = 'my-endpoint' AND ExecutionStatus = 'Running'"`. | ||
|
|
||
| ## Count Standalone Nexus Operations {/* #count-operations */} | ||
|
|
||
| Use [`NexusClient.countNexusOperationExecutions()`](https://www.javadoc.io/doc/io.temporal/temporal-sdk/latest/io/temporal/client/NexusClient.html) | ||
| to count Standalone Nexus Operation Executions that match a [List Filter](/list-filter) query. | ||
|
|
||
| Note that `countNexusOperationExecutions()` is called on a `NexusClient`, not on the typed `NexusServiceClient`. | ||
|
|
||
| ```java | ||
| String query = "Endpoint = \"" + ENDPOINT_NAME + "\""; | ||
| NexusOperationExecutionCount count = nexusClient.countNexusOperationExecutions(query); | ||
| System.out.println("Total Nexus operations: " + count.getCount()); | ||
| ``` | ||
|
|
||
| Passing a `GROUP BY` query (for example, `"GROUP BY ExecutionStatus"`) returns a count per group, available through | ||
| `NexusOperationExecutionCount.getGroups()`. | ||
|
|
||
| ## Run Standalone Nexus Operations with Temporal Cloud {/* #run-standalone-nexus-operations-temporal-cloud */} | ||
|
|
||
| The code samples referenced on this page build their client from a `ClientConfigProfile` loaded from a TOML profile, so | ||
| the same code works against Temporal Cloud — just point the profile at your Cloud Namespace (or override the connection | ||
| via `TEMPORAL_*` environment variables). No code changes are needed. | ||
|
|
||
| For full details on connecting to Temporal Cloud, including Namespace creation, Nexus Endpoint setup, certificate | ||
| generation, and authentication options, see | ||
| [Make Nexus calls across Namespaces in Temporal Cloud](/develop/java/nexus/feature-guide#nexus-calls-across-namespaces-temporal-cloud) | ||
| and [Connect to Temporal Cloud](/develop/java/client/temporal-client#connect-to-temporal-cloud). | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs header here for last section - Run Standalone Nexus Operations with Temporal Cloud. Will make an edit.