software.amazon.awssdk.services.computeoptimizer.model.GetEc2InstanceRecommendationsResponse Maven / Gradle / Ivy
Show all versions of computeoptimizer 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.computeoptimizer.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 java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetEc2InstanceRecommendationsResponse extends ComputeOptimizerResponse implements
ToCopyableBuilder {
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(GetEc2InstanceRecommendationsResponse::nextToken))
.setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("nextToken").build()).build();
private static final SdkField> INSTANCE_RECOMMENDATIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("instanceRecommendations")
.getter(getter(GetEc2InstanceRecommendationsResponse::instanceRecommendations))
.setter(setter(Builder::instanceRecommendations))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("instanceRecommendations").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(InstanceRecommendation::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> ERRORS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("errors")
.getter(getter(GetEc2InstanceRecommendationsResponse::errors))
.setter(setter(Builder::errors))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("errors").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(GetRecommendationError::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NEXT_TOKEN_FIELD,
INSTANCE_RECOMMENDATIONS_FIELD, ERRORS_FIELD));
private final String nextToken;
private final List instanceRecommendations;
private final List errors;
private GetEc2InstanceRecommendationsResponse(BuilderImpl builder) {
super(builder);
this.nextToken = builder.nextToken;
this.instanceRecommendations = builder.instanceRecommendations;
this.errors = builder.errors;
}
/**
*
* The token to use to advance to the next page of instance recommendations.
*
*
* This value is null when there are no more pages of instance recommendations to return.
*
*
* @return The token to use to advance to the next page of instance recommendations.
*
* This value is null when there are no more pages of instance recommendations to return.
*/
public final String nextToken() {
return nextToken;
}
/**
* For responses, this returns true if the service returned a value for the InstanceRecommendations 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 hasInstanceRecommendations() {
return instanceRecommendations != null && !(instanceRecommendations instanceof SdkAutoConstructList);
}
/**
*
* An array of objects that describe instance recommendations.
*
*
* 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 #hasInstanceRecommendations} method.
*
*
* @return An array of objects that describe instance recommendations.
*/
public final List instanceRecommendations() {
return instanceRecommendations;
}
/**
* For responses, this returns true if the service returned a value for the Errors 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 hasErrors() {
return errors != null && !(errors instanceof SdkAutoConstructList);
}
/**
*
* An array of objects that describe errors of the request.
*
*
* For example, an error is returned if you request recommendations for an instance of an unsupported instance
* family.
*
*
* 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 #hasErrors} method.
*
*
* @return An array of objects that describe errors of the request.
*
* For example, an error is returned if you request recommendations for an instance of an unsupported
* instance family.
*/
public final List errors() {
return errors;
}
@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(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(hasInstanceRecommendations() ? instanceRecommendations() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasErrors() ? errors() : null);
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 GetEc2InstanceRecommendationsResponse)) {
return false;
}
GetEc2InstanceRecommendationsResponse other = (GetEc2InstanceRecommendationsResponse) obj;
return Objects.equals(nextToken(), other.nextToken())
&& hasInstanceRecommendations() == other.hasInstanceRecommendations()
&& Objects.equals(instanceRecommendations(), other.instanceRecommendations()) && hasErrors() == other.hasErrors()
&& Objects.equals(errors(), other.errors());
}
/**
* 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("GetEc2InstanceRecommendationsResponse").add("NextToken", nextToken())
.add("InstanceRecommendations", hasInstanceRecommendations() ? instanceRecommendations() : null)
.add("Errors", hasErrors() ? errors() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "instanceRecommendations":
return Optional.ofNullable(clazz.cast(instanceRecommendations()));
case "errors":
return Optional.ofNullable(clazz.cast(errors()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((GetEc2InstanceRecommendationsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ComputeOptimizerResponse.Builder, SdkPojo,
CopyableBuilder {
/**
*
* The token to use to advance to the next page of instance recommendations.
*
*
* This value is null when there are no more pages of instance recommendations to return.
*
*
* @param nextToken
* The token to use to advance to the next page of instance recommendations.
*
* This value is null when there are no more pages of instance recommendations to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* An array of objects that describe instance recommendations.
*
*
* @param instanceRecommendations
* An array of objects that describe instance recommendations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceRecommendations(Collection instanceRecommendations);
/**
*
* An array of objects that describe instance recommendations.
*
*
* @param instanceRecommendations
* An array of objects that describe instance recommendations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder instanceRecommendations(InstanceRecommendation... instanceRecommendations);
/**
*
* An array of objects that describe instance recommendations.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.computeoptimizer.model.InstanceRecommendation.Builder} avoiding the
* need to create one manually via
* {@link software.amazon.awssdk.services.computeoptimizer.model.InstanceRecommendation#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.computeoptimizer.model.InstanceRecommendation.Builder#build()} is
* called immediately and its result is passed to {@link #instanceRecommendations(List)}.
*
* @param instanceRecommendations
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.computeoptimizer.model.InstanceRecommendation.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #instanceRecommendations(java.util.Collection)
*/
Builder instanceRecommendations(Consumer... instanceRecommendations);
/**
*
* An array of objects that describe errors of the request.
*
*
* For example, an error is returned if you request recommendations for an instance of an unsupported instance
* family.
*
*
* @param errors
* An array of objects that describe errors of the request.
*
* For example, an error is returned if you request recommendations for an instance of an unsupported
* instance family.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder errors(Collection errors);
/**
*
* An array of objects that describe errors of the request.
*
*
* For example, an error is returned if you request recommendations for an instance of an unsupported instance
* family.
*
*
* @param errors
* An array of objects that describe errors of the request.
*
* For example, an error is returned if you request recommendations for an instance of an unsupported
* instance family.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder errors(GetRecommendationError... errors);
/**
*
* An array of objects that describe errors of the request.
*
*
* For example, an error is returned if you request recommendations for an instance of an unsupported instance
* family.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationError.Builder} avoiding the
* need to create one manually via
* {@link software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationError#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationError.Builder#build()} is
* called immediately and its result is passed to {@link #errors(List)}.
*
* @param errors
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.computeoptimizer.model.GetRecommendationError.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #errors(java.util.Collection)
*/
Builder errors(Consumer... errors);
}
static final class BuilderImpl extends ComputeOptimizerResponse.BuilderImpl implements Builder {
private String nextToken;
private List instanceRecommendations = DefaultSdkAutoConstructList.getInstance();
private List errors = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(GetEc2InstanceRecommendationsResponse model) {
super(model);
nextToken(model.nextToken);
instanceRecommendations(model.instanceRecommendations);
errors(model.errors);
}
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 List getInstanceRecommendations() {
List result = InstanceRecommendationsCopier
.copyToBuilder(this.instanceRecommendations);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setInstanceRecommendations(Collection instanceRecommendations) {
this.instanceRecommendations = InstanceRecommendationsCopier.copyFromBuilder(instanceRecommendations);
}
@Override
public final Builder instanceRecommendations(Collection instanceRecommendations) {
this.instanceRecommendations = InstanceRecommendationsCopier.copy(instanceRecommendations);
return this;
}
@Override
@SafeVarargs
public final Builder instanceRecommendations(InstanceRecommendation... instanceRecommendations) {
instanceRecommendations(Arrays.asList(instanceRecommendations));
return this;
}
@Override
@SafeVarargs
public final Builder instanceRecommendations(Consumer... instanceRecommendations) {
instanceRecommendations(Stream.of(instanceRecommendations)
.map(c -> InstanceRecommendation.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getErrors() {
List result = GetRecommendationErrorsCopier.copyToBuilder(this.errors);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setErrors(Collection errors) {
this.errors = GetRecommendationErrorsCopier.copyFromBuilder(errors);
}
@Override
public final Builder errors(Collection errors) {
this.errors = GetRecommendationErrorsCopier.copy(errors);
return this;
}
@Override
@SafeVarargs
public final Builder errors(GetRecommendationError... errors) {
errors(Arrays.asList(errors));
return this;
}
@Override
@SafeVarargs
public final Builder errors(Consumer... errors) {
errors(Stream.of(errors).map(c -> GetRecommendationError.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
@Override
public GetEc2InstanceRecommendationsResponse build() {
return new GetEc2InstanceRecommendationsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}