software.amazon.awssdk.services.sfn.model.GetExecutionHistoryRequest Maven / Gradle / Ivy
Show all versions of stepfunctions Show documentation
/*
* Copyright 2012-2017 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 software.amazon.awssdk.services.sfn.model;
import java.util.Objects;
import java.util.Optional;
import java.util.function.Consumer;
import javax.annotation.Generated;
import software.amazon.awssdk.core.AwsRequestOverrideConfig;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public class GetExecutionHistoryRequest extends SFNRequest implements
ToCopyableBuilder {
private final String executionArn;
private final Integer maxResults;
private final Boolean reverseOrder;
private final String nextToken;
private GetExecutionHistoryRequest(BuilderImpl builder) {
super(builder);
this.executionArn = builder.executionArn;
this.maxResults = builder.maxResults;
this.reverseOrder = builder.reverseOrder;
this.nextToken = builder.nextToken;
}
/**
*
* The Amazon Resource Name (ARN) of the execution.
*
*
* @return The Amazon Resource Name (ARN) of the execution.
*/
public String executionArn() {
return 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 100. 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 use nextToken to obtain
* further pages of results. The default is 100 and the maximum allowed page size is 100. 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 maxResults() {
return maxResults;
}
/**
*
* Lists events in descending order of their timeStamp.
*
*
* @return Lists events in descending order of their timeStamp.
*/
public Boolean reverseOrder() {
return reverseOrder;
}
/**
*
* If a nextToken is 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 nextToken. Keep all other
* arguments unchanged.
*
*
* The configured maxResults determines how many results can be returned in a single call.
*
*
* @return If a nextToken is 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 nextToken. Keep
* all other arguments unchanged.
*
* The configured maxResults determines how many results can be returned in a single call.
*/
public String nextToken() {
return nextToken;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(executionArn());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(reverseOrder());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetExecutionHistoryRequest)) {
return false;
}
GetExecutionHistoryRequest other = (GetExecutionHistoryRequest) obj;
return Objects.equals(executionArn(), other.executionArn()) && Objects.equals(maxResults(), other.maxResults())
&& Objects.equals(reverseOrder(), other.reverseOrder()) && Objects.equals(nextToken(), other.nextToken());
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder("{");
if (executionArn() != null) {
sb.append("ExecutionArn: ").append(executionArn()).append(",");
}
if (maxResults() != null) {
sb.append("MaxResults: ").append(maxResults()).append(",");
}
if (reverseOrder() != null) {
sb.append("ReverseOrder: ").append(reverseOrder()).append(",");
}
if (nextToken() != null) {
sb.append("NextToken: ").append(nextToken()).append(",");
}
if (sb.length() > 1) {
sb.setLength(sb.length() - 1);
}
sb.append("}");
return sb.toString();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "executionArn":
return Optional.of(clazz.cast(executionArn()));
case "maxResults":
return Optional.of(clazz.cast(maxResults()));
case "reverseOrder":
return Optional.of(clazz.cast(reverseOrder()));
case "nextToken":
return Optional.of(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
public interface Builder extends SFNRequest.Builder, CopyableBuilder {
/**
*
* 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.
*/
Builder executionArn(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 100. 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 use nextToken to obtain
* further pages of results. The default is 100 and the maximum allowed page size is 100. 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.
*/
Builder maxResults(Integer maxResults);
/**
*
* Lists events in descending order of their timeStamp.
*
*
* @param reverseOrder
* Lists events in descending order of their timeStamp.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reverseOrder(Boolean reverseOrder);
/**
*
* If a nextToken is 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 nextToken. Keep all other
* arguments unchanged.
*
*
* The configured maxResults determines how many results can be returned in a single call.
*
*
* @param nextToken
* If a nextToken is 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
* nextToken. Keep all other arguments unchanged.
*
* The configured maxResults 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.
*/
Builder nextToken(String nextToken);
@Override
Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig);
}
static final class BuilderImpl extends SFNRequest.BuilderImpl implements Builder {
private String executionArn;
private Integer maxResults;
private Boolean reverseOrder;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(GetExecutionHistoryRequest model) {
executionArn(model.executionArn);
maxResults(model.maxResults);
reverseOrder(model.reverseOrder);
nextToken(model.nextToken);
}
public final String getExecutionArn() {
return executionArn;
}
@Override
public final Builder executionArn(String executionArn) {
this.executionArn = executionArn;
return this;
}
public final void setExecutionArn(String executionArn) {
this.executionArn = executionArn;
}
public final Integer getMaxResults() {
return maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
public final Boolean getReverseOrder() {
return reverseOrder;
}
@Override
public final Builder reverseOrder(Boolean reverseOrder) {
this.reverseOrder = reverseOrder;
return this;
}
public final void setReverseOrder(Boolean reverseOrder) {
this.reverseOrder = reverseOrder;
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) {
super.requestOverrideConfig(awsRequestOverrideConfig);
return this;
}
@Override
public Builder requestOverrideConfig(Consumer builderConsumer) {
super.requestOverrideConfig(builderConsumer);
return this;
}
@Override
public GetExecutionHistoryRequest build() {
return new GetExecutionHistoryRequest(this);
}
}
}