Class CacheBehaviorPerPath

java.lang.Object
software.amazon.awssdk.services.lightsail.model.CacheBehaviorPerPath
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CacheBehaviorPerPath.Builder,CacheBehaviorPerPath>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public CacheBehaviorPerPath.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CacheBehaviorPerPath.Builder,CacheBehaviorPerPath>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.