software.amazon.awssdk.services.deadline.model.ListQueuesRequest Maven / Gradle / Ivy
Show all versions of deadline 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.deadline.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 ListQueuesRequest extends DeadlineRequest implements
ToCopyableBuilder {
private static final SdkField FARM_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("farmId")
.getter(getter(ListQueuesRequest::farmId)).setter(setter(Builder::farmId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("farmId").build()).build();
private static final SdkField PRINCIPAL_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("principalId").getter(getter(ListQueuesRequest::principalId)).setter(setter(Builder::principalId))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("principalId").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("status")
.getter(getter(ListQueuesRequest::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("status").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(ListQueuesRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("nextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("maxResults").getter(getter(ListQueuesRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("maxResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FARM_ID_FIELD,
PRINCIPAL_ID_FIELD, STATUS_FIELD, NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private final String farmId;
private final String principalId;
private final String status;
private final String nextToken;
private final Integer maxResults;
private ListQueuesRequest(BuilderImpl builder) {
super(builder);
this.farmId = builder.farmId;
this.principalId = builder.principalId;
this.status = builder.status;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
*
* The farm ID of the queue.
*
*
* @return The farm ID of the queue.
*/
public final String farmId() {
return farmId;
}
/**
*
* The principal IDs to include in the list of queues.
*
*
* @return The principal IDs to include in the list of queues.
*/
public final String principalId() {
return principalId;
}
/**
*
* The status of the queues listed.
*
*
* -
*
* ACTIVE–The queues are active.
*
*
* -
*
* SCHEDULING–The queues are scheduling.
*
*
* -
*
* SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link QueueStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of the queues listed.
*
* -
*
* ACTIVE–The queues are active.
*
*
* -
*
* SCHEDULING–The queues are scheduling.
*
*
* -
*
* SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.
*
*
* @see QueueStatus
*/
public final QueueStatus status() {
return QueueStatus.fromValue(status);
}
/**
*
* The status of the queues listed.
*
*
* -
*
* ACTIVE–The queues are active.
*
*
* -
*
* SCHEDULING–The queues are scheduling.
*
*
* -
*
* SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link QueueStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #statusAsString}.
*
*
* @return The status of the queues listed.
*
* -
*
* ACTIVE–The queues are active.
*
*
* -
*
* SCHEDULING–The queues are scheduling.
*
*
* -
*
* SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.
*
*
* @see QueueStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* The token for the next set of results, or null to start from the beginning.
*
*
* @return The token for the next set of results, or null to start from the beginning.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of results to return. Use this parameter with NextToken to get results as a set
* of sequential pages.
*
*
* @return The maximum number of results to return. Use this parameter with NextToken to get results as
* a set of sequential pages.
*/
public final Integer maxResults() {
return maxResults;
}
@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(farmId());
hashCode = 31 * hashCode + Objects.hashCode(principalId());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
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 ListQueuesRequest)) {
return false;
}
ListQueuesRequest other = (ListQueuesRequest) obj;
return Objects.equals(farmId(), other.farmId()) && Objects.equals(principalId(), other.principalId())
&& Objects.equals(statusAsString(), other.statusAsString()) && Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(maxResults(), other.maxResults());
}
/**
* 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("ListQueuesRequest").add("FarmId", farmId()).add("PrincipalId", principalId())
.add("Status", statusAsString()).add("NextToken", nextToken()).add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "farmId":
return Optional.ofNullable(clazz.cast(farmId()));
case "principalId":
return Optional.ofNullable(clazz.cast(principalId()));
case "status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "maxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListQueuesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends DeadlineRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The farm ID of the queue.
*
*
* @param farmId
* The farm ID of the queue.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder farmId(String farmId);
/**
*
* The principal IDs to include in the list of queues.
*
*
* @param principalId
* The principal IDs to include in the list of queues.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder principalId(String principalId);
/**
*
* The status of the queues listed.
*
*
* -
*
* ACTIVE–The queues are active.
*
*
* -
*
* SCHEDULING–The queues are scheduling.
*
*
* -
*
* SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.
*
*
*
*
* @param status
* The status of the queues listed.
*
* -
*
* ACTIVE–The queues are active.
*
*
* -
*
* SCHEDULING–The queues are scheduling.
*
*
* -
*
* SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.
*
*
* @see QueueStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see QueueStatus
*/
Builder status(String status);
/**
*
* The status of the queues listed.
*
*
* -
*
* ACTIVE–The queues are active.
*
*
* -
*
* SCHEDULING–The queues are scheduling.
*
*
* -
*
* SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.
*
*
*
*
* @param status
* The status of the queues listed.
*
* -
*
* ACTIVE–The queues are active.
*
*
* -
*
* SCHEDULING–The queues are scheduling.
*
*
* -
*
* SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.
*
*
* @see QueueStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see QueueStatus
*/
Builder status(QueueStatus status);
/**
*
* The token for the next set of results, or null to start from the beginning.
*
*
* @param nextToken
* The token for the next set of results, or null to start from the beginning.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of results to return. Use this parameter with NextToken to get results as a
* set of sequential pages.
*
*
* @param maxResults
* The maximum number of results to return. Use this parameter with NextToken to get results
* as a set of sequential pages.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends DeadlineRequest.BuilderImpl implements Builder {
private String farmId;
private String principalId;
private String status;
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(ListQueuesRequest model) {
super(model);
farmId(model.farmId);
principalId(model.principalId);
status(model.status);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final String getFarmId() {
return farmId;
}
public final void setFarmId(String farmId) {
this.farmId = farmId;
}
@Override
public final Builder farmId(String farmId) {
this.farmId = farmId;
return this;
}
public final String getPrincipalId() {
return principalId;
}
public final void setPrincipalId(String principalId) {
this.principalId = principalId;
}
@Override
public final Builder principalId(String principalId) {
this.principalId = principalId;
return this;
}
public final String getStatus() {
return status;
}
public final void setStatus(String status) {
this.status = status;
}
@Override
public final Builder status(String status) {
this.status = status;
return this;
}
@Override
public final Builder status(QueueStatus status) {
this.status(status == null ? null : status.toString());
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;
}
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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListQueuesRequest build() {
return new ListQueuesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}