/* * Copyright 2018-2023 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.stepfunctions.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetExecutionHistoryRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The Amazon Resource Name (ARN) of the execution. *
*/ private String executionArn; /** *
* The maximum number of results that are returned per call. You can use nextToken
to obtain further
* pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
*
* This is only an upper limit. The actual number of results returned per call might be fewer than the specified * maximum. *
*/ private Integer maxResults; /** *
* Lists events in descending order of their timeStamp
.
*
* If nextToken
is returned, there are more results available. The value of nextToken
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 24 hours. Using an expired pagination
* token will return an HTTP 400 InvalidToken error.
*
* You can select whether execution data (input or output of a history event) is returned. The default is
* true
.
*
* The Amazon Resource Name (ARN) of the execution. *
* * @param executionArn * The Amazon Resource Name (ARN) of the execution. */ public void setExecutionArn(String executionArn) { this.executionArn = executionArn; } /** ** The Amazon Resource Name (ARN) of the execution. *
* * @return The Amazon Resource Name (ARN) of the execution. */ public String getExecutionArn() { return this.executionArn; } /** ** The Amazon Resource Name (ARN) of the execution. *
* * @param executionArn * The Amazon Resource Name (ARN) of the execution. * @return Returns a reference to this object so that method calls can be chained together. */ public GetExecutionHistoryRequest withExecutionArn(String executionArn) { setExecutionArn(executionArn); return this; } /** *
* The maximum number of results that are returned per call. You can use nextToken
to obtain further
* pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
*
* This is only an upper limit. The actual number of results returned per call might be fewer than the specified * maximum. *
* * @param maxResults * The maximum number of results that are returned per call. You can usenextToken
to obtain
* further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses
* the default.
* * This is only an upper limit. The actual number of results returned per call might be fewer than the * specified maximum. */ public void setMaxResults(Integer maxResults) { this.maxResults = maxResults; } /** *
* The maximum number of results that are returned per call. You can use nextToken
to obtain further
* pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
*
* This is only an upper limit. The actual number of results returned per call might be fewer than the specified * maximum. *
* * @return The maximum number of results that are returned per call. You can usenextToken
to obtain
* further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses
* the default.
* * This is only an upper limit. The actual number of results returned per call might be fewer than the * specified maximum. */ public Integer getMaxResults() { return this.maxResults; } /** *
* The maximum number of results that are returned per call. You can use nextToken
to obtain further
* pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default.
*
* This is only an upper limit. The actual number of results returned per call might be fewer than the specified * maximum. *
* * @param maxResults * The maximum number of results that are returned per call. You can usenextToken
to obtain
* further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses
* the default.
* * This is only an upper limit. The actual number of results returned per call might be fewer than the * specified maximum. * @return Returns a reference to this object so that method calls can be chained together. */ public GetExecutionHistoryRequest withMaxResults(Integer maxResults) { setMaxResults(maxResults); return this; } /** *
* Lists events in descending order of their timeStamp
.
*
timeStamp
.
*/
public void setReverseOrder(Boolean reverseOrder) {
this.reverseOrder = reverseOrder;
}
/**
*
* Lists events in descending order of their timeStamp
.
*
timeStamp
.
*/
public Boolean getReverseOrder() {
return this.reverseOrder;
}
/**
*
* Lists events in descending order of their timeStamp
.
*
timeStamp
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetExecutionHistoryRequest withReverseOrder(Boolean reverseOrder) {
setReverseOrder(reverseOrder);
return this;
}
/**
*
* Lists events in descending order of their timeStamp
.
*
timeStamp
.
*/
public Boolean isReverseOrder() {
return this.reverseOrder;
}
/**
*
* If nextToken
is returned, there are more results available. The value of nextToken
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 24 hours. Using an expired pagination
* token will return an HTTP 400 InvalidToken error.
*
nextToken
is returned, there are more results available. The value of
* nextToken
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
* 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* If nextToken
is returned, there are more results available. The value of nextToken
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 24 hours. Using an expired pagination
* token will return an HTTP 400 InvalidToken error.
*
nextToken
is returned, there are more results available. The value of
* nextToken
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
* 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* If nextToken
is returned, there are more results available. The value of nextToken
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 24 hours. Using an expired pagination
* token will return an HTTP 400 InvalidToken error.
*
nextToken
is returned, there are more results available. The value of
* nextToken
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
* 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetExecutionHistoryRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* You can select whether execution data (input or output of a history event) is returned. The default is
* true
.
*
true
.
*/
public void setIncludeExecutionData(Boolean includeExecutionData) {
this.includeExecutionData = includeExecutionData;
}
/**
*
* You can select whether execution data (input or output of a history event) is returned. The default is
* true
.
*
true
.
*/
public Boolean getIncludeExecutionData() {
return this.includeExecutionData;
}
/**
*
* You can select whether execution data (input or output of a history event) is returned. The default is
* true
.
*
true
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetExecutionHistoryRequest withIncludeExecutionData(Boolean includeExecutionData) {
setIncludeExecutionData(includeExecutionData);
return this;
}
/**
*
* You can select whether execution data (input or output of a history event) is returned. The default is
* true
.
*
true
.
*/
public Boolean isIncludeExecutionData() {
return this.includeExecutionData;
}
/**
* 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 (getExecutionArn() != null)
sb.append("ExecutionArn: ").append(getExecutionArn()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getReverseOrder() != null)
sb.append("ReverseOrder: ").append(getReverseOrder()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getIncludeExecutionData() != null)
sb.append("IncludeExecutionData: ").append(getIncludeExecutionData());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetExecutionHistoryRequest == false)
return false;
GetExecutionHistoryRequest other = (GetExecutionHistoryRequest) obj;
if (other.getExecutionArn() == null ^ this.getExecutionArn() == null)
return false;
if (other.getExecutionArn() != null && other.getExecutionArn().equals(this.getExecutionArn()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getReverseOrder() == null ^ this.getReverseOrder() == null)
return false;
if (other.getReverseOrder() != null && other.getReverseOrder().equals(this.getReverseOrder()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getIncludeExecutionData() == null ^ this.getIncludeExecutionData() == null)
return false;
if (other.getIncludeExecutionData() != null && other.getIncludeExecutionData().equals(this.getIncludeExecutionData()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getExecutionArn() == null) ? 0 : getExecutionArn().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getReverseOrder() == null) ? 0 : getReverseOrder().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getIncludeExecutionData() == null) ? 0 : getIncludeExecutionData().hashCode());
return hashCode;
}
@Override
public GetExecutionHistoryRequest clone() {
return (GetExecutionHistoryRequest) super.clone();
}
}