Class CachePointBlock

java.lang.Object
software.amazon.awssdk.services.bedrockruntime.model.CachePointBlock
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CachePointBlock.Builder,CachePointBlock>
@Generated("software.amazon.awssdk:codegen") public final class CachePointBlock extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CachePointBlock.Builder,CachePointBlock>

Defines a section of content to be cached for reuse in subsequent API calls.

See Also:

  • Method Details

    • type

      public final CachePointType type()

      Specifies the type of cache point within the CachePointBlock.

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

      Returns:
      Specifies the type of cache point within the CachePointBlock.
      See Also:

    • typeAsString

      public final String typeAsString()

      Specifies the type of cache point within the CachePointBlock.

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

      Returns:
      Specifies the type of cache point within the CachePointBlock.
      See Also:

    • ttl

      public final CacheTTL ttl()

      Optional TTL duration for cache entries. When specified, enables extended TTL caching with the specified duration. When omitted, uses type value for caching behavior.

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

      Returns:
      Optional TTL duration for cache entries. When specified, enables extended TTL caching with the specified duration. When omitted, uses type value for caching behavior.
      See Also:

    • ttlAsString

      public final String ttlAsString()

      Optional TTL duration for cache entries. When specified, enables extended TTL caching with the specified duration. When omitted, uses type value for caching behavior.

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

      Returns:
      Optional TTL duration for cache entries. When specified, enables extended TTL caching with the specified duration. When omitted, uses type value for caching behavior.
      See Also:

    • toBuilder

      public CachePointBlock.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<CachePointBlock.Builder,CachePointBlock>
      Returns:
      a builder for type T

    • builder

      public static CachePointBlock.Builder builder()

    • serializableBuilderClass

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