• API Documentation
Search Results for

    Show / Hide Table of Contents
    • Temporalio
      • IPayloadCodec
    • Temporalio.Api.Batch.V1
      • BatchOperationCancellation
      • BatchOperationDeletion
      • BatchOperationInfo
      • BatchOperationSignal
      • BatchOperationTermination
      • MessageReflection
    • Temporalio.Api.Command.V1
      • AcceptWorkflowUpdateCommandAttributes
      • CancelTimerCommandAttributes
      • CancelWorkflowExecutionCommandAttributes
      • Command
      • Command.AttributesOneofCase
      • CompleteWorkflowExecutionCommandAttributes
      • CompleteWorkflowUpdateCommandAttributes
      • ContinueAsNewWorkflowExecutionCommandAttributes
      • FailWorkflowExecutionCommandAttributes
      • MessageReflection
      • ModifyWorkflowPropertiesCommandAttributes
      • RecordMarkerCommandAttributes
      • RejectWorkflowUpdateCommandAttributes
      • RequestCancelActivityTaskCommandAttributes
      • RequestCancelExternalWorkflowExecutionCommandAttributes
      • ScheduleActivityTaskCommandAttributes
      • SignalExternalWorkflowExecutionCommandAttributes
      • StartChildWorkflowExecutionCommandAttributes
      • StartTimerCommandAttributes
      • UpsertWorkflowSearchAttributesCommandAttributes
    • Temporalio.Api.Common.V1
      • ActivityType
      • DataBlob
      • Header
      • Memo
      • MessageReflection
      • Payload
      • Payloads
      • RetryPolicy
      • SearchAttributes
      • WorkflowExecution
      • WorkflowType
    • Temporalio.Api.Dependencies.Gogoproto
      • GogoExtensions
      • GogoReflection
    • Temporalio.Api.Enums.V1
      • ArchivalState
      • BatchOperationReflection
      • BatchOperationState
      • BatchOperationType
      • CancelExternalWorkflowExecutionFailedCause
      • CommandType
      • CommandTypeReflection
      • CommonReflection
      • ContinueAsNewInitiator
      • EncodingType
      • EventType
      • EventTypeReflection
      • FailedCauseReflection
      • HistoryEventFilterType
      • IndexedValueType
      • InteractionType
      • InteractionTypeReflection
      • NamespaceReflection
      • NamespaceState
      • ParentClosePolicy
      • PendingActivityState
      • PendingWorkflowTaskState
      • QueryReflection
      • QueryRejectCondition
      • QueryResultType
      • ReplicationState
      • ResetReapplyType
      • ResetReflection
      • ResourceExhaustedCause
      • RetryState
      • ScheduleOverlapPolicy
      • ScheduleReflection
      • Severity
      • SignalExternalWorkflowExecutionFailedCause
      • StartChildWorkflowExecutionFailedCause
      • TaskQueueKind
      • TaskQueueReflection
      • TaskQueueType
      • TimeoutType
      • UpdateReflection
      • WorkflowExecutionStatus
      • WorkflowIdReusePolicy
      • WorkflowReflection
      • WorkflowTaskFailedCause
      • WorkflowUpdateResultAccessStyle
    • Temporalio.Api.ErrorDetails.V1
      • CancellationAlreadyRequestedFailure
      • ClientVersionNotSupportedFailure
      • MessageReflection
      • NamespaceAlreadyExistsFailure
      • NamespaceInvalidStateFailure
      • NamespaceNotActiveFailure
      • NamespaceNotFoundFailure
      • NotFoundFailure
      • PermissionDeniedFailure
      • QueryFailedFailure
      • ResourceExhaustedFailure
      • ServerVersionNotSupportedFailure
      • SystemWorkflowFailure
      • WorkflowExecutionAlreadyStartedFailure
      • WorkflowNotReadyFailure
    • Temporalio.Api.Failure.V1
      • ActivityFailureInfo
      • ApplicationFailureInfo
      • CanceledFailureInfo
      • ChildWorkflowExecutionFailureInfo
      • Failure
      • Failure.FailureInfoOneofCase
      • MessageReflection
      • ResetWorkflowFailureInfo
      • ServerFailureInfo
      • TerminatedFailureInfo
      • TimeoutFailureInfo
    • Temporalio.Api.Filter.V1
      • MessageReflection
      • StartTimeFilter
      • StatusFilter
      • WorkflowExecutionFilter
      • WorkflowTypeFilter
    • Temporalio.Api.History.V1
      • ActivityPropertiesModifiedExternallyEventAttributes
      • ActivityTaskCanceledEventAttributes
      • ActivityTaskCancelRequestedEventAttributes
      • ActivityTaskCompletedEventAttributes
      • ActivityTaskFailedEventAttributes
      • ActivityTaskScheduledEventAttributes
      • ActivityTaskStartedEventAttributes
      • ActivityTaskTimedOutEventAttributes
      • ChildWorkflowExecutionCanceledEventAttributes
      • ChildWorkflowExecutionCompletedEventAttributes
      • ChildWorkflowExecutionFailedEventAttributes
      • ChildWorkflowExecutionStartedEventAttributes
      • ChildWorkflowExecutionTerminatedEventAttributes
      • ChildWorkflowExecutionTimedOutEventAttributes
      • ExternalWorkflowExecutionCancelRequestedEventAttributes
      • ExternalWorkflowExecutionSignaledEventAttributes
      • History
      • HistoryEvent
      • HistoryEvent.AttributesOneofCase
      • MarkerRecordedEventAttributes
      • MessageReflection
      • RequestCancelExternalWorkflowExecutionFailedEventAttributes
      • RequestCancelExternalWorkflowExecutionInitiatedEventAttributes
      • SignalExternalWorkflowExecutionFailedEventAttributes
      • SignalExternalWorkflowExecutionInitiatedEventAttributes
      • StartChildWorkflowExecutionFailedEventAttributes
      • StartChildWorkflowExecutionInitiatedEventAttributes
      • TimerCanceledEventAttributes
      • TimerFiredEventAttributes
      • TimerStartedEventAttributes
      • UpsertWorkflowSearchAttributesEventAttributes
      • WorkflowExecutionCanceledEventAttributes
      • WorkflowExecutionCancelRequestedEventAttributes
      • WorkflowExecutionCompletedEventAttributes
      • WorkflowExecutionContinuedAsNewEventAttributes
      • WorkflowExecutionFailedEventAttributes
      • WorkflowExecutionSignaledEventAttributes
      • WorkflowExecutionStartedEventAttributes
      • WorkflowExecutionTerminatedEventAttributes
      • WorkflowExecutionTimedOutEventAttributes
      • WorkflowPropertiesModifiedEventAttributes
      • WorkflowPropertiesModifiedExternallyEventAttributes
      • WorkflowTaskCompletedEventAttributes
      • WorkflowTaskFailedEventAttributes
      • WorkflowTaskScheduledEventAttributes
      • WorkflowTaskStartedEventAttributes
      • WorkflowTaskTimedOutEventAttributes
      • WorkflowUpdateAcceptedEventAttributes
      • WorkflowUpdateCompletedEventAttributes
      • WorkflowUpdateRejectedEventAttributes
    • Temporalio.Api.Interaction.V1
      • Input
      • Invocation
      • MessageReflection
      • Meta
      • Output
      • Output.ResultOneofCase
    • Temporalio.Api.Namespace.V1
      • BadBinaries
      • BadBinaryInfo
      • MessageReflection
      • NamespaceConfig
      • NamespaceFilter
      • NamespaceInfo
      • UpdateNamespaceInfo
    • Temporalio.Api.OperatorService.V1
      • AddOrUpdateRemoteClusterRequest
      • AddOrUpdateRemoteClusterResponse
      • AddSearchAttributesRequest
      • AddSearchAttributesResponse
      • ClusterMetadata
      • DeleteNamespaceRequest
      • DeleteNamespaceResponse
      • ListClustersRequest
      • ListClustersResponse
      • ListSearchAttributesRequest
      • ListSearchAttributesResponse
      • RemoveRemoteClusterRequest
      • RemoveRemoteClusterResponse
      • RemoveSearchAttributesRequest
      • RemoveSearchAttributesResponse
      • RequestResponseReflection
      • ServiceReflection
    • Temporalio.Api.Query.V1
      • MessageReflection
      • QueryRejected
      • WorkflowQuery
      • WorkflowQueryResult
    • Temporalio.Api.Replication.V1
      • ClusterReplicationConfig
      • FailoverStatus
      • MessageReflection
      • NamespaceReplicationConfig
    • Temporalio.Api.Schedule.V1
      • BackfillRequest
      • CalendarSpec
      • IntervalSpec
      • MessageReflection
      • Range
      • Schedule
      • ScheduleAction
      • ScheduleAction.ActionOneofCase
      • ScheduleActionResult
      • ScheduleInfo
      • ScheduleListEntry
      • ScheduleListInfo
      • SchedulePatch
      • SchedulePolicies
      • ScheduleSpec
      • ScheduleState
      • StructuredCalendarSpec
      • TriggerImmediatelyRequest
    • Temporalio.Api.TaskQueue.V1
      • MessageReflection
      • PollerInfo
      • StickyExecutionAttributes
      • TaskIdBlock
      • TaskQueue
      • TaskQueueMetadata
      • TaskQueuePartitionMetadata
      • TaskQueueStatus
      • VersionId
      • VersionIdNode
    • Temporalio.Api.TestService.V1
      • GetCurrentTimeResponse
      • LockTimeSkippingRequest
      • LockTimeSkippingResponse
      • RequestResponseReflection
      • ServiceReflection
      • SleepRequest
      • SleepResponse
      • SleepUntilRequest
      • UnlockTimeSkippingRequest
      • UnlockTimeSkippingResponse
    • Temporalio.Api.Version.V1
      • Alert
      • MessageReflection
      • ReleaseInfo
      • VersionInfo
    • Temporalio.Api.Workflow.V1
      • MessageReflection
      • NewWorkflowExecutionInfo
      • PendingActivityInfo
      • PendingChildExecutionInfo
      • PendingWorkflowTaskInfo
      • ResetPointInfo
      • ResetPoints
      • WorkflowExecutionConfig
      • WorkflowExecutionInfo
    • Temporalio.Api.WorkflowService.V1
      • CountWorkflowExecutionsRequest
      • CountWorkflowExecutionsResponse
      • CreateScheduleRequest
      • CreateScheduleResponse
      • DeleteScheduleRequest
      • DeleteScheduleResponse
      • DeleteWorkflowExecutionRequest
      • DeleteWorkflowExecutionResponse
      • DeprecateNamespaceRequest
      • DeprecateNamespaceResponse
      • DescribeBatchOperationRequest
      • DescribeBatchOperationResponse
      • DescribeNamespaceRequest
      • DescribeNamespaceResponse
      • DescribeScheduleRequest
      • DescribeScheduleResponse
      • DescribeTaskQueueRequest
      • DescribeTaskQueueResponse
      • DescribeWorkflowExecutionRequest
      • DescribeWorkflowExecutionResponse
      • GetClusterInfoRequest
      • GetClusterInfoResponse
      • GetSearchAttributesRequest
      • GetSearchAttributesResponse
      • GetSystemInfoRequest
      • GetSystemInfoResponse
      • GetSystemInfoResponse.Types
      • GetSystemInfoResponse.Types.Capabilities
      • GetWorkerBuildIdOrderingRequest
      • GetWorkerBuildIdOrderingResponse
      • GetWorkflowExecutionHistoryRequest
      • GetWorkflowExecutionHistoryResponse
      • GetWorkflowExecutionHistoryReverseRequest
      • GetWorkflowExecutionHistoryReverseResponse
      • ListArchivedWorkflowExecutionsRequest
      • ListArchivedWorkflowExecutionsResponse
      • ListBatchOperationsRequest
      • ListBatchOperationsResponse
      • ListClosedWorkflowExecutionsRequest
      • ListClosedWorkflowExecutionsRequest.FiltersOneofCase
      • ListClosedWorkflowExecutionsResponse
      • ListNamespacesRequest
      • ListNamespacesResponse
      • ListOpenWorkflowExecutionsRequest
      • ListOpenWorkflowExecutionsRequest.FiltersOneofCase
      • ListOpenWorkflowExecutionsResponse
      • ListScheduleMatchingTimesRequest
      • ListScheduleMatchingTimesResponse
      • ListSchedulesRequest
      • ListSchedulesResponse
      • ListTaskQueuePartitionsRequest
      • ListTaskQueuePartitionsResponse
      • ListWorkflowExecutionsRequest
      • ListWorkflowExecutionsResponse
      • PatchScheduleRequest
      • PatchScheduleResponse
      • PollActivityTaskQueueRequest
      • PollActivityTaskQueueResponse
      • PollWorkflowTaskQueueRequest
      • PollWorkflowTaskQueueResponse
      • QueryWorkflowRequest
      • QueryWorkflowResponse
      • RecordActivityTaskHeartbeatByIdRequest
      • RecordActivityTaskHeartbeatByIdResponse
      • RecordActivityTaskHeartbeatRequest
      • RecordActivityTaskHeartbeatResponse
      • RegisterNamespaceRequest
      • RegisterNamespaceResponse
      • RequestCancelWorkflowExecutionRequest
      • RequestCancelWorkflowExecutionResponse
      • RequestResponseReflection
      • ResetStickyTaskQueueRequest
      • ResetStickyTaskQueueResponse
      • ResetWorkflowExecutionRequest
      • ResetWorkflowExecutionResponse
      • RespondActivityTaskCanceledByIdRequest
      • RespondActivityTaskCanceledByIdResponse
      • RespondActivityTaskCanceledRequest
      • RespondActivityTaskCanceledResponse
      • RespondActivityTaskCompletedByIdRequest
      • RespondActivityTaskCompletedByIdResponse
      • RespondActivityTaskCompletedRequest
      • RespondActivityTaskCompletedResponse
      • RespondActivityTaskFailedByIdRequest
      • RespondActivityTaskFailedByIdResponse
      • RespondActivityTaskFailedRequest
      • RespondActivityTaskFailedResponse
      • RespondQueryTaskCompletedRequest
      • RespondQueryTaskCompletedResponse
      • RespondWorkflowTaskCompletedRequest
      • RespondWorkflowTaskCompletedResponse
      • RespondWorkflowTaskFailedRequest
      • RespondWorkflowTaskFailedResponse
      • ScanWorkflowExecutionsRequest
      • ScanWorkflowExecutionsResponse
      • ServiceReflection
      • SignalWithStartWorkflowExecutionRequest
      • SignalWithStartWorkflowExecutionResponse
      • SignalWorkflowExecutionRequest
      • SignalWorkflowExecutionResponse
      • StartBatchOperationRequest
      • StartBatchOperationRequest.OperationOneofCase
      • StartBatchOperationResponse
      • StartWorkflowExecutionRequest
      • StartWorkflowExecutionResponse
      • StopBatchOperationRequest
      • StopBatchOperationResponse
      • TerminateWorkflowExecutionRequest
      • TerminateWorkflowExecutionResponse
      • UpdateNamespaceRequest
      • UpdateNamespaceResponse
      • UpdateScheduleRequest
      • UpdateScheduleResponse
      • UpdateWorkerBuildIdOrderingRequest
      • UpdateWorkerBuildIdOrderingResponse
      • UpdateWorkflowRequest
      • UpdateWorkflowResponse
    • Temporalio.Client
      • IBridgeClientProvider
      • ITemporalClient
      • ITemporalConnection
      • OperatorService
      • OperatorService.Impl
      • RpcOptions
      • RpcRetryOptions
      • RpcService
      • TemporalClient
      • TemporalClientConnectOptions
      • TemporalClientOptions
      • TemporalConnection
      • TemporalConnectionOptions
      • TestService
      • TestService.Impl
      • TlsOptions
      • WorkflowService
      • WorkflowService.Impl
    • Temporalio.Converters
      • BinaryNullConverter
      • BinaryPlainConverter
      • BinaryProtoConverter
      • ConverterExtensions
      • DefaultFailureConverter
      • DefaultFailureConverterOptions
      • DefaultPayloadConverter
      • IEncodingConverter
      • IFailureConverter
      • IPayloadConverter
      • JsonPlainConverter
      • JsonProtoConverter
      • PayloadCodecExtensions
      • WithEncodedCommonAttributes
    • Temporalio.Exceptions
      • ActivityFailureException
      • ApplicationFailureException
      • CancelledFailureException
      • ChildWorkflowFailureException
      • FailureException
      • IFailureDetails
      • ServerFailureException
      • TemporalException
      • TerminatedFailureException
      • TimeoutFailureException
    • Temporalio.Runtime
      • LoggingOptions
      • MetricsOptions
      • OpenTelemetryOptions
      • PrometheusOptions
      • TelemetryFilterOptions
      • TelemetryFilterOptions.Level
      • TelemetryOptions
      • TemporalRuntime
      • TemporalRuntimeOptions
      • TracingOptions
    • Temporalio.Testing
      • TemporaliteOptions
      • TestServerOptions
      • WorkflowEnvironment
      • WorkflowEnvironmentStartLocalOptions
      • WorkflowEnvironmentStartTimeSkippingOptions
    • Temporalio.Worker
      • IWorkerClient

    Class WorkflowService

    Raw gRPC workflow service.

    Inheritance
    Object
    RpcService
    WorkflowService
    WorkflowService.Impl
    Inherited Members
    RpcService.InvokeRpcAsync<T>(String, IMessage, MessageParser<T>, RpcOptions)
    Namespace: Temporalio.Client
    Assembly: Temporalio.dll
    Syntax
    public abstract class WorkflowService : RpcService

    Methods

    CountWorkflowExecutionsAsync(CountWorkflowExecutionsRequest, RpcOptions)

    Invoke CountWorkflowExecutions.

    Declaration
    public Task<CountWorkflowExecutionsResponse> CountWorkflowExecutionsAsync(CountWorkflowExecutionsRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    CountWorkflowExecutionsRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<CountWorkflowExecutionsResponse>

    RPC response

    CreateScheduleAsync(CreateScheduleRequest, RpcOptions)

    Invoke CreateSchedule.

    Declaration
    public Task<CreateScheduleResponse> CreateScheduleAsync(CreateScheduleRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    CreateScheduleRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<CreateScheduleResponse>

    RPC response

    DeleteScheduleAsync(DeleteScheduleRequest, RpcOptions)

    Invoke DeleteSchedule.

    Declaration
    public Task<DeleteScheduleResponse> DeleteScheduleAsync(DeleteScheduleRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    DeleteScheduleRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<DeleteScheduleResponse>

    RPC response

    DeleteWorkflowExecutionAsync(DeleteWorkflowExecutionRequest, RpcOptions)

    Invoke DeleteWorkflowExecution.

    Declaration
    public Task<DeleteWorkflowExecutionResponse> DeleteWorkflowExecutionAsync(DeleteWorkflowExecutionRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    DeleteWorkflowExecutionRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<DeleteWorkflowExecutionResponse>

    RPC response

    DeprecateNamespaceAsync(DeprecateNamespaceRequest, RpcOptions)

    Invoke DeprecateNamespace.

    Declaration
    public Task<DeprecateNamespaceResponse> DeprecateNamespaceAsync(DeprecateNamespaceRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    DeprecateNamespaceRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<DeprecateNamespaceResponse>

    RPC response

    DescribeBatchOperationAsync(DescribeBatchOperationRequest, RpcOptions)

    Invoke DescribeBatchOperation.

    Declaration
    public Task<DescribeBatchOperationResponse> DescribeBatchOperationAsync(DescribeBatchOperationRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    DescribeBatchOperationRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<DescribeBatchOperationResponse>

    RPC response

    DescribeNamespaceAsync(DescribeNamespaceRequest, RpcOptions)

    Invoke DescribeNamespace.

    Declaration
    public Task<DescribeNamespaceResponse> DescribeNamespaceAsync(DescribeNamespaceRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    DescribeNamespaceRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<DescribeNamespaceResponse>

    RPC response

    DescribeScheduleAsync(DescribeScheduleRequest, RpcOptions)

    Invoke DescribeSchedule.

    Declaration
    public Task<DescribeScheduleResponse> DescribeScheduleAsync(DescribeScheduleRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    DescribeScheduleRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<DescribeScheduleResponse>

    RPC response

    DescribeTaskQueueAsync(DescribeTaskQueueRequest, RpcOptions)

    Invoke DescribeTaskQueue.

    Declaration
    public Task<DescribeTaskQueueResponse> DescribeTaskQueueAsync(DescribeTaskQueueRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    DescribeTaskQueueRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<DescribeTaskQueueResponse>

    RPC response

    DescribeWorkflowExecutionAsync(DescribeWorkflowExecutionRequest, RpcOptions)

    Invoke DescribeWorkflowExecution.

    Declaration
    public Task<DescribeWorkflowExecutionResponse> DescribeWorkflowExecutionAsync(DescribeWorkflowExecutionRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    DescribeWorkflowExecutionRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<DescribeWorkflowExecutionResponse>

    RPC response

    GetClusterInfoAsync(GetClusterInfoRequest, RpcOptions)

    Invoke GetClusterInfo.

    Declaration
    public Task<GetClusterInfoResponse> GetClusterInfoAsync(GetClusterInfoRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    GetClusterInfoRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<GetClusterInfoResponse>

    RPC response

    GetSearchAttributesAsync(GetSearchAttributesRequest, RpcOptions)

    Invoke GetSearchAttributes.

    Declaration
    public Task<GetSearchAttributesResponse> GetSearchAttributesAsync(GetSearchAttributesRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    GetSearchAttributesRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<GetSearchAttributesResponse>

    RPC response

    GetSystemInfoAsync(GetSystemInfoRequest, RpcOptions)

    Invoke GetSystemInfo.

    Declaration
    public Task<GetSystemInfoResponse> GetSystemInfoAsync(GetSystemInfoRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    GetSystemInfoRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<GetSystemInfoResponse>

    RPC response

    GetWorkerBuildIdOrderingAsync(GetWorkerBuildIdOrderingRequest, RpcOptions)

    Invoke GetWorkerBuildIdOrdering.

    Declaration
    public Task<GetWorkerBuildIdOrderingResponse> GetWorkerBuildIdOrderingAsync(GetWorkerBuildIdOrderingRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    GetWorkerBuildIdOrderingRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<GetWorkerBuildIdOrderingResponse>

    RPC response

    GetWorkflowExecutionHistoryAsync(GetWorkflowExecutionHistoryRequest, RpcOptions)

    Invoke GetWorkflowExecutionHistory.

    Declaration
    public Task<GetWorkflowExecutionHistoryResponse> GetWorkflowExecutionHistoryAsync(GetWorkflowExecutionHistoryRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    GetWorkflowExecutionHistoryRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<GetWorkflowExecutionHistoryResponse>

    RPC response

    GetWorkflowExecutionHistoryReverseAsync(GetWorkflowExecutionHistoryReverseRequest, RpcOptions)

    Invoke GetWorkflowExecutionHistoryReverse.

    Declaration
    public Task<GetWorkflowExecutionHistoryReverseResponse> GetWorkflowExecutionHistoryReverseAsync(GetWorkflowExecutionHistoryReverseRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    GetWorkflowExecutionHistoryReverseRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<GetWorkflowExecutionHistoryReverseResponse>

    RPC response

    ListArchivedWorkflowExecutionsAsync(ListArchivedWorkflowExecutionsRequest, RpcOptions)

    Invoke ListArchivedWorkflowExecutions.

    Declaration
    public Task<ListArchivedWorkflowExecutionsResponse> ListArchivedWorkflowExecutionsAsync(ListArchivedWorkflowExecutionsRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    ListArchivedWorkflowExecutionsRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<ListArchivedWorkflowExecutionsResponse>

    RPC response

    ListBatchOperationsAsync(ListBatchOperationsRequest, RpcOptions)

    Invoke ListBatchOperations.

    Declaration
    public Task<ListBatchOperationsResponse> ListBatchOperationsAsync(ListBatchOperationsRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    ListBatchOperationsRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<ListBatchOperationsResponse>

    RPC response

    ListClosedWorkflowExecutionsAsync(ListClosedWorkflowExecutionsRequest, RpcOptions)

    Invoke ListClosedWorkflowExecutions.

    Declaration
    public Task<ListClosedWorkflowExecutionsResponse> ListClosedWorkflowExecutionsAsync(ListClosedWorkflowExecutionsRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    ListClosedWorkflowExecutionsRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<ListClosedWorkflowExecutionsResponse>

    RPC response

    ListNamespacesAsync(ListNamespacesRequest, RpcOptions)

    Invoke ListNamespaces.

    Declaration
    public Task<ListNamespacesResponse> ListNamespacesAsync(ListNamespacesRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    ListNamespacesRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<ListNamespacesResponse>

    RPC response

    ListOpenWorkflowExecutionsAsync(ListOpenWorkflowExecutionsRequest, RpcOptions)

    Invoke ListOpenWorkflowExecutions.

    Declaration
    public Task<ListOpenWorkflowExecutionsResponse> ListOpenWorkflowExecutionsAsync(ListOpenWorkflowExecutionsRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    ListOpenWorkflowExecutionsRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<ListOpenWorkflowExecutionsResponse>

    RPC response

    ListScheduleMatchingTimesAsync(ListScheduleMatchingTimesRequest, RpcOptions)

    Invoke ListScheduleMatchingTimes.

    Declaration
    public Task<ListScheduleMatchingTimesResponse> ListScheduleMatchingTimesAsync(ListScheduleMatchingTimesRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    ListScheduleMatchingTimesRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<ListScheduleMatchingTimesResponse>

    RPC response

    ListSchedulesAsync(ListSchedulesRequest, RpcOptions)

    Invoke ListSchedules.

    Declaration
    public Task<ListSchedulesResponse> ListSchedulesAsync(ListSchedulesRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    ListSchedulesRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<ListSchedulesResponse>

    RPC response

    ListTaskQueuePartitionsAsync(ListTaskQueuePartitionsRequest, RpcOptions)

    Invoke ListTaskQueuePartitions.

    Declaration
    public Task<ListTaskQueuePartitionsResponse> ListTaskQueuePartitionsAsync(ListTaskQueuePartitionsRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    ListTaskQueuePartitionsRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<ListTaskQueuePartitionsResponse>

    RPC response

    ListWorkflowExecutionsAsync(ListWorkflowExecutionsRequest, RpcOptions)

    Invoke ListWorkflowExecutions.

    Declaration
    public Task<ListWorkflowExecutionsResponse> ListWorkflowExecutionsAsync(ListWorkflowExecutionsRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    ListWorkflowExecutionsRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<ListWorkflowExecutionsResponse>

    RPC response

    PatchScheduleAsync(PatchScheduleRequest, RpcOptions)

    Invoke PatchSchedule.

    Declaration
    public Task<PatchScheduleResponse> PatchScheduleAsync(PatchScheduleRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    PatchScheduleRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<PatchScheduleResponse>

    RPC response

    PollActivityTaskQueueAsync(PollActivityTaskQueueRequest, RpcOptions)

    Invoke PollActivityTaskQueue.

    Declaration
    public Task<PollActivityTaskQueueResponse> PollActivityTaskQueueAsync(PollActivityTaskQueueRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    PollActivityTaskQueueRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<PollActivityTaskQueueResponse>

    RPC response

    PollWorkflowTaskQueueAsync(PollWorkflowTaskQueueRequest, RpcOptions)

    Invoke PollWorkflowTaskQueue.

    Declaration
    public Task<PollWorkflowTaskQueueResponse> PollWorkflowTaskQueueAsync(PollWorkflowTaskQueueRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    PollWorkflowTaskQueueRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<PollWorkflowTaskQueueResponse>

    RPC response

    QueryWorkflowAsync(QueryWorkflowRequest, RpcOptions)

    Invoke QueryWorkflow.

    Declaration
    public Task<QueryWorkflowResponse> QueryWorkflowAsync(QueryWorkflowRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    QueryWorkflowRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<QueryWorkflowResponse>

    RPC response

    RecordActivityTaskHeartbeatAsync(RecordActivityTaskHeartbeatRequest, RpcOptions)

    Invoke RecordActivityTaskHeartbeat.

    Declaration
    public Task<RecordActivityTaskHeartbeatResponse> RecordActivityTaskHeartbeatAsync(RecordActivityTaskHeartbeatRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    RecordActivityTaskHeartbeatRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<RecordActivityTaskHeartbeatResponse>

    RPC response

    RecordActivityTaskHeartbeatByIdAsync(RecordActivityTaskHeartbeatByIdRequest, RpcOptions)

    Invoke RecordActivityTaskHeartbeatById.

    Declaration
    public Task<RecordActivityTaskHeartbeatByIdResponse> RecordActivityTaskHeartbeatByIdAsync(RecordActivityTaskHeartbeatByIdRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    RecordActivityTaskHeartbeatByIdRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<RecordActivityTaskHeartbeatByIdResponse>

    RPC response

    RegisterNamespaceAsync(RegisterNamespaceRequest, RpcOptions)

    Invoke RegisterNamespace.

    Declaration
    public Task<RegisterNamespaceResponse> RegisterNamespaceAsync(RegisterNamespaceRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    RegisterNamespaceRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<RegisterNamespaceResponse>

    RPC response

    RequestCancelWorkflowExecutionAsync(RequestCancelWorkflowExecutionRequest, RpcOptions)

    Invoke RequestCancelWorkflowExecution.

    Declaration
    public Task<RequestCancelWorkflowExecutionResponse> RequestCancelWorkflowExecutionAsync(RequestCancelWorkflowExecutionRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    RequestCancelWorkflowExecutionRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<RequestCancelWorkflowExecutionResponse>

    RPC response

    ResetStickyTaskQueueAsync(ResetStickyTaskQueueRequest, RpcOptions)

    Invoke ResetStickyTaskQueue.

    Declaration
    public Task<ResetStickyTaskQueueResponse> ResetStickyTaskQueueAsync(ResetStickyTaskQueueRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    ResetStickyTaskQueueRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<ResetStickyTaskQueueResponse>

    RPC response

    ResetWorkflowExecutionAsync(ResetWorkflowExecutionRequest, RpcOptions)

    Invoke ResetWorkflowExecution.

    Declaration
    public Task<ResetWorkflowExecutionResponse> ResetWorkflowExecutionAsync(ResetWorkflowExecutionRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    ResetWorkflowExecutionRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<ResetWorkflowExecutionResponse>

    RPC response

    RespondActivityTaskCanceledAsync(RespondActivityTaskCanceledRequest, RpcOptions)

    Invoke RespondActivityTaskCanceled.

    Declaration
    public Task<RespondActivityTaskCanceledResponse> RespondActivityTaskCanceledAsync(RespondActivityTaskCanceledRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    RespondActivityTaskCanceledRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<RespondActivityTaskCanceledResponse>

    RPC response

    RespondActivityTaskCanceledByIdAsync(RespondActivityTaskCanceledByIdRequest, RpcOptions)

    Invoke RespondActivityTaskCanceledById.

    Declaration
    public Task<RespondActivityTaskCanceledByIdResponse> RespondActivityTaskCanceledByIdAsync(RespondActivityTaskCanceledByIdRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    RespondActivityTaskCanceledByIdRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<RespondActivityTaskCanceledByIdResponse>

    RPC response

    RespondActivityTaskCompletedAsync(RespondActivityTaskCompletedRequest, RpcOptions)

    Invoke RespondActivityTaskCompleted.

    Declaration
    public Task<RespondActivityTaskCompletedResponse> RespondActivityTaskCompletedAsync(RespondActivityTaskCompletedRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    RespondActivityTaskCompletedRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<RespondActivityTaskCompletedResponse>

    RPC response

    RespondActivityTaskCompletedByIdAsync(RespondActivityTaskCompletedByIdRequest, RpcOptions)

    Invoke RespondActivityTaskCompletedById.

    Declaration
    public Task<RespondActivityTaskCompletedByIdResponse> RespondActivityTaskCompletedByIdAsync(RespondActivityTaskCompletedByIdRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    RespondActivityTaskCompletedByIdRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<RespondActivityTaskCompletedByIdResponse>

    RPC response

    RespondActivityTaskFailedAsync(RespondActivityTaskFailedRequest, RpcOptions)

    Invoke RespondActivityTaskFailed.

    Declaration
    public Task<RespondActivityTaskFailedResponse> RespondActivityTaskFailedAsync(RespondActivityTaskFailedRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    RespondActivityTaskFailedRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<RespondActivityTaskFailedResponse>

    RPC response

    RespondActivityTaskFailedByIdAsync(RespondActivityTaskFailedByIdRequest, RpcOptions)

    Invoke RespondActivityTaskFailedById.

    Declaration
    public Task<RespondActivityTaskFailedByIdResponse> RespondActivityTaskFailedByIdAsync(RespondActivityTaskFailedByIdRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    RespondActivityTaskFailedByIdRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<RespondActivityTaskFailedByIdResponse>

    RPC response

    RespondQueryTaskCompletedAsync(RespondQueryTaskCompletedRequest, RpcOptions)

    Invoke RespondQueryTaskCompleted.

    Declaration
    public Task<RespondQueryTaskCompletedResponse> RespondQueryTaskCompletedAsync(RespondQueryTaskCompletedRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    RespondQueryTaskCompletedRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<RespondQueryTaskCompletedResponse>

    RPC response

    RespondWorkflowTaskCompletedAsync(RespondWorkflowTaskCompletedRequest, RpcOptions)

    Invoke RespondWorkflowTaskCompleted.

    Declaration
    public Task<RespondWorkflowTaskCompletedResponse> RespondWorkflowTaskCompletedAsync(RespondWorkflowTaskCompletedRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    RespondWorkflowTaskCompletedRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<RespondWorkflowTaskCompletedResponse>

    RPC response

    RespondWorkflowTaskFailedAsync(RespondWorkflowTaskFailedRequest, RpcOptions)

    Invoke RespondWorkflowTaskFailed.

    Declaration
    public Task<RespondWorkflowTaskFailedResponse> RespondWorkflowTaskFailedAsync(RespondWorkflowTaskFailedRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    RespondWorkflowTaskFailedRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<RespondWorkflowTaskFailedResponse>

    RPC response

    ScanWorkflowExecutionsAsync(ScanWorkflowExecutionsRequest, RpcOptions)

    Invoke ScanWorkflowExecutions.

    Declaration
    public Task<ScanWorkflowExecutionsResponse> ScanWorkflowExecutionsAsync(ScanWorkflowExecutionsRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    ScanWorkflowExecutionsRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<ScanWorkflowExecutionsResponse>

    RPC response

    SignalWithStartWorkflowExecutionAsync(SignalWithStartWorkflowExecutionRequest, RpcOptions)

    Invoke SignalWithStartWorkflowExecution.

    Declaration
    public Task<SignalWithStartWorkflowExecutionResponse> SignalWithStartWorkflowExecutionAsync(SignalWithStartWorkflowExecutionRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    SignalWithStartWorkflowExecutionRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<SignalWithStartWorkflowExecutionResponse>

    RPC response

    SignalWorkflowExecutionAsync(SignalWorkflowExecutionRequest, RpcOptions)

    Invoke SignalWorkflowExecution.

    Declaration
    public Task<SignalWorkflowExecutionResponse> SignalWorkflowExecutionAsync(SignalWorkflowExecutionRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    SignalWorkflowExecutionRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<SignalWorkflowExecutionResponse>

    RPC response

    StartBatchOperationAsync(StartBatchOperationRequest, RpcOptions)

    Invoke StartBatchOperation.

    Declaration
    public Task<StartBatchOperationResponse> StartBatchOperationAsync(StartBatchOperationRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    StartBatchOperationRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<StartBatchOperationResponse>

    RPC response

    StartWorkflowExecutionAsync(StartWorkflowExecutionRequest, RpcOptions)

    Invoke StartWorkflowExecution.

    Declaration
    public Task<StartWorkflowExecutionResponse> StartWorkflowExecutionAsync(StartWorkflowExecutionRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    StartWorkflowExecutionRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<StartWorkflowExecutionResponse>

    RPC response

    StopBatchOperationAsync(StopBatchOperationRequest, RpcOptions)

    Invoke StopBatchOperation.

    Declaration
    public Task<StopBatchOperationResponse> StopBatchOperationAsync(StopBatchOperationRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    StopBatchOperationRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<StopBatchOperationResponse>

    RPC response

    TerminateWorkflowExecutionAsync(TerminateWorkflowExecutionRequest, RpcOptions)

    Invoke TerminateWorkflowExecution.

    Declaration
    public Task<TerminateWorkflowExecutionResponse> TerminateWorkflowExecutionAsync(TerminateWorkflowExecutionRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    TerminateWorkflowExecutionRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<TerminateWorkflowExecutionResponse>

    RPC response

    UpdateNamespaceAsync(UpdateNamespaceRequest, RpcOptions)

    Invoke UpdateNamespace.

    Declaration
    public Task<UpdateNamespaceResponse> UpdateNamespaceAsync(UpdateNamespaceRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    UpdateNamespaceRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<UpdateNamespaceResponse>

    RPC response

    UpdateScheduleAsync(UpdateScheduleRequest, RpcOptions)

    Invoke UpdateSchedule.

    Declaration
    public Task<UpdateScheduleResponse> UpdateScheduleAsync(UpdateScheduleRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    UpdateScheduleRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<UpdateScheduleResponse>

    RPC response

    UpdateWorkerBuildIdOrderingAsync(UpdateWorkerBuildIdOrderingRequest, RpcOptions)

    Invoke UpdateWorkerBuildIdOrdering.

    Declaration
    public Task<UpdateWorkerBuildIdOrderingResponse> UpdateWorkerBuildIdOrderingAsync(UpdateWorkerBuildIdOrderingRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    UpdateWorkerBuildIdOrderingRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<UpdateWorkerBuildIdOrderingResponse>

    RPC response

    UpdateWorkflowAsync(UpdateWorkflowRequest, RpcOptions)

    Invoke UpdateWorkflow.

    Declaration
    public Task<UpdateWorkflowResponse> UpdateWorkflowAsync(UpdateWorkflowRequest req, RpcOptions options = null)
    Parameters
    Type Name Description
    UpdateWorkflowRequest req

    Request for the call.

    RpcOptions options

    Optional RPC options.

    Returns
    Type Description
    Task<UpdateWorkflowResponse>

    RPC response

    In This Article
    Back to top