Stand alone operations for Nexus #2872
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,79 @@ | ||
| package io.temporal.client; | ||
|
|
||
| import io.temporal.common.Experimental; | ||
| import io.temporal.common.interceptors.NexusClientCallsInterceptor.CountNexusOperationExecutionsInput; | ||
| import io.temporal.common.interceptors.NexusClientCallsInterceptor.CountNexusOperationExecutionsOutput; | ||
| import io.temporal.common.interceptors.NexusClientCallsInterceptor.ListNexusOperationExecutionsInput; | ||
| import io.temporal.common.interceptors.NexusClientCallsInterceptor.ListNexusOperationExecutionsOutput; | ||
| import io.temporal.common.interceptors.NexusClientCallsInterceptor.StartNexusOperationExecutionInput; | ||
| import io.temporal.common.interceptors.NexusClientCallsInterceptor.StartNexusOperationExecutionOutput; | ||
| import io.temporal.serviceclient.WorkflowServiceStubs; | ||
| import java.lang.reflect.Type; | ||
| import javax.annotation.Nullable; | ||
|
|
||
| /** | ||
| * Client for managing standalone Nexus operation executions. | ||
| * | ||
| * <p>Per-operation actions (describe, cancel, terminate, delete, get result) live on {@link | ||
| * NexusClientHandle}; obtain a handle via {@link #getHandle}. | ||
| */ | ||
| @Experimental | ||
| public interface NexusClient { | ||
| static NexusClient newInstance(WorkflowServiceStubs service) { | ||
| return NexusClientImpl.newInstance(service, NexusClientOperationOptions.getDefaultInstance()); | ||
| } | ||
|
|
||
| static NexusClient newInstance( | ||
| WorkflowServiceStubs service, NexusClientOperationOptions options) { | ||
| return NexusClientImpl.newInstance(service, options); | ||
| } | ||
|
|
||
| /** Returns the underlying gRPC stubs this client routes RPCs through. */ | ||
| WorkflowServiceStubs getWorkflowServiceStubs(); | ||
|
|
||
| /** | ||
| * Obtain an untyped handle to an existing operation; targets the latest run. To bind a result | ||
| * type, wrap the returned handle with {@link NexusClientHandle#fromUntyped}. | ||
| */ | ||
| UntypedNexusClientHandle getHandle(String operationId); | ||
|
|
||
| /** | ||
| * Obtain an untyped handle to an existing operation, optionally pinned to a specific run. To bind | ||
| * a result type, wrap the returned handle with {@link NexusClientHandle#fromUntyped}. | ||
| */ | ||
| UntypedNexusClientHandle getHandle(String operationId, @Nullable String runId); | ||
|
|
||
| /** Obtain a typed handle to an existing operation, bound to {@code resultClass}. */ | ||
| <R> NexusClientHandle<R> getHandle( | ||
| String operationId, @Nullable String runId, Class<R> resultClass); | ||
|
|
||
| /** | ||
| * Obtain a typed handle to an existing operation, bound to {@code resultClass}/{@code | ||
| * resultType}. Use the {@code resultType} variant when the result is a generic type whose | ||
| * parameters cannot be captured by {@link Class} alone (e.g. {@code List<String>}). | ||
| */ | ||
| <R> NexusClientHandle<R> getHandle( | ||
| String operationId, @Nullable String runId, Class<R> resultClass, @Nullable Type resultType); | ||
|
|
||
| /** Build an untyped service client targeting {@code endpoint}/{@code serviceName}. */ | ||
| UntypedNexusServiceClient newUntypedNexusServiceClient(String endpoint, String serviceName); | ||
|
|
||
| /** | ||
| * Build a typed service client for {@code serviceInterface}, targeting {@code endpoint}. The | ||
| * service name is extracted from {@code serviceInterface} via {@link | ||
| * io.nexusrpc.ServiceDefinition#fromClass}. | ||
| */ | ||
| <T> NexusServiceClient<T> newNexusServiceClient(Class<T> serviceInterface, String endpoint); | ||
|
|
||
| /** Start a new standalone Nexus operation execution. */ | ||
| StartNexusOperationExecutionOutput startNexusOperationExecution( | ||
|
Contributor
There was a problem hiding this comment. This method should not be on the |
||
| StartNexusOperationExecutionInput input); | ||
|
|
||
| /** List standalone Nexus operation executions matching a query. */ | ||
| ListNexusOperationExecutionsOutput listNexusOperationExecutions( | ||
|
Contributor
There was a problem hiding this comment. Client should not be returning interceptor types here, Look at other clients like https://github.com/temporalio/sdk-java/blob/master/temporal-sdk/src/main/java/io/temporal/client/ActivityClient.java#L37 |
||
| ListNexusOperationExecutionsInput input); | ||
|
|
||
| /** Count standalone Nexus operation executions matching a query. */ | ||
|
Contributor
There was a problem hiding this comment. |
||
| CountNexusOperationExecutionsOutput countNexusOperationExecutions( | ||
| CountNexusOperationExecutionsInput input); | ||
| } | ||
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,45 @@ | ||||||
| package io.temporal.client; | ||||||
|
|
||||||
| import java.lang.reflect.Type; | ||||||
| import java.util.concurrent.CompletableFuture; | ||||||
| import javax.annotation.Nullable; | ||||||
|
|
||||||
| /** | ||||||
| * Typed handle for interacting with an existing standalone Nexus operation execution. Add a result | ||||||
| * type binding to an {@link UntypedNexusClientHandle} (returned by {@link | ||||||
| * NexusClient#getHandle(String)}) by calling one of the {@link #fromUntyped} factories. | ||||||
| */ | ||||||
| public interface NexusClientHandle<R> extends UntypedNexusClientHandle { | ||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
Please keep consistent naming with other Handles like https://github.com/temporalio/sdk-java/blob/master/temporal-sdk/src/main/java/io/temporal/client/ActivityHandle.java |
||||||
|
|
||||||
| /** Wrap an {@link UntypedNexusClientHandle} as a typed handle bound to {@code resultClass}. */ | ||||||
| static <R> NexusClientHandle<R> fromUntyped( | ||||||
| UntypedNexusClientHandle handle, Class<R> resultClass) { | ||||||
| return fromUntyped(handle, resultClass, null); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Wrap an {@link UntypedNexusClientHandle} as a typed handle bound to {@code resultClass} and | ||||||
| * {@code resultType}. Pass a non-null {@code resultType} when the result is a generic type whose | ||||||
| * parameters cannot be captured by {@link Class} alone (e.g. {@code List<String>}). | ||||||
| */ | ||||||
| static <R> NexusClientHandle<R> fromUntyped( | ||||||
| UntypedNexusClientHandle handle, Class<R> resultClass, @Nullable Type resultType) { | ||||||
| return NexusClientHandleImpl.fromUntyped(handle, resultClass, resultType); | ||||||
| } | ||||||
|
|
||||||
| /** Block until the operation completes and return the typed result. */ | ||||||
| R getResult(); | ||||||
|
|
||||||
| /** Block up to {@code timeout} for the operation to complete and return the typed result. */ | ||||||
| R getResult(long timeout, java.util.concurrent.TimeUnit unit) | ||||||
| throws java.util.concurrent.TimeoutException; | ||||||
|
|
||||||
| /** Returns a future that completes with the typed result when the operation finishes. */ | ||||||
| CompletableFuture<R> getResultAsync(); | ||||||
|
|
||||||
| /** | ||||||
| * Returns a future that completes with the typed result, or completes exceptionally with a {@link | ||||||
| * java.util.concurrent.TimeoutException} if {@code timeout} elapses first. | ||||||
| */ | ||||||
| CompletableFuture<R> getResultAsync(long timeout, java.util.concurrent.TimeUnit unit); | ||||||
| } | ||||||
Oops, something went wrong.
Oops, something went wrong.
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.
All the methods here should have full Javadocs , see https://github.com/temporalio/sdk-java/blob/master/temporal-sdk/src/main/java/io/temporal/client/ActivityClient.java as an example