software.amazon.awssdk.services.elasticbeanstalk.model.DescribeEnvironmentsRequest 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.elasticbeanstalk.model;
import java.time.Instant;
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 one or more environments.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeEnvironmentsRequest extends ElasticBeanstalkRequest implements
ToCopyableBuilder {
private static final SdkField APPLICATION_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ApplicationName").getter(getter(DescribeEnvironmentsRequest::applicationName))
.setter(setter(Builder::applicationName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ApplicationName").build()).build();
private static final SdkField VERSION_LABEL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("VersionLabel").getter(getter(DescribeEnvironmentsRequest::versionLabel))
.setter(setter(Builder::versionLabel))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("VersionLabel").build()).build();
private static final SdkField> ENVIRONMENT_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("EnvironmentIds")
.getter(getter(DescribeEnvironmentsRequest::environmentIds))
.setter(setter(Builder::environmentIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EnvironmentIds").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> ENVIRONMENT_NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("EnvironmentNames")
.getter(getter(DescribeEnvironmentsRequest::environmentNames))
.setter(setter(Builder::environmentNames))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EnvironmentNames").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 INCLUDE_DELETED_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("IncludeDeleted").getter(getter(DescribeEnvironmentsRequest::includeDeleted))
.setter(setter(Builder::includeDeleted))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IncludeDeleted").build()).build();
private static final SdkField INCLUDED_DELETED_BACK_TO_FIELD = SdkField. builder(MarshallingType.INSTANT)
.memberName("IncludedDeletedBackTo").getter(getter(DescribeEnvironmentsRequest::includedDeletedBackTo))
.setter(setter(Builder::includedDeletedBackTo))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("IncludedDeletedBackTo").build())
.build();
private static final SdkField MAX_RECORDS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxRecords").getter(getter(DescribeEnvironmentsRequest::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(DescribeEnvironmentsRequest::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_LABEL_FIELD, ENVIRONMENT_IDS_FIELD, ENVIRONMENT_NAMES_FIELD, INCLUDE_DELETED_FIELD,
INCLUDED_DELETED_BACK_TO_FIELD, MAX_RECORDS_FIELD, NEXT_TOKEN_FIELD));
private final String applicationName;
private final String versionLabel;
private final List environmentIds;
private final List environmentNames;
private final Boolean includeDeleted;
private final Instant includedDeletedBackTo;
private final Integer maxRecords;
private final String nextToken;
private DescribeEnvironmentsRequest(BuilderImpl builder) {
super(builder);
this.applicationName = builder.applicationName;
this.versionLabel = builder.versionLabel;
this.environmentIds = builder.environmentIds;
this.environmentNames = builder.environmentNames;
this.includeDeleted = builder.includeDeleted;
this.includedDeletedBackTo = builder.includedDeletedBackTo;
this.maxRecords = builder.maxRecords;
this.nextToken = builder.nextToken;
}
/**
*
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated
* with this application.
*
*
* @return If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are
* associated with this application.
*/
public final String applicationName() {
return applicationName;
}
/**
*
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are associated
* with this application version.
*
*
* @return If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are
* associated with this application version.
*/
public final String versionLabel() {
return versionLabel;
}
/**
* For responses, this returns true if the service returned a value for the EnvironmentIds 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 hasEnvironmentIds() {
return environmentIds != null && !(environmentIds instanceof SdkAutoConstructList);
}
/**
*
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the
* specified IDs.
*
*
* 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 #hasEnvironmentIds} method.
*
*
* @return If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have
* the specified IDs.
*/
public final List environmentIds() {
return environmentIds;
}
/**
* For responses, this returns true if the service returned a value for the EnvironmentNames 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 hasEnvironmentNames() {
return environmentNames != null && !(environmentNames instanceof SdkAutoConstructList);
}
/**
*
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the
* specified names.
*
*
* 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 #hasEnvironmentNames} method.
*
*
* @return If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have
* the specified names.
*/
public final List environmentNames() {
return environmentNames;
}
/**
*
* Indicates whether to include deleted environments:
*
*
* true: Environments that have been deleted after IncludedDeletedBackTo are displayed.
*
*
* false: Do not include deleted environments.
*
*
* @return Indicates whether to include deleted environments:
*
* true: Environments that have been deleted after IncludedDeletedBackTo are
* displayed.
*
*
* false: Do not include deleted environments.
*/
public final Boolean includeDeleted() {
return includeDeleted;
}
/**
*
* If specified when IncludeDeleted is set to true, then environments deleted after this
* date are displayed.
*
*
* @return If specified when IncludeDeleted is set to true, then environments deleted
* after this date are displayed.
*/
public final Instant includedDeletedBackTo() {
return includedDeletedBackTo;
}
/**
*
* For a paginated request. Specify a maximum number of environments to include in each response.
*
*
* If no MaxRecords is specified, all available environments are retrieved in a single response.
*
*
* @return For a paginated request. Specify a maximum number of environments to include in each response.
*
* If no MaxRecords is specified, all available environments 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(versionLabel());
hashCode = 31 * hashCode + Objects.hashCode(hasEnvironmentIds() ? environmentIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasEnvironmentNames() ? environmentNames() : null);
hashCode = 31 * hashCode + Objects.hashCode(includeDeleted());
hashCode = 31 * hashCode + Objects.hashCode(includedDeletedBackTo());
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 DescribeEnvironmentsRequest)) {
return false;
}
DescribeEnvironmentsRequest other = (DescribeEnvironmentsRequest) obj;
return Objects.equals(applicationName(), other.applicationName()) && Objects.equals(versionLabel(), other.versionLabel())
&& hasEnvironmentIds() == other.hasEnvironmentIds() && Objects.equals(environmentIds(), other.environmentIds())
&& hasEnvironmentNames() == other.hasEnvironmentNames()
&& Objects.equals(environmentNames(), other.environmentNames())
&& Objects.equals(includeDeleted(), other.includeDeleted())
&& Objects.equals(includedDeletedBackTo(), other.includedDeletedBackTo())
&& 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("DescribeEnvironmentsRequest").add("ApplicationName", applicationName())
.add("VersionLabel", versionLabel()).add("EnvironmentIds", hasEnvironmentIds() ? environmentIds() : null)
.add("EnvironmentNames", hasEnvironmentNames() ? environmentNames() : null)
.add("IncludeDeleted", includeDeleted()).add("IncludedDeletedBackTo", includedDeletedBackTo())
.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 "VersionLabel":
return Optional.ofNullable(clazz.cast(versionLabel()));
case "EnvironmentIds":
return Optional.ofNullable(clazz.cast(environmentIds()));
case "EnvironmentNames":
return Optional.ofNullable(clazz.cast(environmentNames()));
case "IncludeDeleted":
return Optional.ofNullable(clazz.cast(includeDeleted()));
case "IncludedDeletedBackTo":
return Optional.ofNullable(clazz.cast(includedDeletedBackTo()));
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((DescribeEnvironmentsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ElasticBeanstalkRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are
* associated with this application.
*
*
* @param applicationName
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are
* associated with this application.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder applicationName(String applicationName);
/**
*
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are
* associated with this application version.
*
*
* @param versionLabel
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that are
* associated with this application version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder versionLabel(String versionLabel);
/**
*
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the
* specified IDs.
*
*
* @param environmentIds
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that
* have the specified IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder environmentIds(Collection environmentIds);
/**
*
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the
* specified IDs.
*
*
* @param environmentIds
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that
* have the specified IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder environmentIds(String... environmentIds);
/**
*
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the
* specified names.
*
*
* @param environmentNames
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that
* have the specified names.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder environmentNames(Collection environmentNames);
/**
*
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that have the
* specified names.
*
*
* @param environmentNames
* If specified, AWS Elastic Beanstalk restricts the returned descriptions to include only those that
* have the specified names.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder environmentNames(String... environmentNames);
/**
*
* Indicates whether to include deleted environments:
*
*
* true: Environments that have been deleted after IncludedDeletedBackTo are
* displayed.
*
*
* false: Do not include deleted environments.
*
*
* @param includeDeleted
* Indicates whether to include deleted environments:
*
* true: Environments that have been deleted after IncludedDeletedBackTo are
* displayed.
*
*
* false: Do not include deleted environments.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder includeDeleted(Boolean includeDeleted);
/**
*
* If specified when IncludeDeleted is set to true, then environments deleted after
* this date are displayed.
*
*
* @param includedDeletedBackTo
* If specified when IncludeDeleted is set to true, then environments deleted
* after this date are displayed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder includedDeletedBackTo(Instant includedDeletedBackTo);
/**
*
* For a paginated request. Specify a maximum number of environments to include in each response.
*
*
* If no MaxRecords is specified, all available environments are retrieved in a single response.
*
*
* @param maxRecords
* For a paginated request. Specify a maximum number of environments to include in each response.
*
* If no MaxRecords is specified, all available environments 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 String versionLabel;
private List environmentIds = DefaultSdkAutoConstructList.getInstance();
private List environmentNames = DefaultSdkAutoConstructList.getInstance();
private Boolean includeDeleted;
private Instant includedDeletedBackTo;
private Integer maxRecords;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(DescribeEnvironmentsRequest model) {
super(model);
applicationName(model.applicationName);
versionLabel(model.versionLabel);
environmentIds(model.environmentIds);
environmentNames(model.environmentNames);
includeDeleted(model.includeDeleted);
includedDeletedBackTo(model.includedDeletedBackTo);
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 String getVersionLabel() {
return versionLabel;
}
public final void setVersionLabel(String versionLabel) {
this.versionLabel = versionLabel;
}
@Override
public final Builder versionLabel(String versionLabel) {
this.versionLabel = versionLabel;
return this;
}
public final Collection getEnvironmentIds() {
if (environmentIds instanceof SdkAutoConstructList) {
return null;
}
return environmentIds;
}
public final void setEnvironmentIds(Collection environmentIds) {
this.environmentIds = EnvironmentIdListCopier.copy(environmentIds);
}
@Override
public final Builder environmentIds(Collection environmentIds) {
this.environmentIds = EnvironmentIdListCopier.copy(environmentIds);
return this;
}
@Override
@SafeVarargs
public final Builder environmentIds(String... environmentIds) {
environmentIds(Arrays.asList(environmentIds));
return this;
}
public final Collection getEnvironmentNames() {
if (environmentNames instanceof SdkAutoConstructList) {
return null;
}
return environmentNames;
}
public final void setEnvironmentNames(Collection environmentNames) {
this.environmentNames = EnvironmentNamesListCopier.copy(environmentNames);
}
@Override
public final Builder environmentNames(Collection environmentNames) {
this.environmentNames = EnvironmentNamesListCopier.copy(environmentNames);
return this;
}
@Override
@SafeVarargs
public final Builder environmentNames(String... environmentNames) {
environmentNames(Arrays.asList(environmentNames));
return this;
}
public final Boolean getIncludeDeleted() {
return includeDeleted;
}
public final void setIncludeDeleted(Boolean includeDeleted) {
this.includeDeleted = includeDeleted;
}
@Override
public final Builder includeDeleted(Boolean includeDeleted) {
this.includeDeleted = includeDeleted;
return this;
}
public final Instant getIncludedDeletedBackTo() {
return includedDeletedBackTo;
}
public final void setIncludedDeletedBackTo(Instant includedDeletedBackTo) {
this.includedDeletedBackTo = includedDeletedBackTo;
}
@Override
public final Builder includedDeletedBackTo(Instant includedDeletedBackTo) {
this.includedDeletedBackTo = includedDeletedBackTo;
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 DescribeEnvironmentsRequest build() {
return new DescribeEnvironmentsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}