Package app.knock.api.resources
Class WorkflowsResource
- java.lang.Object
-
- app.knock.api.resources.WorkflowsResource
-
public final class WorkflowsResource extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classWorkflowsResource.SchedulesQueryParams
-
Constructor Summary
Constructors Constructor Description WorkflowsResource(KnockHttp knockHttp)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidcancel(WorkflowCancelRequest workflowCancelRequest)Uses the cancellationKey, and recipients attributes of the WorkflowCancelRequest to cancel the workflow for the specified recipients.java.util.List<Schedule>createSchedules(CreateSchedulesRequest createSchedulesRequest)Create schedules for a given workflowjava.util.List<Schedule>deleteSchedules(DeleteSchedulesRequest deleteSchedulesRequest)Deletes schedule instancesbooleanequals(java.lang.Object o)KnockHttpgetKnockHttp()inthashCode()CursorResult<Schedule>listSchedules(java.lang.String workflowKey, WorkflowsResource.SchedulesQueryParams queryParams)Retrieve schedules for workflowjava.lang.StringtoString()WorkflowTriggerResponsetrigger(WorkflowTriggerRequest workflowTrigger)Trigger a Knock workflow.WorkflowTriggerResponsetrigger(WorkflowTriggerRequest workflowTrigger, MethodOptions methodOptions)Trigger a Knock workflow.java.util.List<Schedule>updateSchedules(UpdateSchedulesRequest updateSchedulesRequest)Updates schedule instances
-
-
-
Constructor Detail
-
WorkflowsResource
public WorkflowsResource(KnockHttp knockHttp)
-
-
Method Detail
-
trigger
public WorkflowTriggerResponse trigger(WorkflowTriggerRequest workflowTrigger)
Trigger a Knock workflow.- Parameters:
workflowTrigger- The workflow trigger request to send- Returns:
- the result of the workflow trigger
- Throws:
KnockClientResourceException
-
trigger
public WorkflowTriggerResponse trigger(WorkflowTriggerRequest workflowTrigger, MethodOptions methodOptions)
Trigger a Knock workflow.- Parameters:
workflowTrigger- The workflow trigger request to sendmethodOptions- Optional HTTP method options, e.g. to set the idempotency key of the request- Returns:
- the result of the workflow trigger
- Throws:
KnockClientResourceException
-
cancel
public void cancel(WorkflowCancelRequest workflowCancelRequest)
Uses the cancellationKey, and recipients attributes of the WorkflowCancelRequest to cancel the workflow for the specified recipients.- Parameters:
workflowCancelRequest-- Throws:
KnockClientResourceException
-
createSchedules
public java.util.List<Schedule> createSchedules(CreateSchedulesRequest createSchedulesRequest)
Create schedules for a given workflow- Parameters:
createSchedulesRequest- Attributes for schedules creation- Returns:
- List of created schedules
- Throws:
KnockClientResourceException
-
updateSchedules
public java.util.List<Schedule> updateSchedules(UpdateSchedulesRequest updateSchedulesRequest)
Updates schedule instances- Parameters:
updateSchedulesRequest- Attributes for updating schedules- Returns:
- List of updated schedules
- Throws:
KnockClientResourceException
-
deleteSchedules
public java.util.List<Schedule> deleteSchedules(DeleteSchedulesRequest deleteSchedulesRequest)
Deletes schedule instances- Parameters:
deleteSchedulesRequest- Delete request params (schedules to be deleted)- Returns:
- List of deleted schedules
- Throws:
KnockClientResourceException
-
listSchedules
public CursorResult<Schedule> listSchedules(java.lang.String workflowKey, WorkflowsResource.SchedulesQueryParams queryParams)
Retrieve schedules for workflow- Returns:
- a cursor result of schedules
- Throws:
KnockClientResourceException
-
getKnockHttp
public KnockHttp getKnockHttp()
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
-