java.lang.Object
- com.uber.cadence.serviceclient.IWorkflowServiceBase

All Implemented Interfaces:

IWorkflowService, WorkflowService.AsyncIface, WorkflowService.Iface

Direct Known Subclasses:

MigrationIWorkflowService
```
public class IWorkflowServiceBase
extends java.lang.Object
implements IWorkflowService
```

Constructor Summary

Constructors
Constructor Description

IWorkflowServiceBase()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`close()`
`CountWorkflowExecutionsResponse`	`CountWorkflowExecutions(CountWorkflowExecutionsRequest countRequest)`	CountWorkflowExecutions is a visibility API to count of workflow executions in a specific domain.
`void`	`CountWorkflowExecutions(CountWorkflowExecutionsRequest countRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`DeprecateDomain(DeprecateDomainRequest deprecateRequest)`	DeprecateDomain us used to update status of a registered domain to DEPRECATED.
`void`	`DeprecateDomain(DeprecateDomainRequest deprecateRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`DescribeDomainResponse`	`DescribeDomain(DescribeDomainRequest describeRequest)`	DescribeDomain returns the information and configuration for a registered domain.
`void`	`DescribeDomain(DescribeDomainRequest describeRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`DescribeTaskListResponse`	`DescribeTaskList(DescribeTaskListRequest request)`	DescribeTaskList returns information about the target tasklist, right now this API returns the pollers which polled this tasklist in last few minutes.
`void`	`DescribeTaskList(DescribeTaskListRequest request, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`DescribeWorkflowExecutionResponse`	`DescribeWorkflowExecution(DescribeWorkflowExecutionRequest describeRequest)`	DescribeWorkflowExecution returns information about the specified workflow execution.
`void`	`DescribeWorkflowExecution(DescribeWorkflowExecutionRequest describeRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`ClusterInfo`	`GetClusterInfo()`	GetClusterInfo returns information about cadence cluster
`void`	`GetClusterInfo(org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`ClientOptions`	`getOptions()`
`GetSearchAttributesResponse`	`GetSearchAttributes()`	GetSearchAttributes is a visibility API to get all legal keys that could be used in list APIs
`void`	`GetSearchAttributes(org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`GetTaskListsByDomainResponse`	`GetTaskListsByDomain(GetTaskListsByDomainRequest request)`	GetTaskListsByDomain returns the list of all the task lists for a domainName.
`void`	`GetTaskListsByDomain(GetTaskListsByDomainRequest request, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`GetWorkflowExecutionHistoryResponse`	`GetWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getRequest)`	Returns the history of specified workflow execution.
`void`	`GetWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`GetWorkflowExecutionHistoryResponse`	`GetWorkflowExecutionHistoryWithTimeout(GetWorkflowExecutionHistoryRequest getRequest, java.lang.Long timeoutInMillis)`	GetWorkflowExecutionHistoryWithTimeout get workflow history same as GetWorkflowExecutionHistory but with timeout.
`void`	`GetWorkflowExecutionHistoryWithTimeout(GetWorkflowExecutionHistoryRequest getRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler, java.lang.Long timeoutInMillis)`	GetWorkflowExecutionHistoryWithTimeout get workflow history asynchronously same as GetWorkflowExecutionHistory but with timeout.
`java.util.concurrent.CompletableFuture<java.lang.Boolean>`	`isHealthy()`	Checks if we have a valid connection to the Cadence cluster, and potentially resets the peer list
`ListArchivedWorkflowExecutionsResponse`	`ListArchivedWorkflowExecutions(ListArchivedWorkflowExecutionsRequest listRequest)`	ListArchivedWorkflowExecutions is a visibility API to list archived workflow executions in a specific domain.
`void`	`ListArchivedWorkflowExecutions(ListArchivedWorkflowExecutionsRequest listRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`ListClosedWorkflowExecutionsResponse`	`ListClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listRequest)`	ListClosedWorkflowExecutions is a visibility API to list the closed executions in a specific domain.
`void`	`ListClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`ListDomainsResponse`	`ListDomains(ListDomainsRequest listRequest)`	ListDomains returns the information and configuration for all domains.
`void`	`ListDomains(ListDomainsRequest listRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`ListOpenWorkflowExecutionsResponse`	`ListOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listRequest)`	ListOpenWorkflowExecutions is a visibility API to list the open executions in a specific domain.
`void`	`ListOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`ListTaskListPartitionsResponse`	`ListTaskListPartitions(ListTaskListPartitionsRequest request)`	ReapplyEvents applies stale events to the current workflow and current run
`void`	`ListTaskListPartitions(ListTaskListPartitionsRequest request, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`ListWorkflowExecutionsResponse`	`ListWorkflowExecutions(ListWorkflowExecutionsRequest listRequest)`	ListWorkflowExecutions is a visibility API to list workflow executions in a specific domain.
`void`	`ListWorkflowExecutions(ListWorkflowExecutionsRequest listRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`PollForActivityTaskResponse`	`PollForActivityTask(PollForActivityTaskRequest pollRequest)`	PollForActivityTask is called by application worker to process ActivityTask from a specific taskList.
`void`	`PollForActivityTask(PollForActivityTaskRequest pollRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`PollForDecisionTaskResponse`	`PollForDecisionTask(PollForDecisionTaskRequest pollRequest)`	PollForDecisionTask is called by application worker to process DecisionTask from a specific taskList.
`void`	`PollForDecisionTask(PollForDecisionTaskRequest pollRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`QueryWorkflowResponse`	`QueryWorkflow(QueryWorkflowRequest queryRequest)`	QueryWorkflow returns query result for a specified workflow execution
`void`	`QueryWorkflow(QueryWorkflowRequest queryRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`RecordActivityTaskHeartbeatResponse`	`RecordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest heartbeatRequest)`	RecordActivityTaskHeartbeat is called by application worker while it is processing an ActivityTask.
`void`	`RecordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest heartbeatRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`RecordActivityTaskHeartbeatResponse`	`RecordActivityTaskHeartbeatByID(RecordActivityTaskHeartbeatByIDRequest heartbeatRequest)`	RecordActivityTaskHeartbeatByID is called by application worker while it is processing an ActivityTask.
`void`	`RecordActivityTaskHeartbeatByID(RecordActivityTaskHeartbeatByIDRequest heartbeatRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`RefreshWorkflowTasks(RefreshWorkflowTasksRequest request)`	RefreshWorkflowTasks refreshes all tasks of a workflow
`void`	`RefreshWorkflowTasks(RefreshWorkflowTasksRequest request, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`RegisterDomain(RegisterDomainRequest registerRequest)`	RegisterDomain creates a new domain which can be used as a container for all resources.
`void`	`RegisterDomain(RegisterDomainRequest registerRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`RequestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest cancelRequest)`	RequestCancelWorkflowExecution is called by application worker when it wants to request cancellation of a workflow instance.
`void`	`RequestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest cancelRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`ResetStickyTaskListResponse`	`ResetStickyTaskList(ResetStickyTaskListRequest resetRequest)`	Reset the sticky tasklist related information in mutable state of a given workflow.
`void`	`ResetStickyTaskList(ResetStickyTaskListRequest resetRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`ResetWorkflowExecutionResponse`	`ResetWorkflowExecution(ResetWorkflowExecutionRequest resetRequest)`	ResetWorkflowExecution reset an existing workflow execution to DecisionTaskCompleted event(exclusive).
`void`	`ResetWorkflowExecution(ResetWorkflowExecutionRequest resetRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`RespondActivityTaskCanceled(RespondActivityTaskCanceledRequest canceledRequest)`	RespondActivityTaskCanceled is called by application worker when it is successfully canceled an ActivityTask.
`void`	`RespondActivityTaskCanceled(RespondActivityTaskCanceledRequest canceledRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`RespondActivityTaskCanceledByID(RespondActivityTaskCanceledByIDRequest canceledRequest)`	RespondActivityTaskCanceledByID is called by application worker when it is successfully canceled an ActivityTask.
`void`	`RespondActivityTaskCanceledByID(RespondActivityTaskCanceledByIDRequest canceledRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`RespondActivityTaskCompleted(RespondActivityTaskCompletedRequest completeRequest)`	RespondActivityTaskCompleted is called by application worker when it is done processing an ActivityTask.
`void`	`RespondActivityTaskCompleted(RespondActivityTaskCompletedRequest completeRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`RespondActivityTaskCompletedByID(RespondActivityTaskCompletedByIDRequest completeRequest)`	RespondActivityTaskCompletedByID is called by application worker when it is done processing an ActivityTask.
`void`	`RespondActivityTaskCompletedByID(RespondActivityTaskCompletedByIDRequest completeRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`RespondActivityTaskFailed(RespondActivityTaskFailedRequest failRequest)`	RespondActivityTaskFailed is called by application worker when it is done processing an ActivityTask.
`void`	`RespondActivityTaskFailed(RespondActivityTaskFailedRequest failRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`RespondActivityTaskFailedByID(RespondActivityTaskFailedByIDRequest failRequest)`	RespondActivityTaskFailedByID is called by application worker when it is done processing an ActivityTask.
`void`	`RespondActivityTaskFailedByID(RespondActivityTaskFailedByIDRequest failRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`RespondDecisionTaskCompletedResponse`	`RespondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest completeRequest)`	RespondDecisionTaskCompleted is called by application worker to complete a DecisionTask handed as a result of 'PollForDecisionTask' API call.
`void`	`RespondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest completeRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`RespondDecisionTaskFailed(RespondDecisionTaskFailedRequest failedRequest)`	RespondDecisionTaskFailed is called by application worker to indicate failure.
`void`	`RespondDecisionTaskFailed(RespondDecisionTaskFailedRequest failedRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`RespondQueryTaskCompleted(RespondQueryTaskCompletedRequest completeRequest)`	RespondQueryTaskCompleted is called by application worker to complete a QueryTask (which is a DecisionTask for query) as a result of 'PollForDecisionTask' API call.
`void`	`RespondQueryTaskCompleted(RespondQueryTaskCompletedRequest completeRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`RestartWorkflowExecutionResponse`	`RestartWorkflowExecution(RestartWorkflowExecutionRequest restartRequest)`	RestartWorkflowExecution restarts a previous workflow If the workflow is currently running it will terminate and restart
`void`	`RestartWorkflowExecution(RestartWorkflowExecutionRequest restartRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`ListWorkflowExecutionsResponse`	`ScanWorkflowExecutions(ListWorkflowExecutionsRequest listRequest)`	ScanWorkflowExecutions is a visibility API to list large amount of workflow executions in a specific domain without order.
`void`	`ScanWorkflowExecutions(ListWorkflowExecutionsRequest listRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`StartWorkflowExecutionResponse`	`SignalWithStartWorkflowExecution(SignalWithStartWorkflowExecutionRequest signalWithStartRequest)`	SignalWithStartWorkflowExecution is used to ensure sending signal to a workflow.
`void`	`SignalWithStartWorkflowExecution(SignalWithStartWorkflowExecutionRequest signalWithStartRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`SignalWithStartWorkflowExecutionAsyncResponse`	`SignalWithStartWorkflowExecutionAsync(SignalWithStartWorkflowExecutionAsyncRequest signalWithStartRequest)`	SignalWithStartWorkflowExecutionAsync is used to ensure sending signal to a workflow asynchronously.
`void`	`SignalWithStartWorkflowExecutionAsync(SignalWithStartWorkflowExecutionAsyncRequest signalWithStartRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`SignalWorkflowExecution(SignalWorkflowExecutionRequest signalRequest)`	SignalWorkflowExecution is used to send a signal event to running workflow execution.
`void`	`SignalWorkflowExecution(SignalWorkflowExecutionRequest signalRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`SignalWorkflowExecutionWithTimeout(SignalWorkflowExecutionRequest signalRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler, java.lang.Long timeoutInMillis)`	SignalWorkflowExecutionWithTimeout signal workflow same as SignalWorkflowExecution but with timeout
`StartWorkflowExecutionResponse`	`StartWorkflowExecution(StartWorkflowExecutionRequest startRequest)`	StartWorkflowExecution starts a new long running workflow instance.
`void`	`StartWorkflowExecution(StartWorkflowExecutionRequest startRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`StartWorkflowExecutionAsyncResponse`	`StartWorkflowExecutionAsync(StartWorkflowExecutionAsyncRequest startRequest)`	StartWorkflowExecutionAsync starts a new long running workflow instance asynchronously.
`void`	`StartWorkflowExecutionAsync(StartWorkflowExecutionAsyncRequest startRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`void`	`StartWorkflowExecutionAsyncWithTimeout(StartWorkflowExecutionAsyncRequest startAsyncRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler, java.lang.Long timeoutInMillis)`	StartWorkflowExecutionAsyncWithTimeout start workflow same as StartWorkflowExecutionAsync but with timeout
`void`	`StartWorkflowExecutionWithTimeout(StartWorkflowExecutionRequest startRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler, java.lang.Long timeoutInMillis)`	StartWorkflowExecutionWithTimeout start workflow same as StartWorkflowExecution but with timeout
`void`	`TerminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateRequest)`	TerminateWorkflowExecution terminates an existing workflow execution by recording WorkflowExecutionTerminated event in the history and immediately terminating the execution instance.
`void`	`TerminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`
`UpdateDomainResponse`	`UpdateDomain(UpdateDomainRequest updateRequest)`	UpdateDomain is used to update the information and configuration for a registered domain.
`void`	`UpdateDomain(UpdateDomainRequest updateRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- IWorkflowServiceBase
```
public IWorkflowServiceBase()
```

Method Detail

getOptions
```
public ClientOptions getOptions()
```
Specified by:

getOptions in interface IWorkflowService

RegisterDomain
```
public void RegisterDomain(RegisterDomainRequest registerRequest)
                    throws BadRequestError,
                           DomainAlreadyExistsError,
                           ServiceBusyError,
                           ClientVersionNotSupportedError,
                           org.apache.thrift.TException
```
Description copied from interface: WorkflowService.Iface

RegisterDomain creates a new domain which can be used as a container for all resources. Domain is a top level entity within Cadence, used as a container for all resources like workflow executions, tasklists, etc. Domain acts as a sandbox and provides isolation for all resources within the domain. All resources belongs to exactly one domain.

Specified by:

RegisterDomain in interface WorkflowService.Iface

Throws:

BadRequestError

DomainAlreadyExistsError

ServiceBusyError

ClientVersionNotSupportedError

org.apache.thrift.TException