com.amazonaws.services.simpleworkflow.model.CountClosedWorkflowExecutionsRequest Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2010-2014 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License").
 * You may not use this file except in compliance with the License.
 * A copy of the License is located at
 * 
 *  http://aws.amazon.com/apache2.0
 * 
 * or in the "license" file accompanying this file. This file is distributed
 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
 * express or implied. See the License for the specific language governing
 * permissions and limitations under the License.
 */
package com.amazonaws.services.simpleworkflow.model;

import java.io.Serializable;

import com.amazonaws.AmazonWebServiceRequest;

/**
 * Container for the parameters to the {@link com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow#countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest) 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.
 * 
 *  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 com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow#countClosedWorkflowExecutions(CountClosedWorkflowExecutionsRequest)
 */
public class CountClosedWorkflowExecutionsRequest extends AmazonWebServiceRequest implements Serializable {

    /**
     * The name of the domain containing the workflow executions to count.
     * 
     * Constraints:

     * Length: 1 - 256

     */
    private String domain;

    /**
     * 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.
     */
    private ExecutionTimeFilter startTimeFilter;

    /**
     * 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.
     */
    private ExecutionTimeFilter closeTimeFilter;

    /**
     * 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.
     */
    private WorkflowExecutionFilter executionFilter;

    /**
     * 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.
     */
    private WorkflowTypeFilter typeFilter;

    /**
     * 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.
     */
    private TagFilter tagFilter;

    /**
     * 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.
     */
    private CloseStatusFilter closeStatusFilter;

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

     * Constraints:

     * Length: 1 - 256

     *
     * @return The name of the domain containing the workflow executions to count.
     */
    public String getDomain() {
        return domain;
    }
    
    /**
     * The name of the domain containing the workflow executions to count.
     * 

     * Constraints:

     * Length: 1 - 256

     *
     * @param domain The name of the domain containing the workflow executions to count.
     */
    public void setDomain(String domain) {
        this.domain = 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

     *
     * @param domain The name of the domain containing the workflow executions to count.
     *
     * @return A reference to this updated object so that method calls can be chained
     *         together.
     */
    public CountClosedWorkflowExecutionsRequest withDomain(String domain) {
        this.domain = domain;
        return this;
    }

    /**
     * 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.
     *
     * @return 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 getStartTimeFilter() {
        return 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.
     *
     * @param 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 void setStartTimeFilter(ExecutionTimeFilter startTimeFilter) {
        this.startTimeFilter = 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.
     *
     * @param 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.
     *
     * @return A reference to this updated object so that method calls can be chained
     *         together.
     */
    public CountClosedWorkflowExecutionsRequest withStartTimeFilter(ExecutionTimeFilter startTimeFilter) {
        this.startTimeFilter = startTimeFilter;
        return this;
    }

    /**
     * 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.
     *
     * @return 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 ExecutionTimeFilter getCloseTimeFilter() {
        return 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.
     *
     * @param 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 void setCloseTimeFilter(ExecutionTimeFilter closeTimeFilter) {
        this.closeTimeFilter = 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.
     *
     * @param 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.
     *
     * @return A reference to this updated object so that method calls can be chained
     *         together.
     */
    public CountClosedWorkflowExecutionsRequest withCloseTimeFilter(ExecutionTimeFilter closeTimeFilter) {
        this.closeTimeFilter = closeTimeFilter;
        return this;
    }

    /**
     * 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.
     *
     * @return 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 WorkflowExecutionFilter getExecutionFilter() {
        return 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.
     *
     * @param 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 void setExecutionFilter(WorkflowExecutionFilter executionFilter) {
        this.executionFilter = 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.
     *
     * @param 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.
     *
     * @return A reference to this updated object so that method calls can be chained
     *         together.
     */
    public CountClosedWorkflowExecutionsRequest withExecutionFilter(WorkflowExecutionFilter executionFilter) {
        this.executionFilter = executionFilter;
        return this;
    }

    /**
     * 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.
     *
     * @return 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 WorkflowTypeFilter getTypeFilter() {
        return 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.
     *
     * @param 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 void setTypeFilter(WorkflowTypeFilter typeFilter) {
        this.typeFilter = 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.
     *
     * @param 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.
     *
     * @return A reference to this updated object so that method calls can be chained
     *         together.
     */
    public CountClosedWorkflowExecutionsRequest withTypeFilter(WorkflowTypeFilter typeFilter) {
        this.typeFilter = typeFilter;
        return this;
    }

    /**
     * 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.
     *
     * @return 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 TagFilter getTagFilter() {
        return 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.
     *
     * @param 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 void setTagFilter(TagFilter tagFilter) {
        this.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.
     *
     * @param 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.
     *
     * @return A reference to this updated object so that method calls can be chained
     *         together.
     */
    public CountClosedWorkflowExecutionsRequest withTagFilter(TagFilter tagFilter) {
        this.tagFilter = tagFilter;
        return this;
    }

    /**
     * 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.
     *
     * @return 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 CloseStatusFilter getCloseStatusFilter() {
        return 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.
     *
     * @param 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 void setCloseStatusFilter(CloseStatusFilter closeStatusFilter) {
        this.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.
     *
     * @param 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.
     *
     * @return A reference to this updated object so that method calls can be chained
     *         together.
     */
    public CountClosedWorkflowExecutionsRequest withCloseStatusFilter(CloseStatusFilter closeStatusFilter) {
        this.closeStatusFilter = closeStatusFilter;
        return this;
    }

    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getDomain() != null) sb.append("Domain: " + getDomain() + ",");
        if (getStartTimeFilter() != null) sb.append("StartTimeFilter: " + getStartTimeFilter() + ",");
        if (getCloseTimeFilter() != null) sb.append("CloseTimeFilter: " + getCloseTimeFilter() + ",");
        if (getExecutionFilter() != null) sb.append("ExecutionFilter: " + getExecutionFilter() + ",");
        if (getTypeFilter() != null) sb.append("TypeFilter: " + getTypeFilter() + ",");
        if (getTagFilter() != null) sb.append("TagFilter: " + getTagFilter() + ",");
        if (getCloseStatusFilter() != null) sb.append("CloseStatusFilter: " + getCloseStatusFilter() );
        sb.append("}");
        return sb.toString();
    }
    
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        
        hashCode = prime * hashCode + ((getDomain() == null) ? 0 : getDomain().hashCode()); 
        hashCode = prime * hashCode + ((getStartTimeFilter() == null) ? 0 : getStartTimeFilter().hashCode()); 
        hashCode = prime * hashCode + ((getCloseTimeFilter() == null) ? 0 : getCloseTimeFilter().hashCode()); 
        hashCode = prime * hashCode + ((getExecutionFilter() == null) ? 0 : getExecutionFilter().hashCode()); 
        hashCode = prime * hashCode + ((getTypeFilter() == null) ? 0 : getTypeFilter().hashCode()); 
        hashCode = prime * hashCode + ((getTagFilter() == null) ? 0 : getTagFilter().hashCode()); 
        hashCode = prime * hashCode + ((getCloseStatusFilter() == null) ? 0 : getCloseStatusFilter().hashCode()); 
        return hashCode;
    }
    
    @Override
    public boolean equals(Object obj) {
        if (this == obj) return true;
        if (obj == null) return false;

        if (obj instanceof CountClosedWorkflowExecutionsRequest == false) return false;
        CountClosedWorkflowExecutionsRequest other = (CountClosedWorkflowExecutionsRequest)obj;
        
        if (other.getDomain() == null ^ this.getDomain() == null) return false;
        if (other.getDomain() != null && other.getDomain().equals(this.getDomain()) == false) return false; 
        if (other.getStartTimeFilter() == null ^ this.getStartTimeFilter() == null) return false;
        if (other.getStartTimeFilter() != null && other.getStartTimeFilter().equals(this.getStartTimeFilter()) == false) return false; 
        if (other.getCloseTimeFilter() == null ^ this.getCloseTimeFilter() == null) return false;
        if (other.getCloseTimeFilter() != null && other.getCloseTimeFilter().equals(this.getCloseTimeFilter()) == false) return false; 
        if (other.getExecutionFilter() == null ^ this.getExecutionFilter() == null) return false;
        if (other.getExecutionFilter() != null && other.getExecutionFilter().equals(this.getExecutionFilter()) == false) return false; 
        if (other.getTypeFilter() == null ^ this.getTypeFilter() == null) return false;
        if (other.getTypeFilter() != null && other.getTypeFilter().equals(this.getTypeFilter()) == false) return false; 
        if (other.getTagFilter() == null ^ this.getTagFilter() == null) return false;
        if (other.getTagFilter() != null && other.getTagFilter().equals(this.getTagFilter()) == false) return false; 
        if (other.getCloseStatusFilter() == null ^ this.getCloseStatusFilter() == null) return false;
        if (other.getCloseStatusFilter() != null && other.getCloseStatusFilter().equals(this.getCloseStatusFilter()) == false) return false; 
        return true;
    }
    
}