Java tutorial
/* * Copyright 2014-2019 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 javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/swf-2012-01-25/GetWorkflowExecutionHistory" target="_top">AWS * API Documentation</a> */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetWorkflowExecutionHistoryRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** * <p> * The name of the domain containing the workflow execution. * </p> */ private String domain; /** * <p> * Specifies the workflow execution for which to return the history. * </p> */ private WorkflowExecution execution; /** * <p> * If <code>NextPageToken</code> is returned there are more results available. The value of * <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using the returned * token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 * seconds. Using an expired pagination token will return a <code>400</code> error: " * <code>Specified token has exceeded its maximum lifetime</code>". * </p> * <p> * The configured <code>maximumPageSize</code> determines how many results can be returned in a single call. * </p> */ private String nextPageToken; /** * <p> * The maximum number of results that are returned per call. Use <code>nextPageToken</code> to obtain further pages * of results. * </p> */ private Integer maximumPageSize; /** * <p> * When set to <code>true</code>, returns the events in reverse order. By default the results are returned in * ascending order of the <code>eventTimeStamp</code> of the events. * </p> */ private Boolean reverseOrder; /** * <p> * The name of the domain containing the workflow execution. * </p> * * @param domain * The name of the domain containing the workflow execution. */ public void setDomain(String domain) { this.domain = domain; } /** * <p> * The name of the domain containing the workflow execution. * </p> * * @return The name of the domain containing the workflow execution. */ public String getDomain() { return this.domain; } /** * <p> * The name of the domain containing the workflow execution. * </p> * * @param domain * The name of the domain containing the workflow execution. * @return Returns a reference to this object so that method calls can be chained together. */ public GetWorkflowExecutionHistoryRequest withDomain(String domain) { setDomain(domain); return this; } /** * <p> * Specifies the workflow execution for which to return the history. * </p> * * @param execution * Specifies the workflow execution for which to return the history. */ public void setExecution(WorkflowExecution execution) { this.execution = execution; } /** * <p> * Specifies the workflow execution for which to return the history. * </p> * * @return Specifies the workflow execution for which to return the history. */ public WorkflowExecution getExecution() { return this.execution; } /** * <p> * Specifies the workflow execution for which to return the history. * </p> * * @param execution * Specifies the workflow execution for which to return the history. * @return Returns a reference to this object so that method calls can be chained together. */ public GetWorkflowExecutionHistoryRequest withExecution(WorkflowExecution execution) { setExecution(execution); return this; } /** * <p> * If <code>NextPageToken</code> is returned there are more results available. The value of * <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using the returned * token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 * seconds. Using an expired pagination token will return a <code>400</code> error: " * <code>Specified token has exceeded its maximum lifetime</code>". * </p> * <p> * The configured <code>maximumPageSize</code> determines how many results can be returned in a single call. * </p> * * @param nextPageToken * If <code>NextPageToken</code> is returned there are more results available. The value of * <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using the * returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token * expires after 60 seconds. Using an expired pagination token will return a <code>400</code> error: " * <code>Specified token has exceeded its maximum lifetime</code>". </p> * <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; } /** * <p> * If <code>NextPageToken</code> is returned there are more results available. The value of * <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using the returned * token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 * seconds. Using an expired pagination token will return a <code>400</code> error: " * <code>Specified token has exceeded its maximum lifetime</code>". * </p> * <p> * The configured <code>maximumPageSize</code> determines how many results can be returned in a single call. * </p> * * @return If <code>NextPageToken</code> is returned there are more results available. The value of * <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using the * returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token * expires after 60 seconds. Using an expired pagination token will return a <code>400</code> error: " * <code>Specified token has exceeded its maximum lifetime</code>". </p> * <p> * The configured <code>maximumPageSize</code> determines how many results can be returned in a single call. */ public String getNextPageToken() { return this.nextPageToken; } /** * <p> * If <code>NextPageToken</code> is returned there are more results available. The value of * <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using the returned * token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 60 * seconds. Using an expired pagination token will return a <code>400</code> error: " * <code>Specified token has exceeded its maximum lifetime</code>". * </p> * <p> * The configured <code>maximumPageSize</code> determines how many results can be returned in a single call. * </p> * * @param nextPageToken * If <code>NextPageToken</code> is returned there are more results available. The value of * <code>NextPageToken</code> is a unique pagination token for each page. Make the call again using the * returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token * expires after 60 seconds. Using an expired pagination token will return a <code>400</code> error: " * <code>Specified token has exceeded its maximum lifetime</code>". </p> * <p> * The configured <code>maximumPageSize</code> determines how many results can be returned in a single call. * @return Returns a reference to this object so that method calls can be chained together. */ public GetWorkflowExecutionHistoryRequest withNextPageToken(String nextPageToken) { setNextPageToken(nextPageToken); return this; } /** * <p> * The maximum number of results that are returned per call. Use <code>nextPageToken</code> to obtain further pages * of results. * </p> * * @param maximumPageSize * The maximum number of results that are returned per call. Use <code>nextPageToken</code> to obtain further * pages of results. */ public void setMaximumPageSize(Integer maximumPageSize) { this.maximumPageSize = maximumPageSize; } /** * <p> * The maximum number of results that are returned per call. Use <code>nextPageToken</code> to obtain further pages * of results. * </p> * * @return The maximum number of results that are returned per call. Use <code>nextPageToken</code> to obtain * further pages of results. */ public Integer getMaximumPageSize() { return this.maximumPageSize; } /** * <p> * The maximum number of results that are returned per call. Use <code>nextPageToken</code> to obtain further pages * of results. * </p> * * @param maximumPageSize * The maximum number of results that are returned per call. Use <code>nextPageToken</code> to obtain further * pages of results. * @return Returns a reference to this object so that method calls can be chained together. */ public GetWorkflowExecutionHistoryRequest withMaximumPageSize(Integer maximumPageSize) { setMaximumPageSize(maximumPageSize); return this; } /** * <p> * When set to <code>true</code>, returns the events in reverse order. By default the results are returned in * ascending order of the <code>eventTimeStamp</code> of the events. * </p> * * @param reverseOrder * When set to <code>true</code>, returns the events in reverse order. By default the results are returned in * ascending order of the <code>eventTimeStamp</code> of the events. */ public void setReverseOrder(Boolean reverseOrder) { this.reverseOrder = reverseOrder; } /** * <p> * When set to <code>true</code>, returns the events in reverse order. By default the results are returned in * ascending order of the <code>eventTimeStamp</code> of the events. * </p> * * @return When set to <code>true</code>, returns the events in reverse order. By default the results are returned * in ascending order of the <code>eventTimeStamp</code> of the events. */ public Boolean getReverseOrder() { return this.reverseOrder; } /** * <p> * When set to <code>true</code>, returns the events in reverse order. By default the results are returned in * ascending order of the <code>eventTimeStamp</code> of the events. * </p> * * @param reverseOrder * When set to <code>true</code>, returns the events in reverse order. By default the results are returned in * ascending order of the <code>eventTimeStamp</code> of the events. * @return Returns a reference to this object so that method calls can be chained together. */ public GetWorkflowExecutionHistoryRequest withReverseOrder(Boolean reverseOrder) { setReverseOrder(reverseOrder); return this; } /** * <p> * When set to <code>true</code>, returns the events in reverse order. By default the results are returned in * ascending order of the <code>eventTimeStamp</code> of the events. * </p> * * @return When set to <code>true</code>, returns the events in reverse order. By default the results are returned * in ascending order of the <code>eventTimeStamp</code> of the events. */ public Boolean isReverseOrder() { return this.reverseOrder; } /** * Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be * redacted from this string using a placeholder value. * * @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: ").append(getDomain()).append(","); if (getExecution() != null) sb.append("Execution: ").append(getExecution()).append(","); if (getNextPageToken() != null) sb.append("NextPageToken: ").append(getNextPageToken()).append(","); if (getMaximumPageSize() != null) sb.append("MaximumPageSize: ").append(getMaximumPageSize()).append(","); if (getReverseOrder() != null) sb.append("ReverseOrder: ").append(getReverseOrder()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetWorkflowExecutionHistoryRequest == false) return false; GetWorkflowExecutionHistoryRequest other = (GetWorkflowExecutionHistoryRequest) obj; if (other.getDomain() == null ^ this.getDomain() == null) return false; if (other.getDomain() != null && other.getDomain().equals(this.getDomain()) == false) return false; if (other.getExecution() == null ^ this.getExecution() == null) return false; if (other.getExecution() != null && other.getExecution().equals(this.getExecution()) == 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.getReverseOrder() == null ^ this.getReverseOrder() == null) return false; if (other.getReverseOrder() != null && other.getReverseOrder().equals(this.getReverseOrder()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getDomain() == null) ? 0 : getDomain().hashCode()); hashCode = prime * hashCode + ((getExecution() == null) ? 0 : getExecution().hashCode()); hashCode = prime * hashCode + ((getNextPageToken() == null) ? 0 : getNextPageToken().hashCode()); hashCode = prime * hashCode + ((getMaximumPageSize() == null) ? 0 : getMaximumPageSize().hashCode()); hashCode = prime * hashCode + ((getReverseOrder() == null) ? 0 : getReverseOrder().hashCode()); return hashCode; } @Override public GetWorkflowExecutionHistoryRequest clone() { return (GetWorkflowExecutionHistoryRequest) super.clone(); } }