software.amazon.awssdk.services.swf.model.GetWorkflowExecutionHistoryRequest Maven / Gradle / Ivy
/*
* Copyright 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.swf.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetWorkflowExecutionHistoryRequest extends SwfRequest implements
ToCopyableBuilder {
private static final SdkField DOMAIN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(GetWorkflowExecutionHistoryRequest::domain)).setter(setter(Builder::domain))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("domain").build()).build();
private static final SdkField EXECUTION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).getter(getter(GetWorkflowExecutionHistoryRequest::execution))
.setter(setter(Builder::execution)).constructor(WorkflowExecution::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("execution").build()).build();
private static final SdkField NEXT_PAGE_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(GetWorkflowExecutionHistoryRequest::nextPageToken)).setter(setter(Builder::nextPageToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("nextPageToken").build()).build();
private static final SdkField MAXIMUM_PAGE_SIZE_FIELD = SdkField. builder(MarshallingType.INTEGER)
.getter(getter(GetWorkflowExecutionHistoryRequest::maximumPageSize)).setter(setter(Builder::maximumPageSize))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("maximumPageSize").build()).build();
private static final SdkField REVERSE_ORDER_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.getter(getter(GetWorkflowExecutionHistoryRequest::reverseOrder)).setter(setter(Builder::reverseOrder))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("reverseOrder").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOMAIN_FIELD, EXECUTION_FIELD,
NEXT_PAGE_TOKEN_FIELD, MAXIMUM_PAGE_SIZE_FIELD, REVERSE_ORDER_FIELD));
private final String domain;
private final WorkflowExecution execution;
private final String nextPageToken;
private final Integer maximumPageSize;
private final Boolean reverseOrder;
private GetWorkflowExecutionHistoryRequest(BuilderImpl builder) {
super(builder);
this.domain = builder.domain;
this.execution = builder.execution;
this.nextPageToken = builder.nextPageToken;
this.maximumPageSize = builder.maximumPageSize;
this.reverseOrder = builder.reverseOrder;
}
/**
*
* The name of the domain containing the workflow execution.
*
*
* @return The name of the domain containing the workflow execution.
*/
public String domain() {
return domain;
}
/**
*
* Specifies the workflow execution for which to return the history.
*
*
* @return Specifies the workflow execution for which to return the history.
*/
public WorkflowExecution execution() {
return execution;
}
/**
*
* If NextPageToken is returned there are more results available. The value of
* NextPageToken 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 400 error: "
* Specified token has exceeded its maximum lifetime".
*
*
* The configured maximumPageSize determines how many results can be returned in a single call.
*
*
* @return If NextPageToken is returned there are more results available. The value of
* NextPageToken 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 400 error: "
* Specified token has exceeded its maximum lifetime".
*
* The configured maximumPageSize determines how many results can be returned in a single call.
*/
public String nextPageToken() {
return nextPageToken;
}
/**
*
* The maximum number of results that are returned per call. Use nextPageToken to obtain further pages
* of results.
*
*
* @return The maximum number of results that are returned per call. Use nextPageToken to obtain
* further pages of results.
*/
public Integer maximumPageSize() {
return maximumPageSize;
}
/**
*
* When set to true, returns the events in reverse order. By default the results are returned in
* ascending order of the eventTimeStamp of the events.
*
*
* @return When set to true, returns the events in reverse order. By default the results are returned
* in ascending order of the eventTimeStamp of the events.
*/
public Boolean reverseOrder() {
return reverseOrder;
}
@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 + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(domain());
hashCode = 31 * hashCode + Objects.hashCode(execution());
hashCode = 31 * hashCode + Objects.hashCode(nextPageToken());
hashCode = 31 * hashCode + Objects.hashCode(maximumPageSize());
hashCode = 31 * hashCode + Objects.hashCode(reverseOrder());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetWorkflowExecutionHistoryRequest)) {
return false;
}
GetWorkflowExecutionHistoryRequest other = (GetWorkflowExecutionHistoryRequest) obj;
return Objects.equals(domain(), other.domain()) && Objects.equals(execution(), other.execution())
&& Objects.equals(nextPageToken(), other.nextPageToken())
&& Objects.equals(maximumPageSize(), other.maximumPageSize())
&& Objects.equals(reverseOrder(), other.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.
*/
@Override
public String toString() {
return ToString.builder("GetWorkflowExecutionHistoryRequest").add("Domain", domain()).add("Execution", execution())
.add("NextPageToken", nextPageToken()).add("MaximumPageSize", maximumPageSize())
.add("ReverseOrder", reverseOrder()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "domain":
return Optional.ofNullable(clazz.cast(domain()));
case "execution":
return Optional.ofNullable(clazz.cast(execution()));
case "nextPageToken":
return Optional.ofNullable(clazz.cast(nextPageToken()));
case "maximumPageSize":
return Optional.ofNullable(clazz.cast(maximumPageSize()));
case "reverseOrder":
return Optional.ofNullable(clazz.cast(reverseOrder()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetWorkflowExecutionHistoryRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SwfRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The name of the domain containing the workflow execution.
*
*
* @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.
*/
Builder domain(String domain);
/**
*
* Specifies the workflow execution for which to return the history.
*
*
* @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.
*/
Builder execution(WorkflowExecution execution);
/**
*
* Specifies the workflow execution for which to return the history.
*
* This is a convenience that creates an instance of the {@link WorkflowExecution.Builder} avoiding the need to
* create one manually via {@link WorkflowExecution#builder()}.
*
* When the {@link Consumer} completes, {@link WorkflowExecution.Builder#build()} is called immediately and its
* result is passed to {@link #execution(WorkflowExecution)}.
*
* @param execution
* a consumer that will call methods on {@link WorkflowExecution.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #execution(WorkflowExecution)
*/
default Builder execution(Consumer execution) {
return execution(WorkflowExecution.builder().applyMutation(execution).build());
}
/**
*
* If NextPageToken is returned there are more results available. The value of
* NextPageToken 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 400 error: "
* Specified token has exceeded its maximum lifetime".
*
*
* The configured maximumPageSize determines how many results can be returned in a single call.
*
*
* @param nextPageToken
* If NextPageToken is returned there are more results available. The value of
* NextPageToken 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 400 error: "
* Specified token has exceeded its maximum lifetime".
*
* The configured maximumPageSize 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 nextPageToken(String nextPageToken);
/**
*
* The maximum number of results that are returned per call. Use nextPageToken to obtain further
* pages of results.
*
*
* @param maximumPageSize
* The maximum number of results that are returned per call. Use nextPageToken to obtain
* further pages of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maximumPageSize(Integer maximumPageSize);
/**
*
* When set to true, returns the events in reverse order. By default the results are returned in
* ascending order of the eventTimeStamp of the events.
*
*
* @param reverseOrder
* When set to true, returns the events in reverse order. By default the results are
* returned in ascending order of the eventTimeStamp of the events.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reverseOrder(Boolean reverseOrder);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends SwfRequest.BuilderImpl implements Builder {
private String domain;
private WorkflowExecution execution;
private String nextPageToken;
private Integer maximumPageSize;
private Boolean reverseOrder;
private BuilderImpl() {
}
private BuilderImpl(GetWorkflowExecutionHistoryRequest model) {
super(model);
domain(model.domain);
execution(model.execution);
nextPageToken(model.nextPageToken);
maximumPageSize(model.maximumPageSize);
reverseOrder(model.reverseOrder);
}
public final String getDomain() {
return domain;
}
@Override
public final Builder domain(String domain) {
this.domain = domain;
return this;
}
public final void setDomain(String domain) {
this.domain = domain;
}
public final WorkflowExecution.Builder getExecution() {
return execution != null ? execution.toBuilder() : null;
}
@Override
public final Builder execution(WorkflowExecution execution) {
this.execution = execution;
return this;
}
public final void setExecution(WorkflowExecution.BuilderImpl execution) {
this.execution = execution != null ? execution.build() : null;
}
public final String getNextPageToken() {
return nextPageToken;
}
@Override
public final Builder nextPageToken(String nextPageToken) {
this.nextPageToken = nextPageToken;
return this;
}
public final void setNextPageToken(String nextPageToken) {
this.nextPageToken = nextPageToken;
}
public final Integer getMaximumPageSize() {
return maximumPageSize;
}
@Override
public final Builder maximumPageSize(Integer maximumPageSize) {
this.maximumPageSize = maximumPageSize;
return this;
}
public final void setMaximumPageSize(Integer maximumPageSize) {
this.maximumPageSize = maximumPageSize;
}
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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetWorkflowExecutionHistoryRequest build() {
return new GetWorkflowExecutionHistoryRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy