software.amazon.awssdk.services.outposts.model.ListSitesRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of outposts Show documentation
Show all versions of outposts Show documentation
The AWS Java SDK for Outposts module holds the client classes that are used for
communicating with Outposts.
/*
* 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.outposts.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;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListSitesRequest extends OutpostsRequest implements
ToCopyableBuilder {
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListSitesRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("NextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(ListSitesRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("MaxResults").build()).build();
private static final SdkField> OPERATING_ADDRESS_COUNTRY_CODE_FILTER_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("OperatingAddressCountryCodeFilter")
.getter(getter(ListSitesRequest::operatingAddressCountryCodeFilter))
.setter(setter(Builder::operatingAddressCountryCodeFilter))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM)
.locationName("OperatingAddressCountryCodeFilter").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> OPERATING_ADDRESS_STATE_OR_REGION_FILTER_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("OperatingAddressStateOrRegionFilter")
.getter(getter(ListSitesRequest::operatingAddressStateOrRegionFilter))
.setter(setter(Builder::operatingAddressStateOrRegionFilter))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM)
.locationName("OperatingAddressStateOrRegionFilter").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> OPERATING_ADDRESS_CITY_FILTER_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("OperatingAddressCityFilter")
.getter(getter(ListSitesRequest::operatingAddressCityFilter))
.setter(setter(Builder::operatingAddressCityFilter))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("OperatingAddressCityFilter")
.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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NEXT_TOKEN_FIELD,
MAX_RESULTS_FIELD, OPERATING_ADDRESS_COUNTRY_CODE_FILTER_FIELD, OPERATING_ADDRESS_STATE_OR_REGION_FILTER_FIELD,
OPERATING_ADDRESS_CITY_FILTER_FIELD));
private final String nextToken;
private final Integer maxResults;
private final List operatingAddressCountryCodeFilter;
private final List operatingAddressStateOrRegionFilter;
private final List operatingAddressCityFilter;
private ListSitesRequest(BuilderImpl builder) {
super(builder);
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
this.operatingAddressCountryCodeFilter = builder.operatingAddressCountryCodeFilter;
this.operatingAddressStateOrRegionFilter = builder.operatingAddressStateOrRegionFilter;
this.operatingAddressCityFilter = builder.operatingAddressCityFilter;
}
/**
* Returns the value of the NextToken property for this object.
*
* @return The value of the NextToken property for this object.
*/
public final String nextToken() {
return nextToken;
}
/**
* Returns the value of the MaxResults property for this object.
*
* @return The value of the MaxResults property for this object.
*/
public final Integer maxResults() {
return maxResults;
}
/**
* For responses, this returns true if the service returned a value for the OperatingAddressCountryCodeFilter
* 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 hasOperatingAddressCountryCodeFilter() {
return operatingAddressCountryCodeFilter != null && !(operatingAddressCountryCodeFilter instanceof SdkAutoConstructList);
}
/**
*
* Filters the results by country code.
*
*
* 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 #hasOperatingAddressCountryCodeFilter}
* method.
*
*
* @return Filters the results by country code.
*/
public final List operatingAddressCountryCodeFilter() {
return operatingAddressCountryCodeFilter;
}
/**
* For responses, this returns true if the service returned a value for the OperatingAddressStateOrRegionFilter
* 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 hasOperatingAddressStateOrRegionFilter() {
return operatingAddressStateOrRegionFilter != null
&& !(operatingAddressStateOrRegionFilter instanceof SdkAutoConstructList);
}
/**
*
* Filters the results by state or region.
*
*
* 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 #hasOperatingAddressStateOrRegionFilter}
* method.
*
*
* @return Filters the results by state or region.
*/
public final List operatingAddressStateOrRegionFilter() {
return operatingAddressStateOrRegionFilter;
}
/**
* For responses, this returns true if the service returned a value for the OperatingAddressCityFilter 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 hasOperatingAddressCityFilter() {
return operatingAddressCityFilter != null && !(operatingAddressCityFilter instanceof SdkAutoConstructList);
}
/**
*
* Filters the results by city.
*
*
* 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 #hasOperatingAddressCityFilter} method.
*
*
* @return Filters the results by city.
*/
public final List operatingAddressCityFilter() {
return operatingAddressCityFilter;
}
@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(maxResults());
hashCode = 31 * hashCode
+ Objects.hashCode(hasOperatingAddressCountryCodeFilter() ? operatingAddressCountryCodeFilter() : null);
hashCode = 31 * hashCode
+ Objects.hashCode(hasOperatingAddressStateOrRegionFilter() ? operatingAddressStateOrRegionFilter() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasOperatingAddressCityFilter() ? operatingAddressCityFilter() : 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 ListSitesRequest)) {
return false;
}
ListSitesRequest other = (ListSitesRequest) obj;
return Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults())
&& hasOperatingAddressCountryCodeFilter() == other.hasOperatingAddressCountryCodeFilter()
&& Objects.equals(operatingAddressCountryCodeFilter(), other.operatingAddressCountryCodeFilter())
&& hasOperatingAddressStateOrRegionFilter() == other.hasOperatingAddressStateOrRegionFilter()
&& Objects.equals(operatingAddressStateOrRegionFilter(), other.operatingAddressStateOrRegionFilter())
&& hasOperatingAddressCityFilter() == other.hasOperatingAddressCityFilter()
&& Objects.equals(operatingAddressCityFilter(), other.operatingAddressCityFilter());
}
/**
* 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("ListSitesRequest")
.add("NextToken", nextToken())
.add("MaxResults", maxResults())
.add("OperatingAddressCountryCodeFilter",
hasOperatingAddressCountryCodeFilter() ? operatingAddressCountryCodeFilter() : null)
.add("OperatingAddressStateOrRegionFilter",
hasOperatingAddressStateOrRegionFilter() ? operatingAddressStateOrRegionFilter() : null)
.add("OperatingAddressCityFilter", hasOperatingAddressCityFilter() ? operatingAddressCityFilter() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "OperatingAddressCountryCodeFilter":
return Optional.ofNullable(clazz.cast(operatingAddressCountryCodeFilter()));
case "OperatingAddressStateOrRegionFilter":
return Optional.ofNullable(clazz.cast(operatingAddressStateOrRegionFilter()));
case "OperatingAddressCityFilter":
return Optional.ofNullable(clazz.cast(operatingAddressCityFilter()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListSitesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends OutpostsRequest.Builder, SdkPojo, CopyableBuilder {
/**
* Sets the value of the NextToken property for this object.
*
* @param nextToken
* The new value for the NextToken property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
* Sets the value of the MaxResults property for this object.
*
* @param maxResults
* The new value for the MaxResults property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* Filters the results by country code.
*
*
* @param operatingAddressCountryCodeFilter
* Filters the results by country code.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder operatingAddressCountryCodeFilter(Collection operatingAddressCountryCodeFilter);
/**
*
* Filters the results by country code.
*
*
* @param operatingAddressCountryCodeFilter
* Filters the results by country code.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder operatingAddressCountryCodeFilter(String... operatingAddressCountryCodeFilter);
/**
*
* Filters the results by state or region.
*
*
* @param operatingAddressStateOrRegionFilter
* Filters the results by state or region.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder operatingAddressStateOrRegionFilter(Collection operatingAddressStateOrRegionFilter);
/**
*
* Filters the results by state or region.
*
*
* @param operatingAddressStateOrRegionFilter
* Filters the results by state or region.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder operatingAddressStateOrRegionFilter(String... operatingAddressStateOrRegionFilter);
/**
*
* Filters the results by city.
*
*
* @param operatingAddressCityFilter
* Filters the results by city.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder operatingAddressCityFilter(Collection operatingAddressCityFilter);
/**
*
* Filters the results by city.
*
*
* @param operatingAddressCityFilter
* Filters the results by city.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder operatingAddressCityFilter(String... operatingAddressCityFilter);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends OutpostsRequest.BuilderImpl implements Builder {
private String nextToken;
private Integer maxResults;
private List operatingAddressCountryCodeFilter = DefaultSdkAutoConstructList.getInstance();
private List operatingAddressStateOrRegionFilter = DefaultSdkAutoConstructList.getInstance();
private List operatingAddressCityFilter = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(ListSitesRequest model) {
super(model);
nextToken(model.nextToken);
maxResults(model.maxResults);
operatingAddressCountryCodeFilter(model.operatingAddressCountryCodeFilter);
operatingAddressStateOrRegionFilter(model.operatingAddressStateOrRegionFilter);
operatingAddressCityFilter(model.operatingAddressCityFilter);
}
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 Integer getMaxResults() {
return maxResults;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final Collection getOperatingAddressCountryCodeFilter() {
if (operatingAddressCountryCodeFilter instanceof SdkAutoConstructList) {
return null;
}
return operatingAddressCountryCodeFilter;
}
public final void setOperatingAddressCountryCodeFilter(Collection operatingAddressCountryCodeFilter) {
this.operatingAddressCountryCodeFilter = CountryCodeListCopier.copy(operatingAddressCountryCodeFilter);
}
@Override
public final Builder operatingAddressCountryCodeFilter(Collection operatingAddressCountryCodeFilter) {
this.operatingAddressCountryCodeFilter = CountryCodeListCopier.copy(operatingAddressCountryCodeFilter);
return this;
}
@Override
@SafeVarargs
public final Builder operatingAddressCountryCodeFilter(String... operatingAddressCountryCodeFilter) {
operatingAddressCountryCodeFilter(Arrays.asList(operatingAddressCountryCodeFilter));
return this;
}
public final Collection getOperatingAddressStateOrRegionFilter() {
if (operatingAddressStateOrRegionFilter instanceof SdkAutoConstructList) {
return null;
}
return operatingAddressStateOrRegionFilter;
}
public final void setOperatingAddressStateOrRegionFilter(Collection operatingAddressStateOrRegionFilter) {
this.operatingAddressStateOrRegionFilter = StateOrRegionListCopier.copy(operatingAddressStateOrRegionFilter);
}
@Override
public final Builder operatingAddressStateOrRegionFilter(Collection operatingAddressStateOrRegionFilter) {
this.operatingAddressStateOrRegionFilter = StateOrRegionListCopier.copy(operatingAddressStateOrRegionFilter);
return this;
}
@Override
@SafeVarargs
public final Builder operatingAddressStateOrRegionFilter(String... operatingAddressStateOrRegionFilter) {
operatingAddressStateOrRegionFilter(Arrays.asList(operatingAddressStateOrRegionFilter));
return this;
}
public final Collection getOperatingAddressCityFilter() {
if (operatingAddressCityFilter instanceof SdkAutoConstructList) {
return null;
}
return operatingAddressCityFilter;
}
public final void setOperatingAddressCityFilter(Collection operatingAddressCityFilter) {
this.operatingAddressCityFilter = CityListCopier.copy(operatingAddressCityFilter);
}
@Override
public final Builder operatingAddressCityFilter(Collection operatingAddressCityFilter) {
this.operatingAddressCityFilter = CityListCopier.copy(operatingAddressCityFilter);
return this;
}
@Override
@SafeVarargs
public final Builder operatingAddressCityFilter(String... operatingAddressCityFilter) {
operatingAddressCityFilter(Arrays.asList(operatingAddressCityFilter));
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 ListSitesRequest build() {
return new ListSitesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy