software.amazon.awssdk.services.appsync.model.CachingConfig Maven / Gradle / Ivy
Show all versions of appsync 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.appsync.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.Function;
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;
/**
*
* The caching configuration for a resolver that has caching activated.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class CachingConfig implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField TTL_FIELD = SdkField. builder(MarshallingType.LONG).memberName("ttl")
.getter(getter(CachingConfig::ttl)).setter(setter(Builder::ttl))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ttl").build()).build();
private static final SdkField> CACHING_KEYS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("cachingKeys")
.getter(getter(CachingConfig::cachingKeys))
.setter(setter(Builder::cachingKeys))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("cachingKeys").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 List> SDK_FIELDS = Collections
.unmodifiableList(Arrays.asList(TTL_FIELD, CACHING_KEYS_FIELD));
private static final long serialVersionUID = 1L;
private final Long ttl;
private final List cachingKeys;
private CachingConfig(BuilderImpl builder) {
this.ttl = builder.ttl;
this.cachingKeys = builder.cachingKeys;
}
/**
*
* The TTL in seconds for a resolver that has caching activated.
*
*
* Valid values are 1–3,600 seconds.
*
*
* @return The TTL in seconds for a resolver that has caching activated.
*
* Valid values are 1–3,600 seconds.
*/
public final Long ttl() {
return ttl;
}
/**
* For responses, this returns true if the service returned a value for the CachingKeys 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 hasCachingKeys() {
return cachingKeys != null && !(cachingKeys instanceof SdkAutoConstructList);
}
/**
*
* The caching keys for a resolver that has caching activated.
*
*
* Valid values are entries from the $context.arguments, $context.source, and
* $context.identity maps.
*
*
* 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 #hasCachingKeys} method.
*
*
* @return The caching keys for a resolver that has caching activated.
*
* Valid values are entries from the $context.arguments, $context.source, and
* $context.identity maps.
*/
public final List cachingKeys() {
return cachingKeys;
}
@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(ttl());
hashCode = 31 * hashCode + Objects.hashCode(hasCachingKeys() ? cachingKeys() : 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 CachingConfig)) {
return false;
}
CachingConfig other = (CachingConfig) obj;
return Objects.equals(ttl(), other.ttl()) && hasCachingKeys() == other.hasCachingKeys()
&& Objects.equals(cachingKeys(), other.cachingKeys());
}
/**
* 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("CachingConfig").add("Ttl", ttl()).add("CachingKeys", hasCachingKeys() ? cachingKeys() : null)
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ttl":
return Optional.ofNullable(clazz.cast(ttl()));
case "cachingKeys":
return Optional.ofNullable(clazz.cast(cachingKeys()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CachingConfig) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The TTL in seconds for a resolver that has caching activated.
*
*
* Valid values are 1–3,600 seconds.
*
*
* @param ttl
* The TTL in seconds for a resolver that has caching activated.
*
* Valid values are 1–3,600 seconds.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ttl(Long ttl);
/**
*
* The caching keys for a resolver that has caching activated.
*
*
* Valid values are entries from the $context.arguments, $context.source, and
* $context.identity maps.
*
*
* @param cachingKeys
* The caching keys for a resolver that has caching activated.
*
* Valid values are entries from the $context.arguments, $context.source, and
* $context.identity maps.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cachingKeys(Collection cachingKeys);
/**
*
* The caching keys for a resolver that has caching activated.
*
*
* Valid values are entries from the $context.arguments, $context.source, and
* $context.identity maps.
*
*
* @param cachingKeys
* The caching keys for a resolver that has caching activated.
*
* Valid values are entries from the $context.arguments, $context.source, and
* $context.identity maps.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cachingKeys(String... cachingKeys);
}
static final class BuilderImpl implements Builder {
private Long ttl;
private List cachingKeys = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CachingConfig model) {
ttl(model.ttl);
cachingKeys(model.cachingKeys);
}
public final Long getTtl() {
return ttl;
}
public final void setTtl(Long ttl) {
this.ttl = ttl;
}
@Override
public final Builder ttl(Long ttl) {
this.ttl = ttl;
return this;
}
public final Collection getCachingKeys() {
if (cachingKeys instanceof SdkAutoConstructList) {
return null;
}
return cachingKeys;
}
public final void setCachingKeys(Collection cachingKeys) {
this.cachingKeys = CachingKeysCopier.copy(cachingKeys);
}
@Override
public final Builder cachingKeys(Collection cachingKeys) {
this.cachingKeys = CachingKeysCopier.copy(cachingKeys);
return this;
}
@Override
@SafeVarargs
public final Builder cachingKeys(String... cachingKeys) {
cachingKeys(Arrays.asList(cachingKeys));
return this;
}
@Override
public CachingConfig build() {
return new CachingConfig(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}