software.amazon.awssdk.services.lightsail.model

Class CacheBehaviorPerPath

java.lang.Object

software.amazon.awssdk.services.lightsail.model.CacheBehaviorPerPath

All Implemented Interfaces:

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

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

Describes the per-path cache behavior of an Amazon Lightsail content delivery network (CDN) distribution.

A per-path cache behavior is used to override, or add an exception to, the default cache behavior of a distribution. For example, if the cacheBehavior is set to cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will cache. Alternately, if the distribution's cacheBehavior is dont-cache, then a per-path cache behavior can be used to specify a directory, file, or file type that your distribution will not cache.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CacheBehaviorPerPath.Builder

Method Summary

Modifier and Type	Method and Description
BehaviorEnum	behavior() The cache behavior for the specified path.
String	behaviorAsString() The cache behavior for the specified path.
static CacheBehaviorPerPath.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	path() The path to a directory or file to cached, or not cache.
List<SdkField<?>>	sdkFields()
static Class<? extends CacheBehaviorPerPath.Builder>	serializableBuilderClass()
CacheBehaviorPerPath.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

path

public final String path()

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories ( path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive.

Examples:

• Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.

  var/www/html/

• Specify the following file to cache only the index page in the document root of an Apache web server.

  var/www/html/index.html

• Specify the following to cache only the .html files in the document root of an Apache web server.

  var/www/html/*.html

• Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/*.jpg

  var/www/html/images/*.png

  var/www/html/images/*.gif

  Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/

Returns:

The path to a directory or file to cached, or not cache. Use an asterisk symbol to specify wildcard directories (path/to/assets/*), and file types (*.html, *jpg, *js). Directories and file paths are case-sensitive.

Examples:

• Specify the following to cache all files in the document root of an Apache web server running on a Lightsail instance.

  var/www/html/

• Specify the following file to cache only the index page in the document root of an Apache web server.

  var/www/html/index.html

• Specify the following to cache only the .html files in the document root of an Apache web server.

  var/www/html/*.html

• Specify the following to cache only the .jpg, .png, and .gif files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/*.jpg

  var/www/html/images/*.png

  var/www/html/images/*.gif

  Specify the following to cache all files in the images sub-directory of the document root of an Apache web server.

  var/www/html/images/

behavior

public final BehaviorEnum behavior()

The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

• cache - This behavior caches the specified path.

• dont-cache - This behavior doesn't cache the specified path.

If the service returns an enum value that is not available in the current SDK version, behavior will return BehaviorEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from behaviorAsString().

Returns:

The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

• cache - This behavior caches the specified path.

• dont-cache - This behavior doesn't cache the specified path.

See Also:

BehaviorEnum

behaviorAsString

public final String behaviorAsString()

The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

• cache - This behavior caches the specified path.

• dont-cache - This behavior doesn't cache the specified path.

If the service returns an enum value that is not available in the current SDK version, behavior will return BehaviorEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from behaviorAsString().

Returns:

The cache behavior for the specified path.

You can specify one of the following per-path cache behaviors:

• cache - This behavior caches the specified path.

• dont-cache - This behavior doesn't cache the specified path.

See Also:

BehaviorEnum

toBuilder

public CacheBehaviorPerPath.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CacheBehaviorPerPath.Builder,CacheBehaviorPerPath>

builder

public static CacheBehaviorPerPath.Builder builder()

serializableBuilderClass

public static Class<? extends CacheBehaviorPerPath.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