software.amazon.awssdk.services.workspaces.model.DescribeIpGroupsRequest Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of workspaces Show documentation
Show all versions of workspaces Show documentation
The AWS Java SDK for Amazon WorkSpaces module holds the client classes that are used for communicating
with Amazon
WorkSpaces 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.workspaces.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 DescribeIpGroupsRequest extends WorkSpacesRequest implements
ToCopyableBuilder {
private static final SdkField> GROUP_IDS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("GroupIds")
.getter(getter(DescribeIpGroupsRequest::groupIds))
.setter(setter(Builder::groupIds))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GroupIds").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(DescribeIpGroupsRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextToken").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("MaxResults").getter(getter(DescribeIpGroupsRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(GROUP_IDS_FIELD,
NEXT_TOKEN_FIELD, MAX_RESULTS_FIELD));
private final List groupIds;
private final String nextToken;
private final Integer maxResults;
private DescribeIpGroupsRequest(BuilderImpl builder) {
super(builder);
this.groupIds = builder.groupIds;
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
}
/**
* For responses, this returns true if the service returned a value for the GroupIds 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 hasGroupIds() {
return groupIds != null && !(groupIds instanceof SdkAutoConstructList);
}
/**
*
* The identifiers of one or more IP access control groups.
*
*
* 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 #hasGroupIds} method.
*
*
* @return The identifiers of one or more IP access control groups.
*/
public final List groupIds() {
return groupIds;
}
/**
*
* If you received a NextToken from a previous call that was paginated, provide this token to receive
* the next set of results.
*
*
* @return If you received a NextToken from a previous call that was paginated, provide this token to
* receive the next set of results.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The maximum number of items to return.
*
*
* @return The maximum number of items to return.
*/
public final Integer maxResults() {
return maxResults;
}
@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(hasGroupIds() ? groupIds() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
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 DescribeIpGroupsRequest)) {
return false;
}
DescribeIpGroupsRequest other = (DescribeIpGroupsRequest) obj;
return hasGroupIds() == other.hasGroupIds() && Objects.equals(groupIds(), other.groupIds())
&& Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults());
}
/**
* 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("DescribeIpGroupsRequest").add("GroupIds", hasGroupIds() ? groupIds() : null)
.add("NextToken", nextToken()).add("MaxResults", maxResults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "GroupIds":
return Optional.ofNullable(clazz.cast(groupIds()));
case "NextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "MaxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DescribeIpGroupsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends WorkSpacesRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The identifiers of one or more IP access control groups.
*
*
* @param groupIds
* The identifiers of one or more IP access control groups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groupIds(Collection groupIds);
/**
*
* The identifiers of one or more IP access control groups.
*
*
* @param groupIds
* The identifiers of one or more IP access control groups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder groupIds(String... groupIds);
/**
*
* If you received a NextToken from a previous call that was paginated, provide this token to
* receive the next set of results.
*
*
* @param nextToken
* If you received a NextToken from a previous call that was paginated, provide this token
* to receive the next set of results.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The maximum number of items to return.
*
*
* @param maxResults
* The maximum number of items to return.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends WorkSpacesRequest.BuilderImpl implements Builder {
private List groupIds = DefaultSdkAutoConstructList.getInstance();
private String nextToken;
private Integer maxResults;
private BuilderImpl() {
}
private BuilderImpl(DescribeIpGroupsRequest model) {
super(model);
groupIds(model.groupIds);
nextToken(model.nextToken);
maxResults(model.maxResults);
}
public final Collection getGroupIds() {
if (groupIds instanceof SdkAutoConstructList) {
return null;
}
return groupIds;
}
public final void setGroupIds(Collection groupIds) {
this.groupIds = IpGroupIdListCopier.copy(groupIds);
}
@Override
public final Builder groupIds(Collection groupIds) {
this.groupIds = IpGroupIdListCopier.copy(groupIds);
return this;
}
@Override
@SafeVarargs
public final Builder groupIds(String... groupIds) {
groupIds(Arrays.asList(groupIds));
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;
}
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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public DescribeIpGroupsRequest build() {
return new DescribeIpGroupsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}