com.amazonaws.services.simpleworkflow.model
Class CountOpenWorkflowExecutionsRequest

java.lang.Object
  com.amazonaws.AmazonWebServiceRequest
      com.amazonaws.services.simpleworkflow.model.CountOpenWorkflowExecutionsRequest

All Implemented Interfaces:

Serializable

public class CountOpenWorkflowExecutionsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the CountOpenWorkflowExecutions operation.

Returns the number of open 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.
  • tag : String constraint. The key is swf:tagFilter.tag .
  • typeFilter.name : String constraint. String constraint. The key is swf:typeFilter.name .
  • typeFilter.version : String constraint. 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 by throwing OperationNotPermitted . For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows .

See Also:

AmazonSimpleWorkflow.countOpenWorkflowExecutions(CountOpenWorkflowExecutionsRequest), Serialized Form

Constructor Summary

CountOpenWorkflowExecutionsRequest()

Method Summary

boolean	equals(Object obj)
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() Specifies the start time criteria that workflow executions must meet in order to be counted.
TagFilter	getTagFilter() If specified, only executions that have a tag that matches the filter are counted.
WorkflowTypeFilter	getTypeFilter() Specifies the type of the workflow executions to be counted.
int	hashCode()
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) Specifies the start time criteria that workflow executions must meet in order to be counted.
void	setTagFilter(TagFilter tagFilter) If specified, only executions that have a tag that matches the filter are counted.
void	setTypeFilter(WorkflowTypeFilter typeFilter) Specifies the type of the workflow executions to be counted.
String	toString() Returns a string representation of this object; useful for testing and debugging.
CountOpenWorkflowExecutionsRequest	withDomain(String domain) The name of the domain containing the workflow executions to count.
CountOpenWorkflowExecutionsRequest	withExecutionFilter(WorkflowExecutionFilter executionFilter) If specified, only workflow executions matching the WorkflowId in the filter are counted.
CountOpenWorkflowExecutionsRequest	withStartTimeFilter(ExecutionTimeFilter startTimeFilter) Specifies the start time criteria that workflow executions must meet in order to be counted.
CountOpenWorkflowExecutionsRequest	withTagFilter(TagFilter tagFilter) If specified, only executions that have a tag that matches the filter are counted.
CountOpenWorkflowExecutionsRequest	withTypeFilter(WorkflowTypeFilter typeFilter) Specifies the type of the workflow executions to be counted.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CountOpenWorkflowExecutionsRequest

public CountOpenWorkflowExecutionsRequest()

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 CountOpenWorkflowExecutionsRequest 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()

Specifies the start time criteria that workflow executions must meet in order to be counted.

Returns:

Specifies the start time criteria that workflow executions must meet in order to be counted.

setStartTimeFilter

public void setStartTimeFilter(ExecutionTimeFilter startTimeFilter)

Specifies the start time criteria that workflow executions must meet in order to be counted.

Parameters:

startTimeFilter - Specifies the start time criteria that workflow executions must meet in order to be counted.

withStartTimeFilter

public CountOpenWorkflowExecutionsRequest withStartTimeFilter(ExecutionTimeFilter startTimeFilter)

Specifies the start time criteria that workflow executions must meet in order to be counted.

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

Parameters:

startTimeFilter - Specifies the start time criteria that workflow executions must meet in order to be counted.

Returns:

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

getTypeFilter

public WorkflowTypeFilter getTypeFilter()

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

Returns:

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

setTypeFilter

public void setTypeFilter(WorkflowTypeFilter typeFilter)

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

Parameters:

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

withTypeFilter

public CountOpenWorkflowExecutionsRequest withTypeFilter(WorkflowTypeFilter typeFilter)

Specifies the type of the workflow executions to be counted. 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 - Specifies the type of the workflow executions to be counted. 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. 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. 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. 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. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

withTagFilter

public CountOpenWorkflowExecutionsRequest withTagFilter(TagFilter tagFilter)

If specified, only executions that have a tag that matches the filter are counted. 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. 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.

getExecutionFilter

public WorkflowExecutionFilter getExecutionFilter()

If specified, only workflow executions matching the WorkflowId in the filter are counted. 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. 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. 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. executionFilter, typeFilter and tagFilter are mutually exclusive. You can specify at most one of these in a request.

withExecutionFilter

public CountOpenWorkflowExecutionsRequest withExecutionFilter(WorkflowExecutionFilter executionFilter)

If specified, only workflow executions matching the WorkflowId in the filter are counted. 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. 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