public class CountClosedWorkflowExecutionsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
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:
Resource element with the domain name to limit
the action to only specified domains.Action element to allow or deny permission to
call this action.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 .
NOOP| Constructor and Description |
|---|
CountClosedWorkflowExecutionsRequest() |
| 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.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic CountClosedWorkflowExecutionsRequest()
public String getDomain()
Constraints:
Length: 1 - 256
public void setDomain(String domain)
Constraints:
Length: 1 - 256
domain - The name of the domain containing the workflow executions to count.public CountClosedWorkflowExecutionsRequest withDomain(String domain)
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 256
domain - The name of the domain containing the workflow executions to count.public ExecutionTimeFilter getStartTimeFilter()
startTimeFilter
and closeTimeFilter are mutually exclusive. You must
specify one of these in a request but not both.startTimeFilter
and closeTimeFilter are mutually exclusive. You must
specify one of these in a request but not both.public void setStartTimeFilter(ExecutionTimeFilter startTimeFilter)
startTimeFilter
and closeTimeFilter are mutually exclusive. You must
specify one of these in a request but not both.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.public CountClosedWorkflowExecutionsRequest withStartTimeFilter(ExecutionTimeFilter startTimeFilter)
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.
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.public ExecutionTimeFilter getCloseTimeFilter()
startTimeFilter
and closeTimeFilter are mutually exclusive. You must
specify one of these in a request but not both.startTimeFilter
and closeTimeFilter are mutually exclusive. You must
specify one of these in a request but not both.public void setCloseTimeFilter(ExecutionTimeFilter closeTimeFilter)
startTimeFilter
and closeTimeFilter are mutually exclusive. You must
specify one of these in a request but not both.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.public CountClosedWorkflowExecutionsRequest withCloseTimeFilter(ExecutionTimeFilter closeTimeFilter)
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.
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.public WorkflowExecutionFilter getExecutionFilter()
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.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.public void setExecutionFilter(WorkflowExecutionFilter executionFilter)
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.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.public CountClosedWorkflowExecutionsRequest withExecutionFilter(WorkflowExecutionFilter executionFilter)
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.
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.public WorkflowTypeFilter getTypeFilter()
closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.public void setTypeFilter(WorkflowTypeFilter typeFilter)
closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.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.public CountClosedWorkflowExecutionsRequest withTypeFilter(WorkflowTypeFilter typeFilter)
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.
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.public TagFilter getTagFilter()
closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.public void setTagFilter(TagFilter tagFilter)
closeStatusFilter,
executionFilter, typeFilter and
tagFilter are mutually exclusive. You can specify at most
one of these in a request.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.public CountClosedWorkflowExecutionsRequest withTagFilter(TagFilter tagFilter)
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.
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.public CloseStatusFilter getCloseStatusFilter()
executionStatus is specified as CLOSED.
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.executionStatus is specified as CLOSED.
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.public void setCloseStatusFilter(CloseStatusFilter closeStatusFilter)
executionStatus is specified as CLOSED.
closeStatusFilter, executionFilter,
typeFilter and tagFilter are mutually
exclusive. You can specify at most one of these in a request.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.public CountClosedWorkflowExecutionsRequest withCloseStatusFilter(CloseStatusFilter closeStatusFilter)
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.
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.public String toString()
toString in class ObjectObject.toString()public CountClosedWorkflowExecutionsRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.