Add support for attaching to a running workflow #2424
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,143 @@ | ||
| /* | ||
| * Copyright (C) 2022 Temporal Technologies, Inc. All Rights Reserved. | ||
| * | ||
| * Copyright (C) 2012-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * | ||
| * Modifications copyright (C) 2017 Uber Technologies, Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this material except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.temporal.client; | ||
|
|
||
| import com.google.common.base.Preconditions; | ||
| import io.temporal.common.Experimental; | ||
| import java.util.Objects; | ||
|
|
||
| /** | ||
| * OnConflictOptions specifies the actions to be taken when using the {@link | ||
| * io.temporal.api.enums.v1.WorkflowIdConflictPolicy#WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING} | ||
| */ | ||
| @Experimental | ||
| public class OnConflictOptions { | ||
| public static OnConflictOptions.Builder newBuilder() { | ||
| return new OnConflictOptions.Builder(); | ||
| } | ||
|
|
||
| public static OnConflictOptions.Builder newBuilder(OnConflictOptions options) { | ||
| return new OnConflictOptions.Builder(options); | ||
| } | ||
|
|
||
| public static OnConflictOptions getDefaultInstance() { | ||
| return DEFAULT_INSTANCE; | ||
| } | ||
|
|
||
| private static final OnConflictOptions DEFAULT_INSTANCE; | ||
|
|
||
| static { | ||
| DEFAULT_INSTANCE = OnConflictOptions.newBuilder().build(); | ||
| } | ||
|
|
||
| private final boolean attachRequestId; | ||
| private final boolean attachCompletionCallbacks; | ||
| private final boolean attachLinks; | ||
|
|
||
| private OnConflictOptions( | ||
| boolean attachRequestId, boolean attachCompletionCallbacks, boolean attachLinks) { | ||
| this.attachRequestId = attachRequestId; | ||
| this.attachCompletionCallbacks = attachCompletionCallbacks; | ||
| this.attachLinks = attachLinks; | ||
| } | ||
|
|
||
| public boolean isAttachRequestId() { | ||
| return attachRequestId; | ||
| } | ||
|
|
||
| public boolean isAttachCompletionCallbacks() { | ||
| return attachCompletionCallbacks; | ||
| } | ||
|
|
||
| public boolean isAttachLinks() { | ||
| return attachLinks; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
| OnConflictOptions that = (OnConflictOptions) o; | ||
| return attachRequestId == that.attachRequestId | ||
| && attachCompletionCallbacks == that.attachCompletionCallbacks | ||
| && attachLinks == that.attachLinks; | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(attachRequestId, attachCompletionCallbacks, attachLinks); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return "OnConflictOptions{" | ||
| + "attachRequestId=" | ||
| + attachRequestId | ||
| + ", attachCompletionCallbacks=" | ||
| + attachCompletionCallbacks | ||
| + ", attachLinks=" | ||
| + attachLinks | ||
| + '}'; | ||
| } | ||
|
|
||
| public static final class Builder { | ||
| private boolean attachRequestId; | ||
| private boolean attachCompletionCallbacks; | ||
| private boolean attachLinks; | ||
|
|
||
| public Builder(OnConflictOptions options) { | ||
| this.attachRequestId = options.attachRequestId; | ||
| this.attachCompletionCallbacks = options.attachCompletionCallbacks; | ||
| this.attachLinks = options.attachLinks; | ||
| } | ||
|
|
||
| public Builder() {} | ||
|
|
||
| /** Attaches the request ID to the running workflow. */ | ||
| public Builder setAttachRequestId(boolean attachRequestId) { | ||
| this.attachRequestId = attachRequestId; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Attaches the completion callbacks to the running workflow. If true, AttachRequestId must be | ||
| * true. | ||
| */ | ||
| public Builder setAttachCompletionCallbacks(boolean attachCompletionCallbacks) { | ||
| this.attachCompletionCallbacks = attachCompletionCallbacks; | ||
| return this; | ||
| } | ||
|
|
||
| /** Attaches the links to the WorkflowExecutionOptionsUpdatedEvent history event. */ | ||
| public Builder setAttachLinks(boolean attachLinks) { | ||
| this.attachLinks = attachLinks; | ||
| return this; | ||
| } | ||
|
|
||
| public OnConflictOptions build() { | ||
| if (attachCompletionCallbacks) { | ||
| Preconditions.checkState( | ||
| attachRequestId, "AttachRequestId must be true if AttachCompletionCallbacks is true"); | ||
| } | ||
| return new OnConflictOptions(attachRequestId, attachCompletionCallbacks, attachLinks); | ||
|
Member
There was a problem hiding this comment. The server doesn't allow attaching callbacks without also attaching a request ID (as of yesterday). I'm wondering if we should verify that SDK side and document it on the builder setters. We definitely should in the api (@rodrigozhou). |
||
| } | ||
| } | ||
| } | ||
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
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
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.
Hrmm, it was my understanding that we were going to hive this from users, though I know that is difficult in Java. If instead we're ok with showing to users but marking experimental, I think we should do the same in Go.
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.
We can't avoid exposing it given the structure of the Java SDK, just because the Java SDK has this unfortunate limitation doesn't mean other SDKs should copy it
Uh oh!
There was an error while loading. Please reload this page.
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.
So the question becomes should other SDKs follow Go's lead or Java's lead here. Sounds like we are saying Java will be the outlier instead of updating Go to expose as well?
Uh oh!
There was an error while loading. Please reload this page.
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.
Yes other SDKs should not copy it