software.amazon.awssdk.services.shield.model.ListProtectionGroupsRequest Maven / Gradle / Ivy
Show all versions of shield 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.shield.model;
import java.util.Arrays;
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.LocationTrait;
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 ListProtectionGroupsRequest extends ShieldRequest implements
ToCopyableBuilder {
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextToken").getter(getter(ListProtectionGroupsRequest::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(ListProtectionGroupsRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MaxResults").build()).build();
private static final SdkField INCLUSION_FILTERS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("InclusionFilters")
.getter(getter(ListProtectionGroupsRequest::inclusionFilters)).setter(setter(Builder::inclusionFilters))
.constructor(InclusionProtectionGroupFilters::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("InclusionFilters").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NEXT_TOKEN_FIELD,
MAX_RESULTS_FIELD, INCLUSION_FILTERS_FIELD));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String nextToken;
private final Integer maxResults;
private final InclusionProtectionGroupFilters inclusionFilters;
private ListProtectionGroupsRequest(BuilderImpl builder) {
super(builder);
this.nextToken = builder.nextToken;
this.maxResults = builder.maxResults;
this.inclusionFilters = builder.inclusionFilters;
}
/**
*
* When you request a list of objects from Shield Advanced, if the response does not include all of the remaining
* available objects, Shield Advanced includes a NextToken value in the response. You can retrieve the
* next batch of objects by requesting the list again and providing the token that was returned by the prior call in
* your request.
*
*
* You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with the
* MaxResults setting. Shield Advanced will not return more than MaxResults objects, but
* may return fewer, even if more objects are still available.
*
*
* Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
* NextToken value.
*
*
* On your first call to a list operation, leave this setting empty.
*
*
* @return When you request a list of objects from Shield Advanced, if the response does not include all of the
* remaining available objects, Shield Advanced includes a NextToken value in the response. You
* can retrieve the next batch of objects by requesting the list again and providing the token that was
* returned by the prior call in your request.
*
* You can indicate the maximum number of objects that you want Shield Advanced to return for a single call
* with the MaxResults setting. Shield Advanced will not return more than
* MaxResults objects, but may return fewer, even if more objects are still available.
*
*
* Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include
* a NextToken value.
*
*
* On your first call to a list operation, leave this setting empty.
*/
public final String nextToken() {
return nextToken;
}
/**
*
* The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced might
* return fewer objects than you indicate in this setting, even if more objects are available. If there are more
* objects remaining, Shield Advanced will always also return a NextToken value in the response.
*
*
* The default setting is 20.
*
*
* @return The greatest number of objects that you want Shield Advanced to return to the list request. Shield
* Advanced might return fewer objects than you indicate in this setting, even if more objects are
* available. If there are more objects remaining, Shield Advanced will always also return a
* NextToken value in the response.
*
* The default setting is 20.
*/
public final Integer maxResults() {
return maxResults;
}
/**
*
* Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by its
* name and you can retrieve all protection groups that are configured with specific pattern or aggregation
* settings. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups that
* exactly match all of the search criteria that you provide.
*
*
* @return Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group
* by its name and you can retrieve all protection groups that are configured with specific pattern or
* aggregation settings. You can provide up to one criteria per filter type. Shield Advanced returns the
* protection groups that exactly match all of the search criteria that you provide.
*/
public final InclusionProtectionGroupFilters inclusionFilters() {
return inclusionFilters;
}
@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(inclusionFilters());
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 ListProtectionGroupsRequest)) {
return false;
}
ListProtectionGroupsRequest other = (ListProtectionGroupsRequest) obj;
return Objects.equals(nextToken(), other.nextToken()) && Objects.equals(maxResults(), other.maxResults())
&& Objects.equals(inclusionFilters(), other.inclusionFilters());
}
/**
* 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("ListProtectionGroupsRequest").add("NextToken", nextToken()).add("MaxResults", maxResults())
.add("InclusionFilters", inclusionFilters()).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 "InclusionFilters":
return Optional.ofNullable(clazz.cast(inclusionFilters()));
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("NextToken", NEXT_TOKEN_FIELD);
map.put("MaxResults", MAX_RESULTS_FIELD);
map.put("InclusionFilters", INCLUSION_FILTERS_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((ListProtectionGroupsRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends ShieldRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* When you request a list of objects from Shield Advanced, if the response does not include all of the
* remaining available objects, Shield Advanced includes a NextToken value in the response. You can
* retrieve the next batch of objects by requesting the list again and providing the token that was returned by
* the prior call in your request.
*
*
* You can indicate the maximum number of objects that you want Shield Advanced to return for a single call with
* the MaxResults setting. Shield Advanced will not return more than MaxResults
* objects, but may return fewer, even if more objects are still available.
*
*
* Whenever more objects remain that Shield Advanced has not yet returned to you, the response will include a
* NextToken value.
*
*
* On your first call to a list operation, leave this setting empty.
*
*
* @param nextToken
* When you request a list of objects from Shield Advanced, if the response does not include all of the
* remaining available objects, Shield Advanced includes a NextToken value in the response.
* You can retrieve the next batch of objects by requesting the list again and providing the token that
* was returned by the prior call in your request.
*
* You can indicate the maximum number of objects that you want Shield Advanced to return for a single
* call with the MaxResults setting. Shield Advanced will not return more than
* MaxResults objects, but may return fewer, even if more objects are still available.
*
*
* Whenever more objects remain that Shield Advanced has not yet returned to you, the response will
* include a NextToken value.
*
*
* On your first call to a list operation, leave this setting empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextToken(String nextToken);
/**
*
* The greatest number of objects that you want Shield Advanced to return to the list request. Shield Advanced
* might return fewer objects than you indicate in this setting, even if more objects are available. If there
* are more objects remaining, Shield Advanced will always also return a NextToken value in the
* response.
*
*
* The default setting is 20.
*
*
* @param maxResults
* The greatest number of objects that you want Shield Advanced to return to the list request. Shield
* Advanced might return fewer objects than you indicate in this setting, even if more objects are
* available. If there are more objects remaining, Shield Advanced will always also return a
* NextToken value in the response.
*
* The default setting is 20.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder maxResults(Integer maxResults);
/**
*
* Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by
* its name and you can retrieve all protection groups that are configured with specific pattern or aggregation
* settings. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups
* that exactly match all of the search criteria that you provide.
*
*
* @param inclusionFilters
* Narrows the set of protection groups that the call retrieves. You can retrieve a single protection
* group by its name and you can retrieve all protection groups that are configured with specific pattern
* or aggregation settings. You can provide up to one criteria per filter type. Shield Advanced returns
* the protection groups that exactly match all of the search criteria that you provide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder inclusionFilters(InclusionProtectionGroupFilters inclusionFilters);
/**
*
* Narrows the set of protection groups that the call retrieves. You can retrieve a single protection group by
* its name and you can retrieve all protection groups that are configured with specific pattern or aggregation
* settings. You can provide up to one criteria per filter type. Shield Advanced returns the protection groups
* that exactly match all of the search criteria that you provide.
*
* This is a convenience method that creates an instance of the {@link InclusionProtectionGroupFilters.Builder}
* avoiding the need to create one manually via {@link InclusionProtectionGroupFilters#builder()}.
*
*
* When the {@link Consumer} completes, {@link InclusionProtectionGroupFilters.Builder#build()} is called
* immediately and its result is passed to {@link #inclusionFilters(InclusionProtectionGroupFilters)}.
*
* @param inclusionFilters
* a consumer that will call methods on {@link InclusionProtectionGroupFilters.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #inclusionFilters(InclusionProtectionGroupFilters)
*/
default Builder inclusionFilters(Consumer inclusionFilters) {
return inclusionFilters(InclusionProtectionGroupFilters.builder().applyMutation(inclusionFilters).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends ShieldRequest.BuilderImpl implements Builder {
private String nextToken;
private Integer maxResults;
private InclusionProtectionGroupFilters inclusionFilters;
private BuilderImpl() {
}
private BuilderImpl(ListProtectionGroupsRequest model) {
super(model);
nextToken(model.nextToken);
maxResults(model.maxResults);
inclusionFilters(model.inclusionFilters);
}
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 InclusionProtectionGroupFilters.Builder getInclusionFilters() {
return inclusionFilters != null ? inclusionFilters.toBuilder() : null;
}
public final void setInclusionFilters(InclusionProtectionGroupFilters.BuilderImpl inclusionFilters) {
this.inclusionFilters = inclusionFilters != null ? inclusionFilters.build() : null;
}
@Override
public final Builder inclusionFilters(InclusionProtectionGroupFilters inclusionFilters) {
this.inclusionFilters = inclusionFilters;
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 ListProtectionGroupsRequest build() {
return new ListProtectionGroupsRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}