Class QueryStringObject

java.lang.Object
software.amazon.awssdk.services.lightsail.model.QueryStringObject
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<QueryStringObject.Builder,QueryStringObject>

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

Describes the query string parameters that an Amazon Lightsail content delivery network (CDN) distribution to bases caching on.

For the query strings that you specify, your distribution caches separate versions of the specified content based on the query string values in viewer requests.

See Also:
  • Method Details

    • option

      public final Boolean option()

      Indicates whether the distribution forwards and caches based on query strings.

      Returns:
      Indicates whether the distribution forwards and caches based on query strings.
    • hasQueryStringsAllowList

      public final boolean hasQueryStringsAllowList()
      For responses, this returns true if the service returned a value for the QueryStringsAllowList 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.
    • queryStringsAllowList

      public final List<String> queryStringsAllowList()

      The specific query strings that the distribution forwards to the origin.

      Your distribution will cache content based on the specified query strings.

      If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.

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

      Returns:
      The specific query strings that the distribution forwards to the origin.

      Your distribution will cache content based on the specified query strings.

      If the option parameter is true, then your distribution forwards all query strings, regardless of what you specify using the queryStringsAllowList parameter.

    • toBuilder

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

      public static QueryStringObject.Builder builder()
    • serializableBuilderClass

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