software.amazon.awssdk.services.elasticbeanstalk.model.DescribeApplicationVersionsRequest Maven / Gradle / Ivy
Show all versions of elasticbeanstalk 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.elasticbeanstalk.model;
import java.util.Arrays;
import java.util.Collection;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Request to describe application versions.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeApplicationVersionsRequest extends ElasticBeanstalkRequest implements
ToCopyableBuilder {
private static final SdkField APPLICATION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ApplicationName").getter(getter(DescribeApplicationVersionsRequest::applicationName))
.setter(setter(Builder::applicationName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ApplicationName").build()).build();
private static final SdkField> VERSION_LABELS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("VersionLabels")
.getter(getter(DescribeApplicationVersionsRequest::versionLabels))
.setter(setter(Builder::versionLabels))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VersionLabels").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxRecords").getter(getter(DescribeApplicationVersionsRequest::maxRecords))
.setter(setter(Builder::maxRecords))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxRecords").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(DescribeApplicationVersionsRequest::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(APPLICATION_NAME_FIELD,
VERSION_LABELS_FIELD, MAX_RECORDS_FIELD, NEXT_TOKEN_FIELD));
private final String applicationName;
private final List versionLabels;
private final Integer maxRecords;
private final String nextToken;
private DescribeApplicationVersionsRequest(BuilderImpl builder) {
super(builder);
this.applicationName = builder.applicationName;
this.versionLabels = builder.versionLabels;
this.maxRecords = builder.maxRecords;
this.nextToken = builder.nextToken;
}
/**
*
* Specify an application name to show only application versions for that application.
*
*
* @return Specify an application name to show only application versions for that application.
*/
public final String applicationName() {
return applicationName;
}
/**
* For responses, this returns true if the service returned a value for the VersionLabels property. This DOES NOT
* check that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property).
* This is useful because the SDK will never return a null collection or map, but you may need to differentiate
* between the service returning nothing (or null) and the service returning an empty collection or map. For
* requests, this returns true if a value for the property was specified in the request builder, and false if a
* value was not specified.
*/
public final boolean hasVersionLabels() {
return versionLabels != null && !(versionLabels instanceof SdkAutoConstructList);
}
/**
*
* Specify a version label to show a specific application version.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasVersionLabels} method.
*
*
* @return Specify a version label to show a specific application version.
*/
public final List versionLabels() {
return versionLabels;
}
/**
*
* For a paginated request. Specify a maximum number of application versions to include in each response.
*
*
* If no MaxRecords is specified, all available application versions are retrieved in a single
* response.
*
*
* @return For a paginated request. Specify a maximum number of application versions to include in each
* response.
*
* If no MaxRecords is specified, all available application versions are retrieved in a single
* response.
*/
public final Integer maxRecords() {
return maxRecords;
}
/**
*
* For a paginated request. Specify a token from a previous response page to retrieve the next response page. All
* other parameter values must be identical to the ones specified in the initial request.
*
*
* If no NextToken is specified, the first page is retrieved.
*
*
* @return For a paginated request. Specify a token from a previous response page to retrieve the next response
* page. All other parameter values must be identical to the ones specified in the initial request.
*
* If no NextToken is specified, the first page is retrieved.
*/
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(applicationName());
hashCode = 31 * hashCode + Objects.hashCode(hasVersionLabels() ? versionLabels() : null);
hashCode = 31 * hashCode + Objects.hashCode(maxRecords());
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 DescribeApplicationVersionsRequest)) {
return false;
}
DescribeApplicationVersionsRequest other = (DescribeApplicationVersionsRequest) obj;
return Objects.equals(applicationName(), other.applicationName()) && hasVersionLabels() == other.hasVersionLabels()
&& Objects.equals(versionLabels(), other.versionLabels()) && Objects.equals(maxRecords(), other.maxRecords())
&& 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("DescribeApplicationVersionsRequest").add("ApplicationName", applicationName())
.add("VersionLabels", hasVersionLabels() ? versionLabels() : null).add("MaxRecords", maxRecords())
.add("NextToken", nextToken()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ApplicationName":
return Optional.ofNullable(clazz.cast(applicationName()));
case "VersionLabels":
return Optional.ofNullable(clazz.cast(versionLabels()));
case "MaxRecords":
return Optional.ofNullable(clazz.cast(maxRecords()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeApplicationVersionsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ElasticBeanstalkRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* Specify an application name to show only application versions for that application.
*
*
* @param applicationName
* Specify an application name to show only application versions for that application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder applicationName(String applicationName);
/**
*
* Specify a version label to show a specific application version.
*
*
* @param versionLabels
* Specify a version label to show a specific application version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder versionLabels(Collection versionLabels);
/**
*
* Specify a version label to show a specific application version.
*
*
* @param versionLabels
* Specify a version label to show a specific application version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder versionLabels(String... versionLabels);
/**
*
* For a paginated request. Specify a maximum number of application versions to include in each response.
*
*
* If no MaxRecords is specified, all available application versions are retrieved in a single
* response.
*
*
* @param maxRecords
* For a paginated request. Specify a maximum number of application versions to include in each
* response.
*
* If no MaxRecords is specified, all available application versions are retrieved in a
* single response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxRecords(Integer maxRecords);
/**
*
* For a paginated request. Specify a token from a previous response page to retrieve the next response page.
* All other parameter values must be identical to the ones specified in the initial request.
*
*
* If no NextToken is specified, the first page is retrieved.
*
*
* @param nextToken
* For a paginated request. Specify a token from a previous response page to retrieve the next response
* page. All other parameter values must be identical to the ones specified in the initial request.
*
* If no NextToken is specified, the first page is retrieved.
* @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 ElasticBeanstalkRequest.BuilderImpl implements Builder {
private String applicationName;
private List versionLabels = DefaultSdkAutoConstructList.getInstance();
private Integer maxRecords;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(DescribeApplicationVersionsRequest model) {
super(model);
applicationName(model.applicationName);
versionLabels(model.versionLabels);
maxRecords(model.maxRecords);
nextToken(model.nextToken);
}
public final String getApplicationName() {
return applicationName;
}
public final void setApplicationName(String applicationName) {
this.applicationName = applicationName;
}
@Override
public final Builder applicationName(String applicationName) {
this.applicationName = applicationName;
return this;
}
public final Collection getVersionLabels() {
if (versionLabels instanceof SdkAutoConstructList) {
return null;
}
return versionLabels;
}
public final void setVersionLabels(Collection versionLabels) {
this.versionLabels = VersionLabelsListCopier.copy(versionLabels);
}
@Override
public final Builder versionLabels(Collection versionLabels) {
this.versionLabels = VersionLabelsListCopier.copy(versionLabels);
return this;
}
@Override
@SafeVarargs
public final Builder versionLabels(String... versionLabels) {
versionLabels(Arrays.asList(versionLabels));
return this;
}
public final Integer getMaxRecords() {
return maxRecords;
}
public final void setMaxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
}
@Override
public final Builder maxRecords(Integer maxRecords) {
this.maxRecords = maxRecords;
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 DescribeApplicationVersionsRequest build() {
return new DescribeApplicationVersionsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}