software.amazon.awssdk.services.wafv2.model.ListLoggingConfigurationsResponse Maven / Gradle / Ivy
/*
* 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.wafv2.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 java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
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 ListLoggingConfigurationsResponse extends Wafv2Response implements
ToCopyableBuilder {
private static final SdkField> LOGGING_CONFIGURATIONS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("LoggingConfigurations")
.getter(getter(ListLoggingConfigurationsResponse::loggingConfigurations))
.setter(setter(Builder::loggingConfigurations))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("LoggingConfigurations").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(LoggingConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField NEXT_MARKER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("NextMarker").getter(getter(ListLoggingConfigurationsResponse::nextMarker))
.setter(setter(Builder::nextMarker))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("NextMarker").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(LOGGING_CONFIGURATIONS_FIELD,
NEXT_MARKER_FIELD));
private final List loggingConfigurations;
private final String nextMarker;
private ListLoggingConfigurationsResponse(BuilderImpl builder) {
super(builder);
this.loggingConfigurations = builder.loggingConfigurations;
this.nextMarker = builder.nextMarker;
}
/**
* For responses, this returns true if the service returned a value for the LoggingConfigurations 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 hasLoggingConfigurations() {
return loggingConfigurations != null && !(loggingConfigurations instanceof SdkAutoConstructList);
}
/**
*
* Array of logging configurations. If you specified a Limit in your request, this might not be the
* full list.
*
*
* 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 #hasLoggingConfigurations} method.
*
*
* @return Array of logging configurations. If you specified a Limit in your request, this might not be
* the full list.
*/
public final List loggingConfigurations() {
return loggingConfigurations;
}
/**
*
* When you request a list of objects with a Limit setting, if the number of objects that are still
* available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
* retrieve the next batch of objects, provide the marker from the prior call in your next request.
*
*
* @return When you request a list of objects with a Limit setting, if the number of objects that are
* still available for retrieval exceeds the limit, WAF returns a NextMarker value in the
* response. To retrieve the next batch of objects, provide the marker from the prior call in your next
* request.
*/
public final String nextMarker() {
return nextMarker;
}
@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(hasLoggingConfigurations() ? loggingConfigurations() : null);
hashCode = 31 * hashCode + Objects.hashCode(nextMarker());
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 ListLoggingConfigurationsResponse)) {
return false;
}
ListLoggingConfigurationsResponse other = (ListLoggingConfigurationsResponse) obj;
return hasLoggingConfigurations() == other.hasLoggingConfigurations()
&& Objects.equals(loggingConfigurations(), other.loggingConfigurations())
&& Objects.equals(nextMarker(), other.nextMarker());
}
/**
* 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("ListLoggingConfigurationsResponse")
.add("LoggingConfigurations", hasLoggingConfigurations() ? loggingConfigurations() : null)
.add("NextMarker", nextMarker()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "LoggingConfigurations":
return Optional.ofNullable(clazz.cast(loggingConfigurations()));
case "NextMarker":
return Optional.ofNullable(clazz.cast(nextMarker()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListLoggingConfigurationsResponse) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends Wafv2Response.Builder, SdkPojo, CopyableBuilder {
/**
*
* Array of logging configurations. If you specified a Limit in your request, this might not be the
* full list.
*
*
* @param loggingConfigurations
* Array of logging configurations. If you specified a Limit in your request, this might not
* be the full list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder loggingConfigurations(Collection loggingConfigurations);
/**
*
* Array of logging configurations. If you specified a Limit in your request, this might not be the
* full list.
*
*
* @param loggingConfigurations
* Array of logging configurations. If you specified a Limit in your request, this might not
* be the full list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder loggingConfigurations(LoggingConfiguration... loggingConfigurations);
/**
*
* Array of logging configurations. If you specified a Limit in your request, this might not be the
* full list.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.wafv2.model.LoggingConfiguration.Builder} avoiding the need to create
* one manually via {@link software.amazon.awssdk.services.wafv2.model.LoggingConfiguration#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.wafv2.model.LoggingConfiguration.Builder#build()} is called
* immediately and its result is passed to {@link #loggingConfigurations(List)}.
*
* @param loggingConfigurations
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.wafv2.model.LoggingConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #loggingConfigurations(java.util.Collection)
*/
Builder loggingConfigurations(Consumer... loggingConfigurations);
/**
*
* When you request a list of objects with a Limit setting, if the number of objects that are still
* available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
* retrieve the next batch of objects, provide the marker from the prior call in your next request.
*
*
* @param nextMarker
* When you request a list of objects with a Limit setting, if the number of objects that
* are still available for retrieval exceeds the limit, WAF returns a NextMarker value in
* the response. To retrieve the next batch of objects, provide the marker from the prior call in your
* next request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder nextMarker(String nextMarker);
}
static final class BuilderImpl extends Wafv2Response.BuilderImpl implements Builder {
private List loggingConfigurations = DefaultSdkAutoConstructList.getInstance();
private String nextMarker;
private BuilderImpl() {
}
private BuilderImpl(ListLoggingConfigurationsResponse model) {
super(model);
loggingConfigurations(model.loggingConfigurations);
nextMarker(model.nextMarker);
}
public final List getLoggingConfigurations() {
List result = LoggingConfigurationsCopier.copyToBuilder(this.loggingConfigurations);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setLoggingConfigurations(Collection loggingConfigurations) {
this.loggingConfigurations = LoggingConfigurationsCopier.copyFromBuilder(loggingConfigurations);
}
@Override
public final Builder loggingConfigurations(Collection loggingConfigurations) {
this.loggingConfigurations = LoggingConfigurationsCopier.copy(loggingConfigurations);
return this;
}
@Override
@SafeVarargs
public final Builder loggingConfigurations(LoggingConfiguration... loggingConfigurations) {
loggingConfigurations(Arrays.asList(loggingConfigurations));
return this;
}
@Override
@SafeVarargs
public final Builder loggingConfigurations(Consumer... loggingConfigurations) {
loggingConfigurations(Stream.of(loggingConfigurations)
.map(c -> LoggingConfiguration.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final String getNextMarker() {
return nextMarker;
}
public final void setNextMarker(String nextMarker) {
this.nextMarker = nextMarker;
}
@Override
public final Builder nextMarker(String nextMarker) {
this.nextMarker = nextMarker;
return this;
}
@Override
public ListLoggingConfigurationsResponse build() {
return new ListLoggingConfigurationsResponse(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}