Skip to content

Commit 9ce2508

Browse files
authored
Remove WithStartOperation from docs (#1850)
1 parent a85ce60 commit 9ce2508

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

internal/client.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -641,14 +641,14 @@ type (
641641

642642
// WorkflowIDConflictPolicy - Specifies server behavior if a *running* workflow with the same id exists.
643643
// This cannot be set if WorkflowIDReusePolicy is set to TerminateIfRunning.
644-
// Optional: defaulted to Fail.
644+
// Optional: defaulted to Fail - required when used in WithStartWorkflowOperation.
645645
WorkflowIDConflictPolicy enumspb.WorkflowIdConflictPolicy
646646

647647
// When WorkflowExecutionErrorWhenAlreadyStarted is true, Client.ExecuteWorkflow will return an error if the
648648
// workflow id has already been used and WorkflowIDReusePolicy or WorkflowIDConflictPolicy would
649649
// disallow a re-run. If it is set to false, rather than erroring a WorkflowRun instance representing
650650
// the current or last run will be returned. However, this field is ignored in the following cases:
651-
// - when WithStartOperation is set;
651+
// - in WithStartWorkflowOperation;
652652
// - in the Nexus WorkflowRunOperation.
653653
// When this field is ignored, you must set WorkflowIDConflictPolicy to UseExisting to prevent
654654
// erroring.
@@ -675,7 +675,7 @@ type (
675675
// │ │ │ │ │
676676
// │ │ │ │ │
677677
// * * * * *
678-
// Cannot be set the same time as a StartDelay or WithStartOperation.
678+
// Cannot be set the same time as a StartDelay or in WithStartWorkflowOperation.
679679
CronSchedule string
680680

681681
// Memo - Optional non-indexed info that will be shown in list workflow.
@@ -701,7 +701,7 @@ type (
701701
TypedSearchAttributes SearchAttributes
702702

703703
// EnableEagerStart - request eager execution for this workflow, if a local worker is available.
704-
// Cannot be set the same time as a WithStartOperation.
704+
// Cannot be set in WithStartWorkflowOperation.
705705
//
706706
// WARNING: Eager start does not respect worker versioning. An eagerly started workflow may run on
707707
// any available local worker even if that worker is not in the default build ID set.
@@ -711,7 +711,7 @@ type (
711711

712712
// StartDelay - Time to wait before dispatching the first workflow task.
713713
// A signal from signal with start will not trigger a workflow task.
714-
// Cannot be set the same time as a CronSchedule or WithStartOperation.
714+
// Cannot be set the same time as a CronSchedule or in WithStartWorkflowOperation.
715715
StartDelay time.Duration
716716

717717
// StaticSummary - Single-line fixed summary for this workflow execution that will appear in UI/CLI. This can be

0 commit comments

Comments
 (0)