software.amazon.awssdk.services.ec2.model.DescribeReservedInstancesListingsRequest Maven / Gradle / Ivy
Show all versions of ec2 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.ec2.model;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
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.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;
/**
*
* Contains the parameters for DescribeReservedInstancesListings.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DescribeReservedInstancesListingsRequest extends Ec2Request implements
ToCopyableBuilder {
private static final SdkField RESERVED_INSTANCES_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ReservedInstancesId")
.getter(getter(DescribeReservedInstancesListingsRequest::reservedInstancesId))
.setter(setter(Builder::reservedInstancesId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReservedInstancesId")
.unmarshallLocationName("reservedInstancesId").build()).build();
private static final SdkField RESERVED_INSTANCES_LISTING_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ReservedInstancesListingId")
.getter(getter(DescribeReservedInstancesListingsRequest::reservedInstancesListingId))
.setter(setter(Builder::reservedInstancesListingId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ReservedInstancesListingId")
.unmarshallLocationName("reservedInstancesListingId").build()).build();
private static final SdkField> FILTERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Filters")
.getter(getter(DescribeReservedInstancesListingsRequest::filters))
.setter(setter(Builder::filters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Filter")
.unmarshallLocationName("Filter").build(),
ListTrait
.builder()
.memberLocationName("Filter")
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Filter::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("Filter").unmarshallLocationName("Filter").build()).build())
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(RESERVED_INSTANCES_ID_FIELD,
RESERVED_INSTANCES_LISTING_ID_FIELD, FILTERS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("ReservedInstancesId", RESERVED_INSTANCES_ID_FIELD);
put("ReservedInstancesListingId", RESERVED_INSTANCES_LISTING_ID_FIELD);
put("Filter", FILTERS_FIELD);
}
});
private final String reservedInstancesId;
private final String reservedInstancesListingId;
private final List filters;
private DescribeReservedInstancesListingsRequest(BuilderImpl builder) {
super(builder);
this.reservedInstancesId = builder.reservedInstancesId;
this.reservedInstancesListingId = builder.reservedInstancesListingId;
this.filters = builder.filters;
}
/**
*
* One or more Reserved Instance IDs.
*
*
* @return One or more Reserved Instance IDs.
*/
public final String reservedInstancesId() {
return reservedInstancesId;
}
/**
*
* One or more Reserved Instance listing IDs.
*
*
* @return One or more Reserved Instance listing IDs.
*/
public final String reservedInstancesListingId() {
return reservedInstancesListingId;
}
/**
* For responses, this returns true if the service returned a value for the Filters 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 hasFilters() {
return filters != null && !(filters instanceof SdkAutoConstructList);
}
/**
*
* One or more filters.
*
*
* -
*
* reserved-instances-id - The ID of the Reserved Instances.
*
*
* -
*
* reserved-instances-listing-id - The ID of the Reserved Instances listing.
*
*
* -
*
* status - The status of the Reserved Instance listing (pending | active |
* cancelled | closed).
*
*
* -
*
* status-message - The reason for the status.
*
*
*
*
* 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 #hasFilters} method.
*
*
* @return One or more filters.
*
* -
*
* reserved-instances-id - The ID of the Reserved Instances.
*
*
* -
*
* reserved-instances-listing-id - The ID of the Reserved Instances listing.
*
*
* -
*
* status - The status of the Reserved Instance listing (pending |
* active | cancelled | closed).
*
*
* -
*
* status-message - The reason for the status.
*
*
*/
public final List filters() {
return filters;
}
@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(reservedInstancesId());
hashCode = 31 * hashCode + Objects.hashCode(reservedInstancesListingId());
hashCode = 31 * hashCode + Objects.hashCode(hasFilters() ? filters() : 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 DescribeReservedInstancesListingsRequest)) {
return false;
}
DescribeReservedInstancesListingsRequest other = (DescribeReservedInstancesListingsRequest) obj;
return Objects.equals(reservedInstancesId(), other.reservedInstancesId())
&& Objects.equals(reservedInstancesListingId(), other.reservedInstancesListingId())
&& hasFilters() == other.hasFilters() && Objects.equals(filters(), other.filters());
}
/**
* 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("DescribeReservedInstancesListingsRequest").add("ReservedInstancesId", reservedInstancesId())
.add("ReservedInstancesListingId", reservedInstancesListingId()).add("Filters", hasFilters() ? filters() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ReservedInstancesId":
return Optional.ofNullable(clazz.cast(reservedInstancesId()));
case "ReservedInstancesListingId":
return Optional.ofNullable(clazz.cast(reservedInstancesListingId()));
case "Filters":
return Optional.ofNullable(clazz.cast(filters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeReservedInstancesListingsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Ec2Request.Builder, SdkPojo,
CopyableBuilder {
/**
*
* One or more Reserved Instance IDs.
*
*
* @param reservedInstancesId
* One or more Reserved Instance IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reservedInstancesId(String reservedInstancesId);
/**
*
* One or more Reserved Instance listing IDs.
*
*
* @param reservedInstancesListingId
* One or more Reserved Instance listing IDs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder reservedInstancesListingId(String reservedInstancesListingId);
/**
*
* One or more filters.
*
*
* -
*
* reserved-instances-id - The ID of the Reserved Instances.
*
*
* -
*
* reserved-instances-listing-id - The ID of the Reserved Instances listing.
*
*
* -
*
* status - The status of the Reserved Instance listing (pending | active
* | cancelled | closed).
*
*
* -
*
* status-message - The reason for the status.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* reserved-instances-id - The ID of the Reserved Instances.
*
*
* -
*
* reserved-instances-listing-id - The ID of the Reserved Instances listing.
*
*
* -
*
* status - The status of the Reserved Instance listing (pending |
* active | cancelled | closed).
*
*
* -
*
* status-message - The reason for the status.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Collection filters);
/**
*
* One or more filters.
*
*
* -
*
* reserved-instances-id - The ID of the Reserved Instances.
*
*
* -
*
* reserved-instances-listing-id - The ID of the Reserved Instances listing.
*
*
* -
*
* status - The status of the Reserved Instance listing (pending | active
* | cancelled | closed).
*
*
* -
*
* status-message - The reason for the status.
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* reserved-instances-id - The ID of the Reserved Instances.
*
*
* -
*
* reserved-instances-listing-id - The ID of the Reserved Instances listing.
*
*
* -
*
* status - The status of the Reserved Instance listing (pending |
* active | cancelled | closed).
*
*
* -
*
* status-message - The reason for the status.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder filters(Filter... filters);
/**
*
* One or more filters.
*
*
* -
*
* reserved-instances-id - The ID of the Reserved Instances.
*
*
* -
*
* reserved-instances-listing-id - The ID of the Reserved Instances listing.
*
*
* -
*
* status - The status of the Reserved Instance listing (pending | active
* | cancelled | closed).
*
*
* -
*
* status-message - The reason for the status.
*
*
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ec2.model.Filter.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.ec2.model.Filter#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.ec2.model.Filter.Builder#build()}
* is called immediately and its result is passed to {@link #filters(List)}.
*
* @param filters
* a consumer that will call methods on {@link software.amazon.awssdk.services.ec2.model.Filter.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #filters(java.util.Collection)
*/
Builder filters(Consumer... filters);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends Ec2Request.BuilderImpl implements Builder {
private String reservedInstancesId;
private String reservedInstancesListingId;
private List filters = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DescribeReservedInstancesListingsRequest model) {
super(model);
reservedInstancesId(model.reservedInstancesId);
reservedInstancesListingId(model.reservedInstancesListingId);
filters(model.filters);
}
public final String getReservedInstancesId() {
return reservedInstancesId;
}
public final void setReservedInstancesId(String reservedInstancesId) {
this.reservedInstancesId = reservedInstancesId;
}
@Override
public final Builder reservedInstancesId(String reservedInstancesId) {
this.reservedInstancesId = reservedInstancesId;
return this;
}
public final String getReservedInstancesListingId() {
return reservedInstancesListingId;
}
public final void setReservedInstancesListingId(String reservedInstancesListingId) {
this.reservedInstancesListingId = reservedInstancesListingId;
}
@Override
public final Builder reservedInstancesListingId(String reservedInstancesListingId) {
this.reservedInstancesListingId = reservedInstancesListingId;
return this;
}
public final List getFilters() {
List result = FilterListCopier.copyToBuilder(this.filters);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setFilters(Collection filters) {
this.filters = FilterListCopier.copyFromBuilder(filters);
}
@Override
public final Builder filters(Collection filters) {
this.filters = FilterListCopier.copy(filters);
return this;
}
@Override
@SafeVarargs
public final Builder filters(Filter... filters) {
filters(Arrays.asList(filters));
return this;
}
@Override
@SafeVarargs
public final Builder filters(Consumer... filters) {
filters(Stream.of(filters).map(c -> Filter.builder().applyMutation(c).build()).collect(Collectors.toList()));
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 DescribeReservedInstancesListingsRequest build() {
return new DescribeReservedInstancesListingsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}