software.amazon.awssdk.services.elasticbeanstalk.model.DescribeInstancesHealthRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticbeanstalk Show documentation
Show all versions of elasticbeanstalk Show documentation
The AWS Java SDK for AWS Elastic Beanstalk module holds the client classes that are used for
communicating with AWS Elastic Beanstalk Service
/*
* 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;
/**
*
* Parameters for a call to DescribeInstancesHealth.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeInstancesHealthRequest extends ElasticBeanstalkRequest implements
ToCopyableBuilder {
private static final SdkField ENVIRONMENT_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EnvironmentName").getter(getter(DescribeInstancesHealthRequest::environmentName))
.setter(setter(Builder::environmentName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EnvironmentName").build()).build();
private static final SdkField ENVIRONMENT_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("EnvironmentId").getter(getter(DescribeInstancesHealthRequest::environmentId))
.setter(setter(Builder::environmentId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("EnvironmentId").build()).build();
private static final SdkField> ATTRIBUTE_NAMES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("AttributeNames")
.getter(getter(DescribeInstancesHealthRequest::attributeNamesAsStrings))
.setter(setter(Builder::attributeNamesWithStrings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("AttributeNames").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 NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(DescribeInstancesHealthRequest::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(ENVIRONMENT_NAME_FIELD,
ENVIRONMENT_ID_FIELD, ATTRIBUTE_NAMES_FIELD, NEXT_TOKEN_FIELD));
private final String environmentName;
private final String environmentId;
private final List attributeNames;
private final String nextToken;
private DescribeInstancesHealthRequest(BuilderImpl builder) {
super(builder);
this.environmentName = builder.environmentName;
this.environmentId = builder.environmentId;
this.attributeNames = builder.attributeNames;
this.nextToken = builder.nextToken;
}
/**
*
* Specify the AWS Elastic Beanstalk environment by name.
*
*
* @return Specify the AWS Elastic Beanstalk environment by name.
*/
public final String environmentName() {
return environmentName;
}
/**
*
* Specify the AWS Elastic Beanstalk environment by ID.
*
*
* @return Specify the AWS Elastic Beanstalk environment by ID.
*/
public final String environmentId() {
return environmentId;
}
/**
*
* Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no
* attribute names are specified, returns a list of instances.
*
*
* 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 #hasAttributeNames} method.
*
*
* @return Specifies the response elements you wish to receive. To retrieve all attributes, set to All.
* If no attribute names are specified, returns a list of instances.
*/
public final List attributeNames() {
return InstancesHealthAttributesCopier.copyStringToEnum(attributeNames);
}
/**
* For responses, this returns true if the service returned a value for the AttributeNames 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 hasAttributeNames() {
return attributeNames != null && !(attributeNames instanceof SdkAutoConstructList);
}
/**
*
* Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If no
* attribute names are specified, returns a list of instances.
*
*
* 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 #hasAttributeNames} method.
*
*
* @return Specifies the response elements you wish to receive. To retrieve all attributes, set to All.
* If no attribute names are specified, returns a list of instances.
*/
public final List attributeNamesAsStrings() {
return attributeNames;
}
/**
*
* Specify the pagination token returned by a previous call.
*
*
* @return Specify the pagination token returned by a previous 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(environmentName());
hashCode = 31 * hashCode + Objects.hashCode(environmentId());
hashCode = 31 * hashCode + Objects.hashCode(hasAttributeNames() ? attributeNamesAsStrings() : null);
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 DescribeInstancesHealthRequest)) {
return false;
}
DescribeInstancesHealthRequest other = (DescribeInstancesHealthRequest) obj;
return Objects.equals(environmentName(), other.environmentName())
&& Objects.equals(environmentId(), other.environmentId()) && hasAttributeNames() == other.hasAttributeNames()
&& Objects.equals(attributeNamesAsStrings(), other.attributeNamesAsStrings())
&& 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("DescribeInstancesHealthRequest").add("EnvironmentName", environmentName())
.add("EnvironmentId", environmentId())
.add("AttributeNames", hasAttributeNames() ? attributeNamesAsStrings() : null).add("NextToken", nextToken())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "EnvironmentName":
return Optional.ofNullable(clazz.cast(environmentName()));
case "EnvironmentId":
return Optional.ofNullable(clazz.cast(environmentId()));
case "AttributeNames":
return Optional.ofNullable(clazz.cast(attributeNamesAsStrings()));
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((DescribeInstancesHealthRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ElasticBeanstalkRequest.Builder, SdkPojo,
CopyableBuilder {
/**
*
* Specify the AWS Elastic Beanstalk environment by name.
*
*
* @param environmentName
* Specify the AWS Elastic Beanstalk environment by name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder environmentName(String environmentName);
/**
*
* Specify the AWS Elastic Beanstalk environment by ID.
*
*
* @param environmentId
* Specify the AWS Elastic Beanstalk environment by ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder environmentId(String environmentId);
/**
*
* Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If
* no attribute names are specified, returns a list of instances.
*
*
* @param attributeNames
* Specifies the response elements you wish to receive. To retrieve all attributes, set to
* All. If no attribute names are specified, returns a list of instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributeNamesWithStrings(Collection attributeNames);
/**
*
* Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If
* no attribute names are specified, returns a list of instances.
*
*
* @param attributeNames
* Specifies the response elements you wish to receive. To retrieve all attributes, set to
* All. If no attribute names are specified, returns a list of instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributeNamesWithStrings(String... attributeNames);
/**
*
* Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If
* no attribute names are specified, returns a list of instances.
*
*
* @param attributeNames
* Specifies the response elements you wish to receive. To retrieve all attributes, set to
* All. If no attribute names are specified, returns a list of instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributeNames(Collection attributeNames);
/**
*
* Specifies the response elements you wish to receive. To retrieve all attributes, set to All. If
* no attribute names are specified, returns a list of instances.
*
*
* @param attributeNames
* Specifies the response elements you wish to receive. To retrieve all attributes, set to
* All. If no attribute names are specified, returns a list of instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder attributeNames(InstancesHealthAttribute... attributeNames);
/**
*
* Specify the pagination token returned by a previous call.
*
*
* @param nextToken
* Specify the pagination token returned by a previous 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 ElasticBeanstalkRequest.BuilderImpl implements Builder {
private String environmentName;
private String environmentId;
private List attributeNames = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(DescribeInstancesHealthRequest model) {
super(model);
environmentName(model.environmentName);
environmentId(model.environmentId);
attributeNamesWithStrings(model.attributeNames);
nextToken(model.nextToken);
}
public final String getEnvironmentName() {
return environmentName;
}
public final void setEnvironmentName(String environmentName) {
this.environmentName = environmentName;
}
@Override
public final Builder environmentName(String environmentName) {
this.environmentName = environmentName;
return this;
}
public final String getEnvironmentId() {
return environmentId;
}
public final void setEnvironmentId(String environmentId) {
this.environmentId = environmentId;
}
@Override
public final Builder environmentId(String environmentId) {
this.environmentId = environmentId;
return this;
}
public final Collection getAttributeNames() {
if (attributeNames instanceof SdkAutoConstructList) {
return null;
}
return attributeNames;
}
public final void setAttributeNames(Collection attributeNames) {
this.attributeNames = InstancesHealthAttributesCopier.copy(attributeNames);
}
@Override
public final Builder attributeNamesWithStrings(Collection attributeNames) {
this.attributeNames = InstancesHealthAttributesCopier.copy(attributeNames);
return this;
}
@Override
@SafeVarargs
public final Builder attributeNamesWithStrings(String... attributeNames) {
attributeNamesWithStrings(Arrays.asList(attributeNames));
return this;
}
@Override
public final Builder attributeNames(Collection attributeNames) {
this.attributeNames = InstancesHealthAttributesCopier.copyEnumToString(attributeNames);
return this;
}
@Override
@SafeVarargs
public final Builder attributeNames(InstancesHealthAttribute... attributeNames) {
attributeNames(Arrays.asList(attributeNames));
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 DescribeInstancesHealthRequest build() {
return new DescribeInstancesHealthRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy