Table of Contents

Namespace Temporalio.Api.WorkflowService.V1

Classes

CountWorkflowExecutionsRequest
CountWorkflowExecutionsResponse
CountWorkflowExecutionsResponse.Types

Container for nested types declared in the CountWorkflowExecutionsResponse message type.

CountWorkflowExecutionsResponse.Types.AggregationGroup
CreateScheduleRequest

(-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: field_behavior annotation not available in our gogo fork --)

CreateScheduleResponse
CreateWorkflowRuleRequest
CreateWorkflowRuleResponse
DeleteScheduleRequest
DeleteScheduleResponse
DeleteWorkerDeploymentRequest

Deletes records of (an old) Deployment. A deployment can only be deleted if it has no Version in it.

DeleteWorkerDeploymentResponse
DeleteWorkerDeploymentVersionRequest

Used for manual deletion of Versions. User can delete a Version only when all the following conditions are met:

  • It is not the Current or Ramping Version of its Deployment.
  • It has no active pollers (none of the task queues in the Version have pollers)
  • It is not draining (see WorkerDeploymentVersionInfo.drainage_info). This condition can be skipped by passing skip-drainage=true.
DeleteWorkerDeploymentVersionResponse
DeleteWorkflowExecutionRequest
DeleteWorkflowExecutionResponse
DeleteWorkflowRuleRequest
DeleteWorkflowRuleResponse
DeprecateNamespaceRequest

Deprecated.

DeprecateNamespaceResponse

Deprecated.

DescribeBatchOperationRequest
DescribeBatchOperationResponse
DescribeDeploymentRequest

[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later

DescribeDeploymentResponse

[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later

DescribeNamespaceRequest
DescribeNamespaceResponse
DescribeScheduleRequest
DescribeScheduleResponse
DescribeTaskQueueRequest

(-- api-linter: core::0203::optional=disabled aip.dev/not-precedent: field_behavior annotation not available in our gogo fork --)

DescribeTaskQueueResponse
DescribeWorkerDeploymentRequest
DescribeWorkerDeploymentResponse
DescribeWorkerDeploymentVersionRequest
DescribeWorkerDeploymentVersionResponse
DescribeWorkflowExecutionRequest
DescribeWorkflowExecutionResponse
DescribeWorkflowRuleRequest
DescribeWorkflowRuleResponse
ExecuteMultiOperationRequest
ExecuteMultiOperationRequest.Types

Container for nested types declared in the ExecuteMultiOperationRequest message type.

ExecuteMultiOperationRequest.Types.Operation
ExecuteMultiOperationResponse

IMPORTANT: For [StartWorkflow, UpdateWorkflow] combination ("Update-with-Start") when both

  1. the workflow update for the requested update ID has already completed, and
  2. the workflow for the requested workflow ID has already been closed, then you'll receive
  • an update response containing the update's outcome, and
  • a start response with a status field that reflects the workflow's current state.
ExecuteMultiOperationResponse.Types

Container for nested types declared in the ExecuteMultiOperationResponse message type.

ExecuteMultiOperationResponse.Types.Response
GetClusterInfoRequest
GetClusterInfoResponse

GetClusterInfoResponse contains information about Temporal cluster.

GetCurrentDeploymentRequest

Returns the Current Deployment of a deployment series. [cleanup-wv-pre-release] Pre-release deployment APIs, clean up later

GetCurrentDeploymentResponse

[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later

GetDeploymentReachabilityRequest

[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later

GetDeploymentReachabilityResponse

[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later

GetSearchAttributesRequest
GetSearchAttributesResponse
GetSystemInfoRequest
GetSystemInfoResponse
GetSystemInfoResponse.Types

Container for nested types declared in the GetSystemInfoResponse message type.

GetSystemInfoResponse.Types.Capabilities

System capability details.

GetWorkerBuildIdCompatibilityRequest

[cleanup-wv-pre-release]

GetWorkerBuildIdCompatibilityResponse

[cleanup-wv-pre-release]

GetWorkerTaskReachabilityRequest

[cleanup-wv-pre-release] Deprecated. Use DescribeTaskQueue.

GetWorkerTaskReachabilityResponse

[cleanup-wv-pre-release] Deprecated. Use DescribeTaskQueue.

GetWorkerVersioningRulesRequest

[cleanup-wv-pre-release]

GetWorkerVersioningRulesResponse

[cleanup-wv-pre-release]

GetWorkflowExecutionHistoryRequest
GetWorkflowExecutionHistoryResponse
GetWorkflowExecutionHistoryReverseRequest
GetWorkflowExecutionHistoryReverseResponse
ListArchivedWorkflowExecutionsRequest
ListArchivedWorkflowExecutionsResponse
ListBatchOperationsRequest
ListBatchOperationsResponse
ListClosedWorkflowExecutionsRequest
ListClosedWorkflowExecutionsResponse
ListDeploymentsRequest

[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later

ListDeploymentsResponse

[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later

ListNamespacesRequest
ListNamespacesResponse
ListOpenWorkflowExecutionsRequest
ListOpenWorkflowExecutionsResponse
ListScheduleMatchingTimesRequest
ListScheduleMatchingTimesResponse
ListSchedulesRequest
ListSchedulesResponse
ListTaskQueuePartitionsRequest
ListTaskQueuePartitionsResponse
ListWorkerDeploymentsRequest
ListWorkerDeploymentsResponse
ListWorkerDeploymentsResponse.Types

Container for nested types declared in the ListWorkerDeploymentsResponse message type.

ListWorkerDeploymentsResponse.Types.WorkerDeploymentSummary

(-- api-linter: core::0123::resource-annotation=disabled --) A subset of WorkerDeploymentInfo

ListWorkflowExecutionsRequest
ListWorkflowExecutionsResponse
ListWorkflowRulesRequest
ListWorkflowRulesResponse
PatchScheduleRequest
PatchScheduleResponse
PauseActivityRequest
PauseActivityResponse
PollActivityTaskQueueRequest
PollActivityTaskQueueResponse
PollNexusTaskQueueRequest
PollNexusTaskQueueResponse
PollWorkflowExecutionUpdateRequest
PollWorkflowExecutionUpdateResponse
PollWorkflowTaskQueueRequest
PollWorkflowTaskQueueResponse
QueryWorkflowRequest
QueryWorkflowResponse
RecordActivityTaskHeartbeatByIdRequest
RecordActivityTaskHeartbeatByIdResponse
RecordActivityTaskHeartbeatRequest
RecordActivityTaskHeartbeatResponse
RegisterNamespaceRequest
RegisterNamespaceResponse
RequestCancelWorkflowExecutionRequest
RequestCancelWorkflowExecutionResponse
RequestResponseReflection

Holder for reflection information generated from temporal/api/workflowservice/v1/request_response.proto

ResetActivityRequest
ResetActivityResponse
ResetStickyTaskQueueRequest
ResetStickyTaskQueueResponse
ResetWorkflowExecutionRequest
ResetWorkflowExecutionResponse
RespondActivityTaskCanceledByIdRequest
RespondActivityTaskCanceledByIdResponse
RespondActivityTaskCanceledRequest
RespondActivityTaskCanceledResponse
RespondActivityTaskCompletedByIdRequest
RespondActivityTaskCompletedByIdResponse
RespondActivityTaskCompletedRequest
RespondActivityTaskCompletedResponse
RespondActivityTaskFailedByIdRequest
RespondActivityTaskFailedByIdResponse
RespondActivityTaskFailedRequest
RespondActivityTaskFailedResponse
RespondNexusTaskCompletedRequest
RespondNexusTaskCompletedResponse
RespondNexusTaskFailedRequest
RespondNexusTaskFailedResponse
RespondQueryTaskCompletedRequest
RespondQueryTaskCompletedResponse
RespondWorkflowTaskCompletedRequest
RespondWorkflowTaskCompletedRequest.Types

Container for nested types declared in the RespondWorkflowTaskCompletedRequest message type.

RespondWorkflowTaskCompletedRequest.Types.Capabilities

SDK capability details.

RespondWorkflowTaskCompletedResponse
RespondWorkflowTaskFailedRequest
RespondWorkflowTaskFailedResponse
ScanWorkflowExecutionsRequest

Deprecated: Use with ListWorkflowExecutions.

ScanWorkflowExecutionsResponse

Deprecated: Use with ListWorkflowExecutions.

ServiceReflection

Holder for reflection information generated from temporal/api/workflowservice/v1/service.proto

SetCurrentDeploymentRequest

[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later

SetCurrentDeploymentResponse

[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later

SetWorkerDeploymentCurrentVersionRequest

Set/unset the Current Version of a Worker Deployment.

SetWorkerDeploymentCurrentVersionResponse
SetWorkerDeploymentRampingVersionRequest

Set/unset the Ramping Version of a Worker Deployment and its ramp percentage.

SetWorkerDeploymentRampingVersionResponse
ShutdownWorkerRequest
ShutdownWorkerResponse
SignalWithStartWorkflowExecutionRequest
SignalWithStartWorkflowExecutionResponse
SignalWorkflowExecutionRequest

Keep the parameters in sync with:

  • temporal.api.batch.v1.BatchOperationSignal.
  • temporal.api.workflow.v1.PostResetOperation.SignalWorkflow.
SignalWorkflowExecutionResponse
StartBatchOperationRequest
StartBatchOperationResponse
StartWorkflowExecutionRequest
StartWorkflowExecutionResponse
StopBatchOperationRequest
StopBatchOperationResponse
TerminateWorkflowExecutionRequest
TerminateWorkflowExecutionResponse
TriggerWorkflowRuleRequest
TriggerWorkflowRuleResponse
UnpauseActivityRequest
UnpauseActivityResponse
UpdateActivityOptionsRequest
UpdateActivityOptionsResponse
UpdateNamespaceRequest
UpdateNamespaceResponse
UpdateScheduleRequest
UpdateScheduleResponse
UpdateWorkerBuildIdCompatibilityRequest

[cleanup-wv-pre-release]

UpdateWorkerBuildIdCompatibilityRequest.Types

Container for nested types declared in the UpdateWorkerBuildIdCompatibilityRequest message type.

UpdateWorkerBuildIdCompatibilityRequest.Types.AddNewCompatibleVersion
UpdateWorkerBuildIdCompatibilityRequest.Types.MergeSets
UpdateWorkerBuildIdCompatibilityResponse

[cleanup-wv-pre-release]

UpdateWorkerDeploymentVersionMetadataRequest

Used to update the user-defined metadata of a Worker Deployment Version.

UpdateWorkerDeploymentVersionMetadataResponse
UpdateWorkerVersioningRulesRequest

(-- api-linter: core::0134::request-mask-required=disabled aip.dev/not-precedent: UpdateNamespace RPC doesn't follow Google API format. --) (-- api-linter: core::0134::request-resource-required=disabled aip.dev/not-precedent: GetWorkerBuildIdCompatibilityRequest RPC doesn't follow Google API format. --) [cleanup-wv-pre-release]

UpdateWorkerVersioningRulesRequest.Types

Container for nested types declared in the UpdateWorkerVersioningRulesRequest message type.

UpdateWorkerVersioningRulesRequest.Types.AddCompatibleBuildIdRedirectRule

Adds the rule to the list of redirect rules for this Task Queue. There can be at most one redirect rule for each distinct Source Build ID.

UpdateWorkerVersioningRulesRequest.Types.CommitBuildId

This command is intended to be used to complete the rollout of a Build ID and cleanup unnecessary rules possibly created during a gradual rollout. Specifically, this command will make the following changes atomically:

  1. Adds an assignment rule (with full ramp) for the target Build ID at the end of the list.
  2. Removes all previously added assignment rules to the given target Build ID (if any).
  3. Removes any fully-ramped assignment rule for other Build IDs.
UpdateWorkerVersioningRulesRequest.Types.DeleteBuildIdAssignmentRule
UpdateWorkerVersioningRulesRequest.Types.DeleteCompatibleBuildIdRedirectRule
UpdateWorkerVersioningRulesRequest.Types.InsertBuildIdAssignmentRule

Inserts the rule to the list of assignment rules for this Task Queue. The rules are evaluated in order, starting from index 0. The first applicable rule will be applied and the rest will be ignored.

UpdateWorkerVersioningRulesRequest.Types.ReplaceBuildIdAssignmentRule

Replaces the assignment rule at a given index.

UpdateWorkerVersioningRulesRequest.Types.ReplaceCompatibleBuildIdRedirectRule

Replaces the routing rule with the given source Build ID.

UpdateWorkerVersioningRulesResponse

[cleanup-wv-pre-release]

UpdateWorkflowExecutionOptionsRequest

Keep the parameters in sync with:

  • temporal.api.batch.v1.BatchOperationUpdateWorkflowExecutionOptions.
  • temporal.api.workflow.v1.PostResetOperation.UpdateWorkflowOptions.
UpdateWorkflowExecutionOptionsResponse
UpdateWorkflowExecutionRequest

(-- api-linter: core::0134=disabled aip.dev/not-precedent: Update RPCs don't follow Google API format. --)

UpdateWorkflowExecutionResponse

Enums

ExecuteMultiOperationRequest.Types.Operation.OperationOneofCase

Enum of possible cases for the "operation" oneof.

ExecuteMultiOperationResponse.Types.Response.ResponseOneofCase

Enum of possible cases for the "response" oneof.

ListClosedWorkflowExecutionsRequest.FiltersOneofCase

Enum of possible cases for the "filters" oneof.

ListOpenWorkflowExecutionsRequest.FiltersOneofCase

Enum of possible cases for the "filters" oneof.

PauseActivityRequest.ActivityOneofCase

Enum of possible cases for the "activity" oneof.

ResetActivityRequest.ActivityOneofCase

Enum of possible cases for the "activity" oneof.

StartBatchOperationRequest.OperationOneofCase

Enum of possible cases for the "operation" oneof.

TriggerWorkflowRuleRequest.RuleOneofCase

Enum of possible cases for the "rule" oneof.

UnpauseActivityRequest.ActivityOneofCase

Enum of possible cases for the "activity" oneof.

UpdateActivityOptionsRequest.ActivityOneofCase

Enum of possible cases for the "activity" oneof.

UpdateWorkerBuildIdCompatibilityRequest.OperationOneofCase

Enum of possible cases for the "operation" oneof.

UpdateWorkerVersioningRulesRequest.OperationOneofCase

Enum of possible cases for the "operation" oneof.