software.amazon.awssdk.services.networkmanager.model.GetSitesRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of networkmanager Show documentation
Show all versions of networkmanager Show documentation
The AWS Java SDK for NetworkManager module holds the client classes that are used for
communicating with NetworkManager.
/*
* 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.networkmanager.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 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 GetSitesRequest extends NetworkManagerRequest implements
ToCopyableBuilder {
private static final SdkField GLOBAL_NETWORK_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("GlobalNetworkId").getter(getter(GetSitesRequest::globalNetworkId))
.setter(setter(Builder::globalNetworkId))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("globalNetworkId").build()).build();
private static final SdkField> SITE_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("SiteIds")
.getter(getter(GetSitesRequest::siteIds))
.setter(setter(Builder::siteIds))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("siteIds").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 MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(GetSitesRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("maxResults").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(GetSitesRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("nextToken").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(GLOBAL_NETWORK_ID_FIELD,
SITE_IDS_FIELD, MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String globalNetworkId;
private final List siteIds;
private final Integer maxResults;
private final String nextToken;
private GetSitesRequest(BuilderImpl builder) {
super(builder);
this.globalNetworkId = builder.globalNetworkId;
this.siteIds = builder.siteIds;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
}
/**
*
* The ID of the global network.
*
*
* @return The ID of the global network.
*/
public final String globalNetworkId() {
return globalNetworkId;
}
/**
* For responses, this returns true if the service returned a value for the SiteIds 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 hasSiteIds() {
return siteIds != null && !(siteIds instanceof SdkAutoConstructList);
}
/**
*
* One or more site IDs. The maximum is 10.
*
*
* 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 #hasSiteIds} method.
*
*
* @return One or more site IDs. The maximum is 10.
*/
public final List siteIds() {
return siteIds;
}
/**
*
* The maximum number of results to return.
*
*
* @return The maximum number of results to return.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* The token for the next page of results.
*
*
* @return The token for the next page of results.
*/
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(globalNetworkId());
hashCode = 31 * hashCode + Objects.hashCode(hasSiteIds() ? siteIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
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 GetSitesRequest)) {
return false;
}
GetSitesRequest other = (GetSitesRequest) obj;
return Objects.equals(globalNetworkId(), other.globalNetworkId()) && hasSiteIds() == other.hasSiteIds()
&& Objects.equals(siteIds(), other.siteIds()) && Objects.equals(maxResults(), other.maxResults())
&& 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("GetSitesRequest").add("GlobalNetworkId", globalNetworkId())
.add("SiteIds", hasSiteIds() ? siteIds() : null).add("MaxResults", maxResults()).add("NextToken", nextToken())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "GlobalNetworkId":
return Optional.ofNullable(clazz.cast(globalNetworkId()));
case "SiteIds":
return Optional.ofNullable(clazz.cast(siteIds()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("globalNetworkId", GLOBAL_NETWORK_ID_FIELD);
map.put("siteIds", SITE_IDS_FIELD);
map.put("maxResults", MAX_RESULTS_FIELD);
map.put("nextToken", NEXT_TOKEN_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((GetSitesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends NetworkManagerRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The ID of the global network.
*
*
* @param globalNetworkId
* The ID of the global network.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder globalNetworkId(String globalNetworkId);
/**
*
* One or more site IDs. The maximum is 10.
*
*
* @param siteIds
* One or more site IDs. The maximum is 10.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder siteIds(Collection siteIds);
/**
*
* One or more site IDs. The maximum is 10.
*
*
* @param siteIds
* One or more site IDs. The maximum is 10.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder siteIds(String... siteIds);
/**
*
* The maximum number of results to return.
*
*
* @param maxResults
* The maximum number of results to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* The token for the next page of results.
*
*
* @param nextToken
* The token for the next page of results.
* @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 NetworkManagerRequest.BuilderImpl implements Builder {
private String globalNetworkId;
private List siteIds = DefaultSdkAutoConstructList.getInstance();
private Integer maxResults;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(GetSitesRequest model) {
super(model);
globalNetworkId(model.globalNetworkId);
siteIds(model.siteIds);
maxResults(model.maxResults);
nextToken(model.nextToken);
}
public final String getGlobalNetworkId() {
return globalNetworkId;
}
public final void setGlobalNetworkId(String globalNetworkId) {
this.globalNetworkId = globalNetworkId;
}
@Override
public final Builder globalNetworkId(String globalNetworkId) {
this.globalNetworkId = globalNetworkId;
return this;
}
public final Collection getSiteIds() {
if (siteIds instanceof SdkAutoConstructList) {
return null;
}
return siteIds;
}
public final void setSiteIds(Collection siteIds) {
this.siteIds = SiteIdListCopier.copy(siteIds);
}
@Override
public final Builder siteIds(Collection siteIds) {
this.siteIds = SiteIdListCopier.copy(siteIds);
return this;
}
@Override
@SafeVarargs
public final Builder siteIds(String... siteIds) {
siteIds(Arrays.asList(siteIds));
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 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 GetSitesRequest build() {
return new GetSitesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy