Skip to content

Commit

Permalink
more docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
@stephanos
stephanos committed Nov 30, 2024
1 parent d740d27 commit 65c304c
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 23 deletions.
63 changes: 42 additions & 21 deletions temporal-sdk/src/main/java/io/temporal/client/WorkflowClient.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -858,7 +858,8 @@ static <R, A1, A2, A3, A4, A5, A6> WorkflowUpdateHandle<R> startUpdate(
}

/**
* Start a zero argument update workflow request asynchronously, along with a workflow start request.
* Start a zero argument update workflow request asynchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -875,7 +876,8 @@ static <R> WorkflowUpdateHandle<R> startUpdateWithStart(
}

/**
* Start a one argument update workflow request asynchronously, along with a workflow start request.
* Start a one argument update workflow request asynchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -894,7 +896,8 @@ static <R, A1> WorkflowUpdateHandle<R> startUpdateWithStart(
}

/**
* Start a two argument update workflow request asynchronously, along with a workflow start request.
* Start a two argument update workflow request asynchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -915,7 +918,8 @@ static <R, A1, A2> WorkflowUpdateHandle<R> startUpdateWithStart(
}

/**
* Start a three argument update workflow request asynchronously, along with a workflow start request.
* Start a three argument update workflow request asynchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -938,7 +942,8 @@ static <R, A1, A2, A3> WorkflowUpdateHandle<R> startUpdateWithStart(
}

/**
* Start a four argument update workflow request asynchronously, along with a workflow start request.
* Start a four argument update workflow request asynchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -963,7 +968,8 @@ static <R, A1, A2, A3, A4> WorkflowUpdateHandle<R> startUpdateWithStart(
}

/**
* Start a five argument update workflow request asynchronously, along with a workflow start request.
* Start a five argument update workflow request asynchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -990,7 +996,8 @@ static <R, A1, A2, A3, A4, A5> WorkflowUpdateHandle<R> startUpdateWithStart(
}

/**
* Start a six argument update workflow request asynchronously, along with a workflow start request.
* Start a six argument update workflow request asynchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand Down Expand Up @@ -1019,7 +1026,8 @@ static <R, A1, A2, A3, A4, A5, A6> WorkflowUpdateHandle<R> startUpdateWithStart(
}

/**
* Start a zero argument update workflow request asynchronously, along with a workflow start request.
* Start a zero argument update workflow request asynchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -1036,7 +1044,8 @@ static <R> WorkflowUpdateHandle<R> startUpdateWithStart(
}

/**
* Start a one argument update workflow request asynchronously, along with a workflow start request.
* Start a one argument update workflow request asynchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -1055,7 +1064,8 @@ static <A1, R> WorkflowUpdateHandle<R> startUpdateWithStart(
}

/**
* Start a two argument update workflow request asynchronously, along with a workflow start request.
* Start a two argument update workflow request asynchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -1076,7 +1086,8 @@ static <A1, A2, R> WorkflowUpdateHandle<R> startUpdateWithStart(
}

/**
* Start a three argument update workflow request asynchronously, along with a workflow start request.
* Start a three argument update workflow request asynchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -1099,7 +1110,8 @@ static <A1, A2, A3, R> WorkflowUpdateHandle<R> startUpdateWithStart(
}

/**
* Start a four argument update workflow request asynchronously, along with a workflow start request.
* Start a four argument update workflow request asynchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -1124,7 +1136,8 @@ static <A1, A2, A3, A4, R> WorkflowUpdateHandle<R> startUpdateWithStart(
}

/**
* Start a five argument update workflow request asynchronously, along with a workflow start request.
* Start a five argument update workflow request asynchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -1151,7 +1164,8 @@ static <A1, A2, A3, A4, A5, R> WorkflowUpdateHandle<R> startUpdateWithStart(
}

/**
* Start a six argument update workflow request asynchronously, along with a workflow start request.
* Start a six argument update workflow request asynchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand Down Expand Up @@ -1180,7 +1194,8 @@ static <A1, A2, A3, A4, A5, A6, R> WorkflowUpdateHandle<R> startUpdateWithStart(
}

/**
* Execute a zero argument update workflow request synchronously, along with a workflow start request.
* Execute a zero argument update workflow request synchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -1197,7 +1212,8 @@ static <R> R executeUpdateWithStart(
}

/**
* Execute a one argument update workflow request synchronously, along with a workflow start request.
* Execute a one argument update workflow request synchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -1216,7 +1232,8 @@ static <R, A1> R executeUpdateWithStart(
}

/**
* Execute a two argument update workflow request synchronously, along with a workflow start request.
* Execute a two argument update workflow request synchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -1237,7 +1254,8 @@ static <R, A1, A2> R executeUpdateWithStart(
}

/**
* Execute a three argument update workflow request synchronously, along with a workflow start request.
* Execute a three argument update workflow request synchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -1260,7 +1278,8 @@ static <R, A1, A2, A3> R executeUpdateWithStart(
}

/**
* Execute a four argument update workflow request synchronously, along with a workflow start request.
* Execute a four argument update workflow request synchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -1285,7 +1304,8 @@ static <R, A1, A2, A3, A4> R executeUpdateWithStart(
}

/**
* Execute a five argument update workflow request synchronously, along with a workflow start request.
* Execute a five argument update workflow request synchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand All @@ -1312,7 +1332,8 @@ static <R, A1, A2, A3, A4, A5> R executeUpdateWithStart(
}

/**
* Execute a six argument update workflow request synchronously, along with a workflow start request.
* Execute a six argument update workflow request synchronously, along with a workflow start
* request.
*
* @param updateMethod The only supported value is method reference to a proxy created through
* {@link #newWorkflowStub(Class, WorkflowOptions)}.
Expand Down
10 changes: 8 additions & 2 deletions temporal-sdk/src/main/java/io/temporal/client/WorkflowStub.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

import io.temporal.api.common.v1.WorkflowExecution;
import io.temporal.api.enums.v1.QueryRejectCondition;
import io.temporal.api.enums.v1.WorkflowIdConflictPolicy;
import io.temporal.common.Experimental;
import io.temporal.failure.CanceledFailure;
import io.temporal.failure.TerminatedFailure;
Expand Down Expand Up @@ -150,7 +151,10 @@ <R> WorkflowUpdateHandle<R> getUpdateHandle(
WorkflowExecution start(Object... args);

/**
* TODO
* Asynchronously update a workflow execution by invoking its update handler, and start the
* workflow according to the option's {@link WorkflowIdConflictPolicy}. It returns a handle to the
* update request. If {@link WorkflowUpdateStage#COMPLETED} is specified, in the options, the
* handle will not be returned until the update is completed.
*
* @param updateOptions options that will be used to configure and start a new update request
* @param updateArgs update method arguments
Expand All @@ -163,7 +167,9 @@ <R> WorkflowUpdateHandle<R> startUpdateWithStart(
UpdateOptions<R> updateOptions, Object[] updateArgs, WithStartWorkflowOperation<?> startOp);

/**
* TODO
* Synchronously update a workflow execution by invoking its update handler, and start the
* workflow according to the option's {@link WorkflowIdConflictPolicy}. It returns the update
* result.
*
* @param updateOptions options that will be used to configure and start a new update request
* @param updateArgs update method arguments
Expand Down

0 comments on commit 65c304c

Please sign in to comment.