com.uber.cadence.serviceclient

Class WorkflowServiceTChannel

java.lang.Object

com.uber.cadence.serviceclient.WorkflowServiceTChannel

All Implemented Interfaces:

IWorkflowService, WorkflowService.AsyncIface, WorkflowService.Iface

public class WorkflowServiceTChannel
extends java.lang.Object
implements IWorkflowService

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorkflowServiceTChannel.ClientOptions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CLIENT_APP_NAME
static int	DEFAULT_LOCAL_CADENCE_SERVER_PORT
static java.lang.String	DEFAULT_SERVICE_NAME Name of the Cadence service front end as required by TChannel.

Constructor Summary

Constructors

Constructor and Description
WorkflowServiceTChannel() Creates Cadence client that connects to the local instance of the Cadence Service that listens on a default port (7933).
WorkflowServiceTChannel(java.lang.String host, int port) Creates Cadence client that connects to the specified host and port using default options.
WorkflowServiceTChannel(java.lang.String host, int port, WorkflowServiceTChannel.ClientOptions options) Creates Cadence client that connects to the specified host and port using specified options.
WorkflowServiceTChannel(com.uber.tchannel.api.SubChannel subChannel, WorkflowServiceTChannel.ClientOptions options) Creates Cadence client with specified sub channel and options.

Method Summary

Modifier and Type	Method and Description
void	close()
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 request) DescribeWorkflowExecution returns information about the specified workflow execution.
void	DescribeWorkflowExecution(DescribeWorkflowExecutionRequest describeRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)
GetWorkflowExecutionHistoryResponse	GetWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest request) Returns the history of specified workflow execution.
void	GetWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)
ListClosedWorkflowExecutionsResponse	ListClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest request) 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 request) ListOpenWorkflowExecutions is a visibility API to list the open executions in a specific domain.
void	ListOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)
PollForActivityTaskResponse	PollForActivityTask(PollForActivityTaskRequest request) 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 request) 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 request) QueryWorkflow returns query result for a specified workflow execution
void	QueryWorkflow(QueryWorkflowRequest queryRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)
RecordActivityTaskHeartbeatResponse	RecordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest request) 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	RegisterDomain(RegisterDomainRequest request) 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 request) 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)
void	RespondActivityTaskCanceled(RespondActivityTaskCanceledRequest request) 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 request) 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 request) 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 request) 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 request) 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 request) 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 completedRequest) 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 request) RespondDecisionTaskFailed is called by application worker to indicate failure.
void	RespondDecisionTaskFailed(RespondDecisionTaskFailedRequest failedRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)
void	RespondQueryTaskCompleted(RespondQueryTaskCompletedRequest request) 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)
StartWorkflowExecutionResponse	SignalWithStartWorkflowExecution(SignalWithStartWorkflowExecutionRequest signalWithStartRequest) SignalWithStartWorkflowExecution is used to ensure sending signal to a workflow.
void	SignalWithStartWorkflowExecution(SignalWithStartWorkflowExecutionRequest signalWithStartRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)
void	SignalWorkflowExecution(SignalWorkflowExecutionRequest request) SignalWorkflowExecution is used to send a signal event to running workflow execution.
void	SignalWorkflowExecution(SignalWorkflowExecutionRequest signalRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)
StartWorkflowExecutionResponse	StartWorkflowExecution(StartWorkflowExecutionRequest request) StartWorkflowExecution starts a new long running workflow instance.
void	StartWorkflowExecution(StartWorkflowExecutionRequest startRequest, org.apache.thrift.async.AsyncMethodCallback resultHandler)
void	TerminateWorkflowExecution(TerminateWorkflowExecutionRequest request) 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

Field Detail

DEFAULT_LOCAL_CADENCE_SERVER_PORT

public static final int DEFAULT_LOCAL_CADENCE_SERVER_PORT

See Also:

Constant Field Values

DEFAULT_CLIENT_APP_NAME

public static final java.lang.String DEFAULT_CLIENT_APP_NAME

See Also:

Constant Field Values

DEFAULT_SERVICE_NAME

public static final java.lang.String DEFAULT_SERVICE_NAME

Name of the Cadence service front end as required by TChannel.

See Also:

Constant Field Values

Constructor Detail

WorkflowServiceTChannel

public WorkflowServiceTChannel()

Creates Cadence client that connects to the local instance of the Cadence Service that listens on a default port (7933).

WorkflowServiceTChannel

public WorkflowServiceTChannel(java.lang.String host,
                               int port)

Creates Cadence client that connects to the specified host and port using default options.

Parameters:

host - host to connect

port - port to connect

WorkflowServiceTChannel

public WorkflowServiceTChannel(java.lang.String host,
                               int port,
                               WorkflowServiceTChannel.ClientOptions options)

Creates Cadence client that connects to the specified host and port using specified options.

Parameters:

host - host to connect

port - port to connect

options - configuration options like rpc timeouts.

WorkflowServiceTChannel

public WorkflowServiceTChannel(com.uber.tchannel.api.SubChannel subChannel,
                               WorkflowServiceTChannel.ClientOptions options)

Creates Cadence client with specified sub channel and options.

Parameters:

subChannel - sub channel for communicating with cadence frontend service.

options - configuration options like rpc timeouts.

Method Detail

close

public void close()

Specified by:

close in interface IWorkflowService

RegisterDomain

public void RegisterDomain(RegisterDomainRequest request)
                    throws 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:

org.apache.thrift.TException

DescribeDomain

public DescribeDomainResponse DescribeDomain(DescribeDomainRequest describeRequest)
                                      throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

DescribeDomain returns the information and configuration for a registered domain.

Specified by:

DescribeDomain in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

ListDomains

public ListDomainsResponse ListDomains(ListDomainsRequest listRequest)
                                throws BadRequestError,
                                       InternalServiceError,
                                       EntityNotExistsError,
                                       ServiceBusyError,
                                       org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

ListDomains returns the information and configuration for all domains.

Specified by:

ListDomains in interface WorkflowService.Iface

Throws:

BadRequestError

InternalServiceError

EntityNotExistsError

ServiceBusyError

org.apache.thrift.TException

UpdateDomain

public UpdateDomainResponse UpdateDomain(UpdateDomainRequest updateRequest)
                                  throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

UpdateDomain is used to update the information and configuration for a registered domain.

Specified by:

UpdateDomain in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

DeprecateDomain

public void DeprecateDomain(DeprecateDomainRequest deprecateRequest)
                     throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

DeprecateDomain us used to update status of a registered domain to DEPRECATED. Once the domain is deprecated it cannot be used to start new workflow executions. Existing workflow executions will continue to run on deprecated domains.

Specified by:

DeprecateDomain in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

StartWorkflowExecution

public StartWorkflowExecutionResponse StartWorkflowExecution(StartWorkflowExecutionRequest request)
                                                      throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

StartWorkflowExecution starts a new long running workflow instance. It will create the instance with 'WorkflowExecutionStarted' event in history and also schedule the first DecisionTask for the worker to make the first decision for this instance. It will return 'WorkflowExecutionAlreadyStartedError', if an instance already exists with same workflowId.

Specified by:

StartWorkflowExecution in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

GetWorkflowExecutionHistory

public GetWorkflowExecutionHistoryResponse GetWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest request)
                                                                throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

Returns the history of specified workflow execution. It fails with 'EntityNotExistError' if speficied workflow execution in unknown to the service.

Specified by:

GetWorkflowExecutionHistory in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

PollForDecisionTask

public PollForDecisionTaskResponse PollForDecisionTask(PollForDecisionTaskRequest request)
                                                throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

PollForDecisionTask is called by application worker to process DecisionTask from a specific taskList. A DecisionTask is dispatched to callers for active workflow executions, with pending decisions. Application is then expected to call 'RespondDecisionTaskCompleted' API when it is done processing the DecisionTask. It will also create a 'DecisionTaskStarted' event in the history for that session before handing off DecisionTask to application worker.

Specified by:

PollForDecisionTask in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

RespondDecisionTaskCompleted

public RespondDecisionTaskCompletedResponse RespondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest completedRequest)
                                                                  throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

RespondDecisionTaskCompleted is called by application worker to complete a DecisionTask handed as a result of 'PollForDecisionTask' API call. Completing a DecisionTask will result in new events for the workflow execution and potentially new ActivityTask being created for corresponding decisions. It will also create a DecisionTaskCompleted event in the history for that session. Use the 'taskToken' provided as response of PollForDecisionTask API call for completing the DecisionTask. The response could contain a new decision task if there is one or if the request asking for one.

Specified by:

RespondDecisionTaskCompleted in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

RespondDecisionTaskFailed

public void RespondDecisionTaskFailed(RespondDecisionTaskFailedRequest request)
                               throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

RespondDecisionTaskFailed is called by application worker to indicate failure. This results in DecisionTaskFailedEvent written to the history and a new DecisionTask created. This API can be used by client to either clear sticky tasklist or report any panics during DecisionTask processing. Cadence will only append first DecisionTaskFailed event to the history of workflow execution for consecutive failures.

Specified by:

RespondDecisionTaskFailed in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

PollForActivityTask

public PollForActivityTaskResponse PollForActivityTask(PollForActivityTaskRequest request)
                                                throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

PollForActivityTask is called by application worker to process ActivityTask from a specific taskList. ActivityTask is dispatched to callers whenever a ScheduleTask decision is made for a workflow execution. Application is expected to call 'RespondActivityTaskCompleted' or 'RespondActivityTaskFailed' once it is done processing the task. Application also needs to call 'RecordActivityTaskHeartbeat' API within 'heartbeatTimeoutSeconds' interval to prevent the task from getting timed out. An event 'ActivityTaskStarted' event is also written to workflow execution history before the ActivityTask is dispatched to application worker.

Specified by:

PollForActivityTask in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

RecordActivityTaskHeartbeat

public RecordActivityTaskHeartbeatResponse RecordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest request)
                                                                throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

RecordActivityTaskHeartbeat is called by application worker while it is processing an ActivityTask. If worker fails to heartbeat within 'heartbeatTimeoutSeconds' interval for the ActivityTask, then it will be marked as timedout and 'ActivityTaskTimedOut' event will be written to the workflow history. Calling 'RecordActivityTaskHeartbeat' will fail with 'EntityNotExistsError' in such situations. Use the 'taskToken' provided as response of PollForActivityTask API call for heartbeating.

Specified by:

RecordActivityTaskHeartbeat in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

RecordActivityTaskHeartbeatByID

public RecordActivityTaskHeartbeatResponse RecordActivityTaskHeartbeatByID(RecordActivityTaskHeartbeatByIDRequest heartbeatRequest)
                                                                    throws BadRequestError,
                                                                           InternalServiceError,
                                                                           EntityNotExistsError,
                                                                           DomainNotActiveError,
                                                                           LimitExceededError,
                                                                           ServiceBusyError,
                                                                           org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

RecordActivityTaskHeartbeatByID is called by application worker while it is processing an ActivityTask. If worker fails to heartbeat within 'heartbeatTimeoutSeconds' interval for the ActivityTask, then it will be marked as timedout and 'ActivityTaskTimedOut' event will be written to the workflow history. Calling 'RecordActivityTaskHeartbeatByID' will fail with 'EntityNotExistsError' in such situations. Instead of using 'taskToken' like in RecordActivityTaskHeartbeat, use Domain, WorkflowID and ActivityID

Specified by:

RecordActivityTaskHeartbeatByID in interface WorkflowService.Iface

Throws:

BadRequestError

InternalServiceError

EntityNotExistsError

DomainNotActiveError

LimitExceededError

ServiceBusyError

org.apache.thrift.TException

RespondActivityTaskCompleted

public void RespondActivityTaskCompleted(RespondActivityTaskCompletedRequest request)
                                  throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

RespondActivityTaskCompleted is called by application worker when it is done processing an ActivityTask. It will result in a new 'ActivityTaskCompleted' event being written to the workflow history and a new DecisionTask created for the workflow so new decisions could be made. Use the 'taskToken' provided as response of PollForActivityTask API call for completion. It fails with 'EntityNotExistsError' if the taskToken is not valid anymore due to activity timeout.

Specified by:

RespondActivityTaskCompleted in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

RespondActivityTaskCompletedByID

public void RespondActivityTaskCompletedByID(RespondActivityTaskCompletedByIDRequest request)
                                      throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

RespondActivityTaskCompletedByID is called by application worker when it is done processing an ActivityTask. It will result in a new 'ActivityTaskCompleted' event being written to the workflow history and a new DecisionTask created for the workflow so new decisions could be made. Similar to RespondActivityTaskCompleted but use Domain, WorkflowID and ActivityID instead of 'taskToken' for completion. It fails with 'EntityNotExistsError' if the these IDs are not valid anymore due to activity timeout.

Specified by:

RespondActivityTaskCompletedByID in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

RespondActivityTaskFailed

public void RespondActivityTaskFailed(RespondActivityTaskFailedRequest request)
                               throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

RespondActivityTaskFailed is called by application worker when it is done processing an ActivityTask. It will result in a new 'ActivityTaskFailed' event being written to the workflow history and a new DecisionTask created for the workflow instance so new decisions could be made. Use the 'taskToken' provided as response of PollForActivityTask API call for completion. It fails with 'EntityNotExistsError' if the taskToken is not valid anymore due to activity timeout.

Specified by:

RespondActivityTaskFailed in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

RespondActivityTaskFailedByID

public void RespondActivityTaskFailedByID(RespondActivityTaskFailedByIDRequest request)
                                   throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

RespondActivityTaskFailedByID is called by application worker when it is done processing an ActivityTask. It will result in a new 'ActivityTaskFailed' event being written to the workflow history and a new DecisionTask created for the workflow instance so new decisions could be made. Similar to RespondActivityTaskFailed but use Domain, WorkflowID and ActivityID instead of 'taskToken' for completion. It fails with 'EntityNotExistsError' if the these IDs are not valid anymore due to activity timeout.

Specified by:

RespondActivityTaskFailedByID in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

RespondActivityTaskCanceled

public void RespondActivityTaskCanceled(RespondActivityTaskCanceledRequest request)
                                 throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

RespondActivityTaskCanceled is called by application worker when it is successfully canceled an ActivityTask. It will result in a new 'ActivityTaskCanceled' event being written to the workflow history and a new DecisionTask created for the workflow instance so new decisions could be made. Use the 'taskToken' provided as response of PollForActivityTask API call for completion. It fails with 'EntityNotExistsError' if the taskToken is not valid anymore due to activity timeout.

Specified by:

RespondActivityTaskCanceled in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

RespondActivityTaskCanceledByID

public void RespondActivityTaskCanceledByID(RespondActivityTaskCanceledByIDRequest request)
                                     throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

RespondActivityTaskCanceledByID is called by application worker when it is successfully canceled an ActivityTask. It will result in a new 'ActivityTaskCanceled' event being written to the workflow history and a new DecisionTask created for the workflow instance so new decisions could be made. Similar to RespondActivityTaskCanceled but use Domain, WorkflowID and ActivityID instead of 'taskToken' for completion. It fails with 'EntityNotExistsError' if the these IDs are not valid anymore due to activity timeout.

Specified by:

RespondActivityTaskCanceledByID in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

RequestCancelWorkflowExecution

public void RequestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest request)
                                    throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

RequestCancelWorkflowExecution is called by application worker when it wants to request cancellation of a workflow instance. It will result in a new 'WorkflowExecutionCancelRequested' event being written to the workflow history and a new DecisionTask created for the workflow instance so new decisions could be made. It fails with 'EntityNotExistsError' if the workflow is not valid anymore due to completion or doesn't exist.

Specified by:

RequestCancelWorkflowExecution in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

SignalWorkflowExecution

public void SignalWorkflowExecution(SignalWorkflowExecutionRequest request)
                             throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

SignalWorkflowExecution is used to send a signal event to running workflow execution. This results in WorkflowExecutionSignaled event recorded in the history and a decision task being created for the execution.

Specified by:

SignalWorkflowExecution in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

SignalWithStartWorkflowExecution

public StartWorkflowExecutionResponse SignalWithStartWorkflowExecution(SignalWithStartWorkflowExecutionRequest signalWithStartRequest)
                                                                throws BadRequestError,
                                                                       InternalServiceError,
                                                                       EntityNotExistsError,
                                                                       ServiceBusyError,
                                                                       DomainNotActiveError,
                                                                       LimitExceededError,
                                                                       WorkflowExecutionAlreadyStartedError,
                                                                       org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

SignalWithStartWorkflowExecution is used to ensure sending signal to a workflow. If the workflow is running, this results in WorkflowExecutionSignaled event being recorded in the history and a decision task being created for the execution. If the workflow is not running or not found, this results in WorkflowExecutionStarted and WorkflowExecutionSignaled events being recorded in history, and a decision task being created for the execution

Specified by:

SignalWithStartWorkflowExecution in interface WorkflowService.Iface

Throws:

BadRequestError

InternalServiceError

EntityNotExistsError

ServiceBusyError

DomainNotActiveError

LimitExceededError

WorkflowExecutionAlreadyStartedError

org.apache.thrift.TException

TerminateWorkflowExecution

public void TerminateWorkflowExecution(TerminateWorkflowExecutionRequest request)
                                throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

TerminateWorkflowExecution terminates an existing workflow execution by recording WorkflowExecutionTerminated event in the history and immediately terminating the execution instance.

Specified by:

TerminateWorkflowExecution in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

ListOpenWorkflowExecutions

public ListOpenWorkflowExecutionsResponse ListOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest request)
                                                              throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

ListOpenWorkflowExecutions is a visibility API to list the open executions in a specific domain.

Specified by:

ListOpenWorkflowExecutions in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

ListClosedWorkflowExecutions

public ListClosedWorkflowExecutionsResponse ListClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest request)
                                                                  throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

ListClosedWorkflowExecutions is a visibility API to list the closed executions in a specific domain.

Specified by:

ListClosedWorkflowExecutions in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

RespondQueryTaskCompleted

public void RespondQueryTaskCompleted(RespondQueryTaskCompletedRequest request)
                               throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

RespondQueryTaskCompleted is called by application worker to complete a QueryTask (which is a DecisionTask for query) as a result of 'PollForDecisionTask' API call. Completing a QueryTask will unblock the client call to 'QueryWorkflow' API and return the query result to client as a response to 'QueryWorkflow' API call.

Specified by:

RespondQueryTaskCompleted in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

QueryWorkflow

public QueryWorkflowResponse QueryWorkflow(QueryWorkflowRequest request)
                                    throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

QueryWorkflow returns query result for a specified workflow execution

Specified by:

QueryWorkflow in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

ResetStickyTaskList

public ResetStickyTaskListResponse ResetStickyTaskList(ResetStickyTaskListRequest resetRequest)
                                                throws BadRequestError,
                                                       InternalServiceError,
                                                       EntityNotExistsError,
                                                       LimitExceededError,
                                                       ServiceBusyError,
                                                       DomainNotActiveError,
                                                       org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

Reset the sticky tasklist related information in mutable state of a given workflow. Things cleared are: 1. StickyTaskList 2. StickyScheduleToStartTimeout 3. ClientLibraryVersion 4. ClientFeatureVersion 5. ClientImpl

Specified by:

ResetStickyTaskList in interface WorkflowService.Iface

Throws:

BadRequestError

InternalServiceError

EntityNotExistsError

LimitExceededError

ServiceBusyError

DomainNotActiveError

org.apache.thrift.TException

DescribeWorkflowExecution

public DescribeWorkflowExecutionResponse DescribeWorkflowExecution(DescribeWorkflowExecutionRequest request)
                                                            throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

DescribeWorkflowExecution returns information about the specified workflow execution.

Specified by:

DescribeWorkflowExecution in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

DescribeTaskList

public DescribeTaskListResponse DescribeTaskList(DescribeTaskListRequest request)
                                          throws org.apache.thrift.TException

Description copied from interface: WorkflowService.Iface

DescribeTaskList returns information about the target tasklist, right now this API returns the pollers which polled this tasklist in last few minutes.

Specified by:

DescribeTaskList in interface WorkflowService.Iface

Throws:

org.apache.thrift.TException

StartWorkflowExecution

public void StartWorkflowExecution(StartWorkflowExecutionRequest startRequest,
                                   org.apache.thrift.async.AsyncMethodCallback resultHandler)
                            throws org.apache.thrift.TException

Specified by:

StartWorkflowExecution in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

GetWorkflowExecutionHistory

public void GetWorkflowExecutionHistory(GetWorkflowExecutionHistoryRequest getRequest,
                                        org.apache.thrift.async.AsyncMethodCallback resultHandler)

Specified by:

GetWorkflowExecutionHistory in interface WorkflowService.AsyncIface

PollForDecisionTask

public void PollForDecisionTask(PollForDecisionTaskRequest pollRequest,
                                org.apache.thrift.async.AsyncMethodCallback resultHandler)
                         throws org.apache.thrift.TException

Specified by:

PollForDecisionTask in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

RespondDecisionTaskCompleted

public void RespondDecisionTaskCompleted(RespondDecisionTaskCompletedRequest completeRequest,
                                         org.apache.thrift.async.AsyncMethodCallback resultHandler)
                                  throws org.apache.thrift.TException

Specified by:

RespondDecisionTaskCompleted in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

RespondDecisionTaskFailed

public void RespondDecisionTaskFailed(RespondDecisionTaskFailedRequest failedRequest,
                                      org.apache.thrift.async.AsyncMethodCallback resultHandler)
                               throws org.apache.thrift.TException

Specified by:

RespondDecisionTaskFailed in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

PollForActivityTask

public void PollForActivityTask(PollForActivityTaskRequest pollRequest,
                                org.apache.thrift.async.AsyncMethodCallback resultHandler)
                         throws org.apache.thrift.TException

Specified by:

PollForActivityTask in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

RecordActivityTaskHeartbeat

public void RecordActivityTaskHeartbeat(RecordActivityTaskHeartbeatRequest heartbeatRequest,
                                        org.apache.thrift.async.AsyncMethodCallback resultHandler)
                                 throws org.apache.thrift.TException

Specified by:

RecordActivityTaskHeartbeat in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

RecordActivityTaskHeartbeatByID

public void RecordActivityTaskHeartbeatByID(RecordActivityTaskHeartbeatByIDRequest heartbeatRequest,
                                            org.apache.thrift.async.AsyncMethodCallback resultHandler)
                                     throws org.apache.thrift.TException

Specified by:

RecordActivityTaskHeartbeatByID in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

RespondActivityTaskCompleted

public void RespondActivityTaskCompleted(RespondActivityTaskCompletedRequest completeRequest,
                                         org.apache.thrift.async.AsyncMethodCallback resultHandler)
                                  throws org.apache.thrift.TException

Specified by:

RespondActivityTaskCompleted in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

RespondActivityTaskCompletedByID

public void RespondActivityTaskCompletedByID(RespondActivityTaskCompletedByIDRequest completeRequest,
                                             org.apache.thrift.async.AsyncMethodCallback resultHandler)
                                      throws org.apache.thrift.TException

Specified by:

RespondActivityTaskCompletedByID in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

RespondActivityTaskFailed

public void RespondActivityTaskFailed(RespondActivityTaskFailedRequest failRequest,
                                      org.apache.thrift.async.AsyncMethodCallback resultHandler)
                               throws org.apache.thrift.TException

Specified by:

RespondActivityTaskFailed in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

RespondActivityTaskFailedByID

public void RespondActivityTaskFailedByID(RespondActivityTaskFailedByIDRequest failRequest,
                                          org.apache.thrift.async.AsyncMethodCallback resultHandler)
                                   throws org.apache.thrift.TException

Specified by:

RespondActivityTaskFailedByID in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

RespondActivityTaskCanceled

public void RespondActivityTaskCanceled(RespondActivityTaskCanceledRequest canceledRequest,
                                        org.apache.thrift.async.AsyncMethodCallback resultHandler)
                                 throws org.apache.thrift.TException

Specified by:

RespondActivityTaskCanceled in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

RespondActivityTaskCanceledByID

public void RespondActivityTaskCanceledByID(RespondActivityTaskCanceledByIDRequest canceledRequest,
                                            org.apache.thrift.async.AsyncMethodCallback resultHandler)
                                     throws org.apache.thrift.TException

Specified by:

RespondActivityTaskCanceledByID in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

RequestCancelWorkflowExecution

public void RequestCancelWorkflowExecution(RequestCancelWorkflowExecutionRequest cancelRequest,
                                           org.apache.thrift.async.AsyncMethodCallback resultHandler)
                                    throws org.apache.thrift.TException

Specified by:

RequestCancelWorkflowExecution in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

SignalWorkflowExecution

public void SignalWorkflowExecution(SignalWorkflowExecutionRequest signalRequest,
                                    org.apache.thrift.async.AsyncMethodCallback resultHandler)
                             throws org.apache.thrift.TException

Specified by:

SignalWorkflowExecution in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

SignalWithStartWorkflowExecution

public void SignalWithStartWorkflowExecution(SignalWithStartWorkflowExecutionRequest signalWithStartRequest,
                                             org.apache.thrift.async.AsyncMethodCallback resultHandler)
                                      throws org.apache.thrift.TException

Specified by:

SignalWithStartWorkflowExecution in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

TerminateWorkflowExecution

public void TerminateWorkflowExecution(TerminateWorkflowExecutionRequest terminateRequest,
                                       org.apache.thrift.async.AsyncMethodCallback resultHandler)
                                throws org.apache.thrift.TException

Specified by:

TerminateWorkflowExecution in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

ListOpenWorkflowExecutions

public void ListOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest listRequest,
                                       org.apache.thrift.async.AsyncMethodCallback resultHandler)
                                throws org.apache.thrift.TException

Specified by:

ListOpenWorkflowExecutions in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

ListClosedWorkflowExecutions

public void ListClosedWorkflowExecutions(ListClosedWorkflowExecutionsRequest listRequest,
                                         org.apache.thrift.async.AsyncMethodCallback resultHandler)
                                  throws org.apache.thrift.TException

Specified by:

ListClosedWorkflowExecutions in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

RespondQueryTaskCompleted

public void RespondQueryTaskCompleted(RespondQueryTaskCompletedRequest completeRequest,
                                      org.apache.thrift.async.AsyncMethodCallback resultHandler)
                               throws org.apache.thrift.TException

Specified by:

RespondQueryTaskCompleted in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

ResetStickyTaskList

public void ResetStickyTaskList(ResetStickyTaskListRequest resetRequest,
                                org.apache.thrift.async.AsyncMethodCallback resultHandler)
                         throws org.apache.thrift.TException

Specified by:

ResetStickyTaskList in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

QueryWorkflow

public void QueryWorkflow(QueryWorkflowRequest queryRequest,
                          org.apache.thrift.async.AsyncMethodCallback resultHandler)
                   throws org.apache.thrift.TException

Specified by:

QueryWorkflow in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

DescribeWorkflowExecution

public void DescribeWorkflowExecution(DescribeWorkflowExecutionRequest describeRequest,
                                      org.apache.thrift.async.AsyncMethodCallback resultHandler)
                               throws org.apache.thrift.TException

Specified by:

DescribeWorkflowExecution in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

DescribeTaskList

public void DescribeTaskList(DescribeTaskListRequest request,
                             org.apache.thrift.async.AsyncMethodCallback resultHandler)
                      throws org.apache.thrift.TException

Specified by:

DescribeTaskList in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

RegisterDomain

public void RegisterDomain(RegisterDomainRequest registerRequest,
                           org.apache.thrift.async.AsyncMethodCallback resultHandler)
                    throws org.apache.thrift.TException

Specified by:

RegisterDomain in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

DescribeDomain

public void DescribeDomain(DescribeDomainRequest describeRequest,
                           org.apache.thrift.async.AsyncMethodCallback resultHandler)
                    throws org.apache.thrift.TException

Specified by:

DescribeDomain in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

ListDomains

public void ListDomains(ListDomainsRequest listRequest,
                        org.apache.thrift.async.AsyncMethodCallback resultHandler)
                 throws org.apache.thrift.TException

Specified by:

ListDomains in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

UpdateDomain

public void UpdateDomain(UpdateDomainRequest updateRequest,
                         org.apache.thrift.async.AsyncMethodCallback resultHandler)
                  throws org.apache.thrift.TException

Specified by:

UpdateDomain in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException

DeprecateDomain

public void DeprecateDomain(DeprecateDomainRequest deprecateRequest,
                            org.apache.thrift.async.AsyncMethodCallback resultHandler)
                     throws org.apache.thrift.TException

Specified by:

DeprecateDomain in interface WorkflowService.AsyncIface

Throws:

org.apache.thrift.TException