software.amazon.awssdk.services.athena.model.ListSessionsRequest Maven / Gradle / Ivy
Show all versions of athena Show documentation
/*
* 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.athena.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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 ListSessionsRequest extends AthenaRequest implements
ToCopyableBuilder {
private static final SdkField WORK_GROUP_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("WorkGroup").getter(getter(ListSessionsRequest::workGroup)).setter(setter(Builder::workGroup))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("WorkGroup").build()).build();
private static final SdkField STATE_FILTER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StateFilter").getter(getter(ListSessionsRequest::stateFilterAsString))
.setter(setter(Builder::stateFilter))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StateFilter").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(ListSessionsRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListSessionsRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(WORK_GROUP_FIELD,
STATE_FILTER_FIELD, MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("WorkGroup", WORK_GROUP_FIELD);
put("StateFilter", STATE_FILTER_FIELD);
put("MaxResults", MAX_RESULTS_FIELD);
put("NextToken", NEXT_TOKEN_FIELD);
}
});
private final String workGroup;
private final String stateFilter;
private final Integer maxResults;
private final String nextToken;
private ListSessionsRequest(BuilderImpl builder) {
super(builder);
this.workGroup = builder.workGroup;
this.stateFilter = builder.stateFilter;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
}
/**
*
* The workgroup to which the session belongs.
*
*
* @return The workgroup to which the session belongs.
*/
public final String workGroup() {
return workGroup;
}
/**
*
* A filter for a specific session state. A description of each state follows.
*
*
* CREATING - The session is being started, including acquiring resources.
*
*
* CREATED - The session has been started.
*
*
* IDLE - The session is able to accept a calculation.
*
*
* BUSY - The session is processing another task and is unable to accept a calculation.
*
*
* TERMINATING - The session is in the process of shutting down.
*
*
* TERMINATED - The session and its resources are no longer running.
*
*
* DEGRADED - The session has no healthy coordinators.
*
*
* FAILED - Due to a failure, the session and its resources are no longer running.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #stateFilter} will
* return {@link SessionState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateFilterAsString}.
*
*
* @return A filter for a specific session state. A description of each state follows.
*
* CREATING - The session is being started, including acquiring resources.
*
*
* CREATED - The session has been started.
*
*
* IDLE - The session is able to accept a calculation.
*
*
* BUSY - The session is processing another task and is unable to accept a calculation.
*
*
* TERMINATING - The session is in the process of shutting down.
*
*
* TERMINATED - The session and its resources are no longer running.
*
*
* DEGRADED - The session has no healthy coordinators.
*
*
* FAILED - Due to a failure, the session and its resources are no longer running.
* @see SessionState
*/
public final SessionState stateFilter() {
return SessionState.fromValue(stateFilter);
}
/**
*
* A filter for a specific session state. A description of each state follows.
*
*
* CREATING - The session is being started, including acquiring resources.
*
*
* CREATED - The session has been started.
*
*
* IDLE - The session is able to accept a calculation.
*
*
* BUSY - The session is processing another task and is unable to accept a calculation.
*
*
* TERMINATING - The session is in the process of shutting down.
*
*
* TERMINATED - The session and its resources are no longer running.
*
*
* DEGRADED - The session has no healthy coordinators.
*
*
* FAILED - Due to a failure, the session and its resources are no longer running.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #stateFilter} will
* return {@link SessionState#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #stateFilterAsString}.
*
*
* @return A filter for a specific session state. A description of each state follows.
*
* CREATING - The session is being started, including acquiring resources.
*
*
* CREATED - The session has been started.
*
*
* IDLE - The session is able to accept a calculation.
*
*
* BUSY - The session is processing another task and is unable to accept a calculation.
*
*
* TERMINATING - The session is in the process of shutting down.
*
*
* TERMINATED - The session and its resources are no longer running.
*
*
* DEGRADED - The session has no healthy coordinators.
*
*
* FAILED - Due to a failure, the session and its resources are no longer running.
* @see SessionState
*/
public final String stateFilterAsString() {
return stateFilter;
}
/**
*
* The maximum number of sessions to return.
*
*
* @return The maximum number of sessions to return.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* A token generated by the Athena service that specifies where to continue pagination if a previous request was
* truncated. To obtain the next set of pages, pass in the NextToken from the response object of the
* previous page call.
*
*
* @return A token generated by the Athena service that specifies where to continue pagination if a previous request
* was truncated. To obtain the next set of pages, pass in the NextToken from the response
* object of the previous page call.
*/
public final 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 final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(workGroup());
hashCode = 31 * hashCode + Objects.hashCode(stateFilterAsString());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ListSessionsRequest)) {
return false;
}
ListSessionsRequest other = (ListSessionsRequest) obj;
return Objects.equals(workGroup(), other.workGroup())
&& Objects.equals(stateFilterAsString(), other.stateFilterAsString())
&& Objects.equals(maxResults(), other.maxResults()) && Objects.equals(nextToken(), other.nextToken());
}
/**
* 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 final String toString() {
return ToString.builder("ListSessionsRequest").add("WorkGroup", workGroup()).add("StateFilter", stateFilterAsString())
.add("MaxResults", maxResults()).add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "WorkGroup":
return Optional.ofNullable(clazz.cast(workGroup()));
case "StateFilter":
return Optional.ofNullable(clazz.cast(stateFilterAsString()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((ListSessionsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends AthenaRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The workgroup to which the session belongs.
*
*
* @param workGroup
* The workgroup to which the session belongs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder workGroup(String workGroup);
/**
*
* A filter for a specific session state. A description of each state follows.
*
*
* CREATING - The session is being started, including acquiring resources.
*
*
* CREATED - The session has been started.
*
*
* IDLE - The session is able to accept a calculation.
*
*
* BUSY - The session is processing another task and is unable to accept a calculation.
*
*
* TERMINATING - The session is in the process of shutting down.
*
*
* TERMINATED - The session and its resources are no longer running.
*
*
* DEGRADED - The session has no healthy coordinators.
*
*
* FAILED - Due to a failure, the session and its resources are no longer running.
*
*
* @param stateFilter
* A filter for a specific session state. A description of each state follows.
*
* CREATING - The session is being started, including acquiring resources.
*
*
* CREATED - The session has been started.
*
*
* IDLE - The session is able to accept a calculation.
*
*
* BUSY - The session is processing another task and is unable to accept a calculation.
*
*
* TERMINATING - The session is in the process of shutting down.
*
*
* TERMINATED - The session and its resources are no longer running.
*
*
* DEGRADED - The session has no healthy coordinators.
*
*
* FAILED - Due to a failure, the session and its resources are no longer running.
* @see SessionState
* @return Returns a reference to this object so that method calls can be chained together.
* @see SessionState
*/
Builder stateFilter(String stateFilter);
/**
*
* A filter for a specific session state. A description of each state follows.
*
*
* CREATING - The session is being started, including acquiring resources.
*
*
* CREATED - The session has been started.
*
*
* IDLE - The session is able to accept a calculation.
*
*
* BUSY - The session is processing another task and is unable to accept a calculation.
*
*
* TERMINATING - The session is in the process of shutting down.
*
*
* TERMINATED - The session and its resources are no longer running.
*
*
* DEGRADED - The session has no healthy coordinators.
*
*
* FAILED - Due to a failure, the session and its resources are no longer running.
*
*
* @param stateFilter
* A filter for a specific session state. A description of each state follows.
*
* CREATING - The session is being started, including acquiring resources.
*
*
* CREATED - The session has been started.
*
*
* IDLE - The session is able to accept a calculation.
*
*
* BUSY - The session is processing another task and is unable to accept a calculation.
*
*
* TERMINATING - The session is in the process of shutting down.
*
*
* TERMINATED - The session and its resources are no longer running.
*
*
* DEGRADED - The session has no healthy coordinators.
*
*
* FAILED - Due to a failure, the session and its resources are no longer running.
* @see SessionState
* @return Returns a reference to this object so that method calls can be chained together.
* @see SessionState
*/
Builder stateFilter(SessionState stateFilter);
/**
*
* The maximum number of sessions to return.
*
*
* @param maxResults
* The maximum number of sessions to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* A token generated by the Athena service that specifies where to continue pagination if a previous request was
* truncated. To obtain the next set of pages, pass in the NextToken from the response object of
* the previous page call.
*
*
* @param nextToken
* A token generated by the Athena service that specifies where to continue pagination if a previous
* request was truncated. To obtain the next set of pages, pass in the NextToken from the
* response object of the previous page call.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends AthenaRequest.BuilderImpl implements Builder {
private String workGroup;
private String stateFilter;
private Integer maxResults;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(ListSessionsRequest model) {
super(model);
workGroup(model.workGroup);
stateFilter(model.stateFilter);
maxResults(model.maxResults);
nextToken(model.nextToken);
}
public final String getWorkGroup() {
return workGroup;
}
public final void setWorkGroup(String workGroup) {
this.workGroup = workGroup;
}
@Override
public final Builder workGroup(String workGroup) {
this.workGroup = workGroup;
return this;
}
public final String getStateFilter() {
return stateFilter;
}
public final void setStateFilter(String stateFilter) {
this.stateFilter = stateFilter;
}
@Override
public final Builder stateFilter(String stateFilter) {
this.stateFilter = stateFilter;
return this;
}
@Override
public final Builder stateFilter(SessionState stateFilter) {
this.stateFilter(stateFilter == null ? null : stateFilter.toString());
return this;
}
public final Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final String getNextToken() {
return nextToken;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListSessionsRequest build() {
return new ListSessionsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}