software.amazon.awssdk.services.appsync.model

Class CachingConfig

java.lang.Object

software.amazon.awssdk.services.appsync.model.CachingConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CachingConfig.Builder,CachingConfig>

@Generated(value="software.amazon.awssdk:codegen")
public final class CachingConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CachingConfig.Builder,CachingConfig>

The caching configuration for a resolver that has caching activated.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CachingConfig.Builder

Method Summary

Modifier and Type	Method and Description
static CachingConfig.Builder	builder()
List<String>	cachingKeys() The caching keys for a resolver that has caching activated.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCachingKeys() For responses, this returns true if the service returned a value for the CachingKeys property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CachingConfig.Builder>	serializableBuilderClass()
CachingConfig.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Long	ttl() The TTL in seconds for a resolver that has caching activated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

ttl

public final Long ttl()

The TTL in seconds for a resolver that has caching activated.

Valid values are 1–3,600 seconds.

Returns:

The TTL in seconds for a resolver that has caching activated.

Valid values are 1–3,600 seconds.

hasCachingKeys

public final boolean hasCachingKeys()

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 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.

cachingKeys

public final List<String> 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.

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 hasCachingKeys() method.

Returns:

The caching keys for a resolver that has caching activated.

Valid values are entries from the $context.arguments, $context.source, and $context.identity maps.

toBuilder

public CachingConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CachingConfig.Builder,CachingConfig>

builder

public static CachingConfig.Builder builder()

serializableBuilderClass

public static Class<? extends CachingConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo