/************************************************************************* * Copyright 2014 Eucalyptus Systems, Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; version 3 of the License. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see http://www.gnu.org/licenses/. * * Please contact Eucalyptus Systems, Inc., 6755 Hollister Ave., Goleta * CA 93117, USA or visit http://www.eucalyptus.com/licenses/ if you * need additional information or have any questions. * * This file may incorporate work covered under the following copyright * and permission notice: * Copyright 2010-2015 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.eucalyptus.simpleworkflow.common.model; import java.io.Serializable; import javax.annotation.Nonnull; import com.eucalyptus.auth.policy.annotation.PolicyAction; /** * Container for the parameters to the {@link com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow#listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest) ListOpenWorkflowExecutions operation}. * <p> * Returns a list of open workflow executions in the specified domain * that meet the filtering criteria. The results may be split into * multiple pages. To retrieve subsequent pages, make the call again * using the nextPageToken returned by the initial call. * </p> * <p> * <b>NOTE:</b> This operation is eventually consistent. The results are * best effort and may not exactly reflect recent updates and changes. * </p> * <p> * <b>Access Control</b> * </p> * <p> * You can use IAM policies to control this action's access to Amazon SWF * resources as follows: * </p> * * <ul> * <li>Use a <code>Resource</code> element with the domain name to limit * the action to only specified domains.</li> * <li>Use an <code>Action</code> element to allow or deny permission to * call this action.</li> * <li>Constrain the following parameters by using a * <code>Condition</code> element with the appropriate keys. * <ul> * <li> <code>tagFilter.tag</code> : String constraint. The key is * <code>swf:tagFilter.tag</code> .</li> * <li> <code>typeFilter.name</code> : String constraint. The key is * <code>swf:typeFilter.name</code> .</li> * <li> <code>typeFilter.version</code> : String constraint. The key is * <code>swf:typeFilter.version</code> .</li> * * </ul> * </li> * * </ul> * <p> * 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 * <b>cause</b> parameter will be set to OPERATION_NOT_PERMITTED. For * details and example IAM policies, see * <a href="http://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html"> Using IAM to Manage Access to Amazon SWF Workflows </a> * . * </p> * * @see com.amazonaws.services.simpleworkflow.AmazonSimpleWorkflow#listOpenWorkflowExecutions(ListOpenWorkflowExecutionsRequest) */ @PolicyAction( vendor = "swf", action = "listopenworkflowexecutions" ) public class ListOpenWorkflowExecutionsRequest extends SimpleWorkflowMessage implements Serializable, WorkflowExecutionFilterParameters { /** * The name of the domain that contains the workflow executions to list. * <p> * <b>Constraints:</b><br/> * <b>Length: </b>1 - 256<br/> */ @Nonnull @FieldRegex( FieldRegexValue.NAME_256 ) private String domain; /** * Workflow executions are included in the returned results based on * whether their start times are within the range specified by this * filter. */ @Nonnull private ExecutionTimeFilter startTimeFilter; /** * If specified, only executions of the type specified in the filter are * returned. <note><code>executionFilter</code>, <code>typeFilter</code> * and <code>tagFilter</code> are mutually exclusive. You can specify at * most one of these in a request.</note> */ private WorkflowTypeFilter typeFilter; /** * If specified, only executions that have the matching tag are listed. * <note><code>executionFilter</code>, <code>typeFilter</code> and * <code>tagFilter</code> are mutually exclusive. You can specify at most * one of these in a request.</note> */ private TagFilter tagFilter; /** * If a <code>NextPageToken</code> was returned by a previous call, there * are more results available. To retrieve the next page of results, make * the call again using the returned token in <code>nextPageToken</code>. * Keep all other arguments unchanged. <p>The configured * <code>maximumPageSize</code> determines how many results can be * returned in a single call. * <p> * <b>Constraints:</b><br/> * <b>Length: </b>0 - 2048<br/> */ @FieldRegex( FieldRegexValue.OPT_STRING_2048 ) private String nextPageToken; /** * The maximum number of results that will be returned per call. * <code>nextPageToken</code> can be used to obtain futher pages of * results. The default is 1000, which is the maximum allowed page size. * You can, however, specify a page size <i>smaller</i> than the maximum. * <p>This is an upper limit only; the actual number of results returned * per call may be fewer than the specified maximum. * <p> * <b>Constraints:</b><br/> * <b>Range: </b>0 - 1000<br/> */ @FieldRange( max = 1000 ) private Integer maximumPageSize; /** * When set to <code>true</code>, returns the results in reverse order. * By default the results are returned in descending order of the start * time of the executions. */ private Boolean reverseOrder; /** * If specified, only workflow executions matching the workflow ID * specified in the filter are returned. * <note><code>executionFilter</code>, <code>typeFilter</code> and * <code>tagFilter</code> are mutually exclusive. You can specify at most * one of these in a request.</note> */ private WorkflowExecutionFilter executionFilter; /** * The name of the domain that contains the workflow executions to list. * <p> * <b>Constraints:</b><br/> * <b>Length: </b>1 - 256<br/> * * @return The name of the domain that contains the workflow executions to list. */ public String getDomain() { return domain; } /** * The name of the domain that contains the workflow executions to list. * <p> * <b>Constraints:</b><br/> * <b>Length: </b>1 - 256<br/> * * @param domain The name of the domain that contains the workflow executions to list. */ public void setDomain(String domain) { this.domain = domain; } /** * The name of the domain that contains the workflow executions to list. * <p> * Returns a reference to this object so that method calls can be chained together. * <p> * <b>Constraints:</b><br/> * <b>Length: </b>1 - 256<br/> * * @param domain The name of the domain that contains the workflow executions to list. * * @return A reference to this updated object so that method calls can be chained * together. */ public ListOpenWorkflowExecutionsRequest withDomain(String domain) { this.domain = domain; return this; } /** * Workflow executions are included in the returned results based on * whether their start times are within the range specified by this * filter. * * @return Workflow executions are included in the returned results based on * whether their start times are within the range specified by this * filter. */ public ExecutionTimeFilter getStartTimeFilter() { return startTimeFilter; } /** * Workflow executions are included in the returned results based on * whether their start times are within the range specified by this * filter. * * @param startTimeFilter Workflow executions are included in the returned results based on * whether their start times are within the range specified by this * filter. */ public void setStartTimeFilter(ExecutionTimeFilter startTimeFilter) { this.startTimeFilter = startTimeFilter; } /** * Workflow executions are included in the returned results based on * whether their start times are within the range specified by this * filter. * <p> * Returns a reference to this object so that method calls can be chained together. * * @param startTimeFilter Workflow executions are included in the returned results based on * whether their start times are within the range specified by this * filter. * * @return A reference to this updated object so that method calls can be chained * together. */ public ListOpenWorkflowExecutionsRequest withStartTimeFilter(ExecutionTimeFilter startTimeFilter) { this.startTimeFilter = startTimeFilter; return this; } /** * If specified, only executions of the type specified in the filter are * returned. <note><code>executionFilter</code>, <code>typeFilter</code> * and <code>tagFilter</code> are mutually exclusive. You can specify at * most one of these in a request.</note> * * @return If specified, only executions of the type specified in the filter are * returned. <note><code>executionFilter</code>, <code>typeFilter</code> * and <code>tagFilter</code> are mutually exclusive. You can specify at * most one of these in a request.</note> */ public WorkflowTypeFilter getTypeFilter() { return typeFilter; } /** * If specified, only executions of the type specified in the filter are * returned. <note><code>executionFilter</code>, <code>typeFilter</code> * and <code>tagFilter</code> are mutually exclusive. You can specify at * most one of these in a request.</note> * * @param typeFilter If specified, only executions of the type specified in the filter are * returned. <note><code>executionFilter</code>, <code>typeFilter</code> * and <code>tagFilter</code> are mutually exclusive. You can specify at * most one of these in a request.</note> */ public void setTypeFilter(WorkflowTypeFilter typeFilter) { this.typeFilter = typeFilter; } /** * If specified, only executions of the type specified in the filter are * returned. <note><code>executionFilter</code>, <code>typeFilter</code> * and <code>tagFilter</code> are mutually exclusive. You can specify at * most one of these in a request.</note> * <p> * Returns a reference to this object so that method calls can be chained together. * * @param typeFilter If specified, only executions of the type specified in the filter are * returned. <note><code>executionFilter</code>, <code>typeFilter</code> * and <code>tagFilter</code> are mutually exclusive. You can specify at * most one of these in a request.</note> * * @return A reference to this updated object so that method calls can be chained * together. */ public ListOpenWorkflowExecutionsRequest withTypeFilter(WorkflowTypeFilter typeFilter) { this.typeFilter = typeFilter; return this; } /** * If specified, only executions that have the matching tag are listed. * <note><code>executionFilter</code>, <code>typeFilter</code> and * <code>tagFilter</code> are mutually exclusive. You can specify at most * one of these in a request.</note> * * @return If specified, only executions that have the matching tag are listed. * <note><code>executionFilter</code>, <code>typeFilter</code> and * <code>tagFilter</code> are mutually exclusive. You can specify at most * one of these in a request.</note> */ public TagFilter getTagFilter() { return tagFilter; } /** * If specified, only executions that have the matching tag are listed. * <note><code>executionFilter</code>, <code>typeFilter</code> and * <code>tagFilter</code> are mutually exclusive. You can specify at most * one of these in a request.</note> * * @param tagFilter If specified, only executions that have the matching tag are listed. * <note><code>executionFilter</code>, <code>typeFilter</code> and * <code>tagFilter</code> are mutually exclusive. You can specify at most * one of these in a request.</note> */ public void setTagFilter(TagFilter tagFilter) { this.tagFilter = tagFilter; } /** * If specified, only executions that have the matching tag are listed. * <note><code>executionFilter</code>, <code>typeFilter</code> and * <code>tagFilter</code> are mutually exclusive. You can specify at most * one of these in a request.</note> * <p> * Returns a reference to this object so that method calls can be chained together. * * @param tagFilter If specified, only executions that have the matching tag are listed. * <note><code>executionFilter</code>, <code>typeFilter</code> and * <code>tagFilter</code> are mutually exclusive. You can specify at most * one of these in a request.</note> * * @return A reference to this updated object so that method calls can be chained * together. */ public ListOpenWorkflowExecutionsRequest withTagFilter(TagFilter tagFilter) { this.tagFilter = tagFilter; return this; } /** * If a <code>NextPageToken</code> was returned by a previous call, there * are more results available. To retrieve the next page of results, make * the call again using the returned token in <code>nextPageToken</code>. * Keep all other arguments unchanged. <p>The configured * <code>maximumPageSize</code> determines how many results can be * returned in a single call. * <p> * <b>Constraints:</b><br/> * <b>Length: </b>0 - 2048<br/> * * @return If a <code>NextPageToken</code> was returned by a previous call, there * are more results available. To retrieve the next page of results, make * the call again using the returned token in <code>nextPageToken</code>. * Keep all other arguments unchanged. <p>The configured * <code>maximumPageSize</code> determines how many results can be * returned in a single call. */ public String getNextPageToken() { return nextPageToken; } /** * If a <code>NextPageToken</code> was returned by a previous call, there * are more results available. To retrieve the next page of results, make * the call again using the returned token in <code>nextPageToken</code>. * Keep all other arguments unchanged. <p>The configured * <code>maximumPageSize</code> determines how many results can be * returned in a single call. * <p> * <b>Constraints:</b><br/> * <b>Length: </b>0 - 2048<br/> * * @param nextPageToken If a <code>NextPageToken</code> was returned by a previous call, there * are more results available. To retrieve the next page of results, make * the call again using the returned token in <code>nextPageToken</code>. * Keep all other arguments unchanged. <p>The configured * <code>maximumPageSize</code> determines how many results can be * returned in a single call. */ public void setNextPageToken(String nextPageToken) { this.nextPageToken = nextPageToken; } /** * If a <code>NextPageToken</code> was returned by a previous call, there * are more results available. To retrieve the next page of results, make * the call again using the returned token in <code>nextPageToken</code>. * Keep all other arguments unchanged. <p>The configured * <code>maximumPageSize</code> determines how many results can be * returned in a single call. * <p> * Returns a reference to this object so that method calls can be chained together. * <p> * <b>Constraints:</b><br/> * <b>Length: </b>0 - 2048<br/> * * @param nextPageToken If a <code>NextPageToken</code> was returned by a previous call, there * are more results available. To retrieve the next page of results, make * the call again using the returned token in <code>nextPageToken</code>. * Keep all other arguments unchanged. <p>The configured * <code>maximumPageSize</code> determines how many results can be * returned in a single call. * * @return A reference to this updated object so that method calls can be chained * together. */ public ListOpenWorkflowExecutionsRequest withNextPageToken(String nextPageToken) { this.nextPageToken = nextPageToken; return this; } /** * The maximum number of results that will be returned per call. * <code>nextPageToken</code> can be used to obtain futher pages of * results. The default is 1000, which is the maximum allowed page size. * You can, however, specify a page size <i>smaller</i> than the maximum. * <p>This is an upper limit only; the actual number of results returned * per call may be fewer than the specified maximum. * <p> * <b>Constraints:</b><br/> * <b>Range: </b>0 - 1000<br/> * * @return The maximum number of results that will be returned per call. * <code>nextPageToken</code> can be used to obtain futher pages of * results. The default is 1000, which is the maximum allowed page size. * You can, however, specify a page size <i>smaller</i> than the maximum. * <p>This is an upper limit only; the actual number of results returned * per call may be fewer than the specified maximum. */ public Integer getMaximumPageSize() { return maximumPageSize; } /** * The maximum number of results that will be returned per call. * <code>nextPageToken</code> can be used to obtain futher pages of * results. The default is 1000, which is the maximum allowed page size. * You can, however, specify a page size <i>smaller</i> than the maximum. * <p>This is an upper limit only; the actual number of results returned * per call may be fewer than the specified maximum. * <p> * <b>Constraints:</b><br/> * <b>Range: </b>0 - 1000<br/> * * @param maximumPageSize The maximum number of results that will be returned per call. * <code>nextPageToken</code> can be used to obtain futher pages of * results. The default is 1000, which is the maximum allowed page size. * You can, however, specify a page size <i>smaller</i> than the maximum. * <p>This is an upper limit only; the actual number of results returned * per call may be fewer than the specified maximum. */ public void setMaximumPageSize(Integer maximumPageSize) { this.maximumPageSize = maximumPageSize; } /** * The maximum number of results that will be returned per call. * <code>nextPageToken</code> can be used to obtain futher pages of * results. The default is 1000, which is the maximum allowed page size. * You can, however, specify a page size <i>smaller</i> than the maximum. * <p>This is an upper limit only; the actual number of results returned * per call may be fewer than the specified maximum. * <p> * Returns a reference to this object so that method calls can be chained together. * <p> * <b>Constraints:</b><br/> * <b>Range: </b>0 - 1000<br/> * * @param maximumPageSize The maximum number of results that will be returned per call. * <code>nextPageToken</code> can be used to obtain futher pages of * results. The default is 1000, which is the maximum allowed page size. * You can, however, specify a page size <i>smaller</i> than the maximum. * <p>This is an upper limit only; the actual number of results returned * per call may be fewer than the specified maximum. * * @return A reference to this updated object so that method calls can be chained * together. */ public ListOpenWorkflowExecutionsRequest withMaximumPageSize(Integer maximumPageSize) { this.maximumPageSize = maximumPageSize; return this; } /** * When set to <code>true</code>, returns the results in reverse order. * By default the results are returned in descending order of the start * time of the executions. * * @return When set to <code>true</code>, returns the results in reverse order. * By default the results are returned in descending order of the start * time of the executions. */ public Boolean isReverseOrder() { return reverseOrder; } /** * When set to <code>true</code>, returns the results in reverse order. * By default the results are returned in descending order of the start * time of the executions. * * @param reverseOrder When set to <code>true</code>, returns the results in reverse order. * By default the results are returned in descending order of the start * time of the executions. */ public void setReverseOrder(Boolean reverseOrder) { this.reverseOrder = reverseOrder; } /** * When set to <code>true</code>, returns the results in reverse order. * By default the results are returned in descending order of the start * time of the executions. * <p> * Returns a reference to this object so that method calls can be chained together. * * @param reverseOrder When set to <code>true</code>, returns the results in reverse order. * By default the results are returned in descending order of the start * time of the executions. * * @return A reference to this updated object so that method calls can be chained * together. */ public ListOpenWorkflowExecutionsRequest withReverseOrder(Boolean reverseOrder) { this.reverseOrder = reverseOrder; return this; } /** * When set to <code>true</code>, returns the results in reverse order. * By default the results are returned in descending order of the start * time of the executions. * * @return When set to <code>true</code>, returns the results in reverse order. * By default the results are returned in descending order of the start * time of the executions. */ public Boolean getReverseOrder() { return reverseOrder; } /** * If specified, only workflow executions matching the workflow ID * specified in the filter are returned. * <note><code>executionFilter</code>, <code>typeFilter</code> and * <code>tagFilter</code> are mutually exclusive. You can specify at most * one of these in a request.</note> * * @return If specified, only workflow executions matching the workflow ID * specified in the filter are returned. * <note><code>executionFilter</code>, <code>typeFilter</code> and * <code>tagFilter</code> are mutually exclusive. You can specify at most * one of these in a request.</note> */ public WorkflowExecutionFilter getExecutionFilter() { return executionFilter; } /** * If specified, only workflow executions matching the workflow ID * specified in the filter are returned. * <note><code>executionFilter</code>, <code>typeFilter</code> and * <code>tagFilter</code> are mutually exclusive. You can specify at most * one of these in a request.</note> * * @param executionFilter If specified, only workflow executions matching the workflow ID * specified in the filter are returned. * <note><code>executionFilter</code>, <code>typeFilter</code> and * <code>tagFilter</code> are mutually exclusive. You can specify at most * one of these in a request.</note> */ public void setExecutionFilter(WorkflowExecutionFilter executionFilter) { this.executionFilter = executionFilter; } /** * If specified, only workflow executions matching the workflow ID * specified in the filter are returned. * <note><code>executionFilter</code>, <code>typeFilter</code> and * <code>tagFilter</code> are mutually exclusive. You can specify at most * one of these in a request.</note> * <p> * Returns a reference to this object so that method calls can be chained together. * * @param executionFilter If specified, only workflow executions matching the workflow ID * specified in the filter are returned. * <note><code>executionFilter</code>, <code>typeFilter</code> and * <code>tagFilter</code> are mutually exclusive. You can specify at most * one of these in a request.</note> * * @return A reference to this updated object so that method calls can be chained * together. */ public ListOpenWorkflowExecutionsRequest withExecutionFilter(WorkflowExecutionFilter executionFilter) { this.executionFilter = executionFilter; 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 (getTypeFilter() != null) sb.append("TypeFilter: " + getTypeFilter() + ","); if (getTagFilter() != null) sb.append("TagFilter: " + getTagFilter() + ","); if (getNextPageToken() != null) sb.append("NextPageToken: " + getNextPageToken() + ","); if (getMaximumPageSize() != null) sb.append("MaximumPageSize: " + getMaximumPageSize() + ","); if (isReverseOrder() != null) sb.append("ReverseOrder: " + isReverseOrder() + ","); if (getExecutionFilter() != null) sb.append("ExecutionFilter: " + getExecutionFilter() ); 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 + ((getTypeFilter() == null) ? 0 : getTypeFilter().hashCode()); hashCode = prime * hashCode + ((getTagFilter() == null) ? 0 : getTagFilter().hashCode()); hashCode = prime * hashCode + ((getNextPageToken() == null) ? 0 : getNextPageToken().hashCode()); hashCode = prime * hashCode + ((getMaximumPageSize() == null) ? 0 : getMaximumPageSize().hashCode()); hashCode = prime * hashCode + ((isReverseOrder() == null) ? 0 : isReverseOrder().hashCode()); hashCode = prime * hashCode + ((getExecutionFilter() == null) ? 0 : getExecutionFilter().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ListOpenWorkflowExecutionsRequest == false) return false; ListOpenWorkflowExecutionsRequest other = (ListOpenWorkflowExecutionsRequest)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.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.getNextPageToken() == null ^ this.getNextPageToken() == null) return false; if (other.getNextPageToken() != null && other.getNextPageToken().equals(this.getNextPageToken()) == false) return false; if (other.getMaximumPageSize() == null ^ this.getMaximumPageSize() == null) return false; if (other.getMaximumPageSize() != null && other.getMaximumPageSize().equals(this.getMaximumPageSize()) == false) return false; if (other.isReverseOrder() == null ^ this.isReverseOrder() == null) return false; if (other.isReverseOrder() != null && other.isReverseOrder().equals(this.isReverseOrder()) == false) return false; if (other.getExecutionFilter() == null ^ this.getExecutionFilter() == null) return false; if (other.getExecutionFilter() != null && other.getExecutionFilter().equals(this.getExecutionFilter()) == false) return false; return true; } }