com.amazonaws.services.simpleworkflow.model

Class CountClosedWorkflowExecutionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simpleworkflow.model.CountClosedWorkflowExecutionsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class CountClosedWorkflowExecutionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the CountClosedWorkflowExecutions operation.

Returns the number of closed workflow executions within the given domain that meet the specified filtering criteria.

NOTE:This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action's access to Amazon SWF resources as follows:

• Use a Resource element with the domain name to limit the action to only specified domains.
• Use an Action element to allow or deny permission to call this action.
• Constrain the following parameters by using a Condition element with the appropriate keys.
  • tagFilter.tag : String constraint. The key is swf:tagFilter.tag .
  • typeFilter.name : String constraint. The key is swf:typeFilter.name .
  • typeFilter.version : String constraint. The key is swf:typeFilter.version .

If the caller does not have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute's cause parameter will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

See Also:

AmazonSimpleWorkflow.countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CountClosedWorkflowExecutionsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
CountClosedWorkflowExecutionsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
CloseStatusFilter	getCloseStatusFilter() If specified, only workflow executions that match this close status are counted.
ExecutionTimeFilter	getCloseTimeFilter() If specified, only workflow executions that meet the close time criteria of the filter are counted.
String	getDomain() The name of the domain containing the workflow executions to count.
WorkflowExecutionFilter	getExecutionFilter() If specified, only workflow executions matching the WorkflowId in the filter are counted.
ExecutionTimeFilter	getStartTimeFilter() If specified, only workflow executions that meet the start time criteria of the filter are counted.
TagFilter	getTagFilter() If specified, only executions that have a tag that matches the filter are counted.
WorkflowTypeFilter	getTypeFilter() If specified, indicates the type of the workflow executions to be counted.
int	hashCode()
void	setCloseStatusFilter(CloseStatusFilter closeStatusFilter) If specified, only workflow executions that match this close status are counted.
void	setCloseTimeFilter(ExecutionTimeFilter closeTimeFilter) If specified, only workflow executions that meet the close time criteria of the filter are counted.
void	setDomain(String domain) The name of the domain containing the workflow executions to count.
void	setExecutionFilter(WorkflowExecutionFilter executionFilter) If specified, only workflow executions matching the WorkflowId in the filter are counted.
void	setStartTimeFilter(ExecutionTimeFilter startTimeFilter) If specified, only workflow executions that meet the start time criteria of the filter are counted.
void	setTagFilter(TagFilter tagFilter) If specified, only executions that have a tag that matches the filter are counted.
void	setTypeFilter(WorkflowTypeFilter typeFilter) If specified, indicates the type of the workflow executions to be counted.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CountClosedWorkflowExecutionsRequest	withCloseStatusFilter(CloseStatusFilter closeStatusFilter) If specified, only workflow executions that match this close status are counted.
CountClosedWorkflowExecutionsRequest	withCloseTimeFilter(ExecutionTimeFilter closeTimeFilter) If specified, only workflow executions that meet the close time criteria of the filter are counted.
CountClosedWorkflowExecutionsRequest	withDomain(String domain) The name of the domain containing the workflow executions to count.
CountClosedWorkflowExecutionsRequest	withExecutionFilter(WorkflowExecutionFilter executionFilter) If specified, only workflow executions matching the WorkflowId in the filter are counted.
CountClosedWorkflowExecutionsRequest	withStartTimeFilter(ExecutionTimeFilter startTimeFilter) If specified, only workflow executions that meet the start time criteria of the filter are counted.
CountClosedWorkflowExecutionsRequest	withTagFilter(TagFilter tagFilter) If specified, only executions that have a tag that matches the filter are counted.
CountClosedWorkflowExecutionsRequest	withTypeFilter(WorkflowTypeFilter typeFilter) If specified, indicates the type of the workflow executions to be counted.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CountClosedWorkflowExecutionsRequest

public CountClosedWorkflowExecutionsRequest()

Method Detail

getDomain

public String getDomain()

The name of the domain containing the workflow executions to count.

Constraints:
Length: 1 - 256

Returns:

The name of the domain containing the workflow executions to count.

setDomain

public void setDomain(String domain)

The name of the domain containing the workflow executions to count.

Constraints:
Length: 1 - 256

Parameters:

domain - The name of the domain containing the workflow executions to count.

withDomain

public CountClosedWorkflowExecutionsRequest withDomain(String domain)

The name of the domain containing the workflow executions to count.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 256

Parameters:

domain - The name of the domain containing the workflow executions to count.

Returns:

A reference to this updated object so that method calls can be chained together.

getStartTimeFilter

public ExecutionTimeFilter getStartTimeFilter()

If specified, only workflow executions that meet the start time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Returns:

If specified, only workflow executions that meet the start time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

setStartTimeFilter

public void setStartTimeFilter(ExecutionTimeFilter startTimeFilter)

If specified, only workflow executions that meet the start time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Parameters:

startTimeFilter - If specified, only workflow executions that meet the start time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

withStartTimeFilter

public CountClosedWorkflowExecutionsRequest withStartTimeFilter(ExecutionTimeFilter startTimeFilter)

If specified, only workflow executions that meet the start time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Returns a reference to this object so that method calls can be chained together.

Parameters:

startTimeFilter - If specified, only workflow executions that meet the start time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Returns:

A reference to this updated object so that method calls can be chained together.

getCloseTimeFilter

public ExecutionTimeFilter getCloseTimeFilter()

If specified, only workflow executions that meet the close time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Returns:

If specified, only workflow executions that meet the close time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

setCloseTimeFilter

public void setCloseTimeFilter(ExecutionTimeFilter closeTimeFilter)

If specified, only workflow executions that meet the close time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Parameters:

closeTimeFilter - If specified, only workflow executions that meet the close time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

withCloseTimeFilter

public CountClosedWorkflowExecutionsRequest withCloseTimeFilter(ExecutionTimeFilter closeTimeFilter)

If specified, only workflow executions that meet the close time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Returns a reference to this object so that method calls can be chained together.

Parameters:

closeTimeFilter - If specified, only workflow executions that meet the close time criteria of the filter are counted. startTimeFilter and closeTimeFilter are mutually exclusive. You must specify one of these in a request but not both.

Returns:

A reference to this updated object so that method calls can be chained together.

getExecutionFilter

public WorkflowExecutionFilter getExecutionFilter()

If specified, only workflow executions matching the WorkflowId in the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

If specified, only workflow executions matching the WorkflowId in the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

setExecutionFilter

public void setExecutionFilter(WorkflowExecutionFilter executionFilter)

If specified, only workflow executions matching the WorkflowId in the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Parameters:

executionFilter - If specified, only workflow executions matching the WorkflowId in the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

withExecutionFilter

public CountClosedWorkflowExecutionsRequest withExecutionFilter(WorkflowExecutionFilter executionFilter)

If specified, only workflow executions matching the WorkflowId in the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns a reference to this object so that method calls can be chained together.

Parameters:

executionFilter - If specified, only workflow executions matching the WorkflowId in the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

A reference to this updated object so that method calls can be chained together.

getTypeFilter

public WorkflowTypeFilter getTypeFilter()

If specified, indicates the type of the workflow executions to be counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

If specified, indicates the type of the workflow executions to be counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

setTypeFilter

public void setTypeFilter(WorkflowTypeFilter typeFilter)

If specified, indicates the type of the workflow executions to be counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Parameters:

typeFilter - If specified, indicates the type of the workflow executions to be counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

withTypeFilter

public CountClosedWorkflowExecutionsRequest withTypeFilter(WorkflowTypeFilter typeFilter)

If specified, indicates the type of the workflow executions to be counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns a reference to this object so that method calls can be chained together.

Parameters:

typeFilter - If specified, indicates the type of the workflow executions to be counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

A reference to this updated object so that method calls can be chained together.

getTagFilter

public TagFilter getTagFilter()

If specified, only executions that have a tag that matches the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

If specified, only executions that have a tag that matches the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

setTagFilter

public void setTagFilter(TagFilter tagFilter)

If specified, only executions that have a tag that matches the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Parameters:

tagFilter - If specified, only executions that have a tag that matches the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

withTagFilter

public CountClosedWorkflowExecutionsRequest withTagFilter(TagFilter tagFilter)

If specified, only executions that have a tag that matches the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns a reference to this object so that method calls can be chained together.

Parameters:

tagFilter - If specified, only executions that have a tag that matches the filter are counted. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

A reference to this updated object so that method calls can be chained together.

getCloseStatusFilter

public CloseStatusFilter getCloseStatusFilter()

If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

setCloseStatusFilter

public void setCloseStatusFilter(CloseStatusFilter closeStatusFilter)

If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Parameters:

closeStatusFilter - If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

withCloseStatusFilter

public CountClosedWorkflowExecutionsRequest withCloseStatusFilter(CloseStatusFilter closeStatusFilter)

If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns a reference to this object so that method calls can be chained together.

Parameters:

closeStatusFilter - If specified, only workflow executions that match this close status are counted. This filter has an affect only if executionStatus is specified as CLOSED. closeStatusFilter, executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public CountClosedWorkflowExecutionsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()