software.amazon.awssdk.services.elasticloadbalancingv2.model.QueryStringConditionConfig 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.elasticloadbalancingv2.model;
import java.io.Serializable;
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;
/**
*
* Information about a query string condition.
*
*
* The query string component of a URI starts after the first '?' character and is terminated by either a '#' character
* or the end of the URI. A typical query string contains key/value pairs separated by '&' characters. The allowed
* characters are specified by RFC 3986. Any character can be percentage encoded.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class QueryStringConditionConfig implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField> VALUES_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Values")
.getter(getter(QueryStringConditionConfig::values))
.setter(setter(Builder::values))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Values").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(QueryStringKeyValuePair::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(VALUES_FIELD));
private static final long serialVersionUID = 1L;
private final List values;
private QueryStringConditionConfig(BuilderImpl builder) {
this.values = builder.values;
}
/**
* Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not
* specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
*/
public final boolean hasValues() {
return values != null && !(values instanceof SdkAutoConstructList);
}
/**
*
* One or more key/value pairs or values to find in the query string. The maximum size of each string is 128
* characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0 or
* more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a query
* string, you must escape these characters in Values using a '\' character.
*
*
* If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the
* query string.
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* You can use {@link #hasValues()} to see if a value was sent in this field.
*
*
* @return One or more key/value pairs or values to find in the query string. The maximum size of each string is 128
* characters. The comparison is case insensitive. The following wildcard characters are supported: *
* (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?'
* character in a query string, you must escape these characters in Values using a '\'
* character.
*
* If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in
* the query string.
*/
public final List values() {
return values;
}
@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 + Objects.hashCode(hasValues() ? values() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof QueryStringConditionConfig)) {
return false;
}
QueryStringConditionConfig other = (QueryStringConditionConfig) obj;
return hasValues() == other.hasValues() && Objects.equals(values(), other.values());
}
/**
* 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("QueryStringConditionConfig").add("Values", hasValues() ? values() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Values":
return Optional.ofNullable(clazz.cast(values()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((QueryStringConditionConfig) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* One or more key/value pairs or values to find in the query string. The maximum size of each string is 128
* characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0
* or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a
* query string, you must escape these characters in Values using a '\' character.
*
*
* If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the
* query string.
*
*
* @param values
* One or more key/value pairs or values to find in the query string. The maximum size of each string is
* 128 characters. The comparison is case insensitive. The following wildcard characters are supported: *
* (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?'
* character in a query string, you must escape these characters in Values using a '\'
* character.
*
* If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found
* in the query string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(Collection values);
/**
*
* One or more key/value pairs or values to find in the query string. The maximum size of each string is 128
* characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0
* or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a
* query string, you must escape these characters in Values using a '\' character.
*
*
* If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the
* query string.
*
*
* @param values
* One or more key/value pairs or values to find in the query string. The maximum size of each string is
* 128 characters. The comparison is case insensitive. The following wildcard characters are supported: *
* (matches 0 or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?'
* character in a query string, you must escape these characters in Values using a '\'
* character.
*
* If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found
* in the query string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder values(QueryStringKeyValuePair... values);
/**
*
* One or more key/value pairs or values to find in the query string. The maximum size of each string is 128
* characters. The comparison is case insensitive. The following wildcard characters are supported: * (matches 0
* or more characters) and ? (matches exactly 1 character). To search for a literal '*' or '?' character in a
* query string, you must escape these characters in Values using a '\' character.
*
*
* If you specify multiple key/value pairs or values, the condition is satisfied if one of them is found in the
* query string.
*
* This is a convenience that creates an instance of the {@link List.Builder} avoiding
* the need to create one manually via {@link List#builder()}.
*
* When the {@link Consumer} completes, {@link List.Builder#build()} is called
* immediately and its result is passed to {@link #values(List)}.
*
* @param values
* a consumer that will call methods on {@link List.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #values(List)
*/
Builder values(Consumer... values);
}
static final class BuilderImpl implements Builder {
private List values = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(QueryStringConditionConfig model) {
values(model.values);
}
public final Collection getValues() {
if (values instanceof SdkAutoConstructList) {
return null;
}
return values != null ? values.stream().map(QueryStringKeyValuePair::toBuilder).collect(Collectors.toList()) : null;
}
@Override
public final Builder values(Collection values) {
this.values = QueryStringKeyValuePairListCopier.copy(values);
return this;
}
@Override
@SafeVarargs
public final Builder values(QueryStringKeyValuePair... values) {
values(Arrays.asList(values));
return this;
}
@Override
@SafeVarargs
public final Builder values(Consumer... values) {
values(Stream.of(values).map(c -> QueryStringKeyValuePair.builder().applyMutation(c).build())
.collect(Collectors.toList()));
return this;
}
public final void setValues(Collection values) {
this.values = QueryStringKeyValuePairListCopier.copyFromBuilder(values);
}
@Override
public QueryStringConditionConfig build() {
return new QueryStringConditionConfig(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}