Parameters (AWS SDK for Java

Parameters (AWS SDK for Java - 2.25.34)
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Parameters.Builder,Parameters>

A list of Amazon QuickSight parameters and the list's override values.

See Also:
  • Nested Class Summary

    Nested Classes

    static interface 

  • Method Summary

    The parameters that have a data type of date-time.

    The parameters that have a data type of decimal.

    final boolean

    final boolean

    Indicates whether some other object is "equal to" this one by SDK fields.

    final boolean

    For responses, this returns true if the service returned a value for the DateTimeParameters property.

    final boolean

    For responses, this returns true if the service returned a value for the DecimalParameters property.

    final int

    final boolean

    For responses, this returns true if the service returned a value for the IntegerParameters property.

    final boolean

    For responses, this returns true if the service returned a value for the StringParameters property.

    The parameters that have a data type of integer.

    The parameters that have a data type of string.

    Take this object and create a builder that contains all of the current property values of this object.

    Returns a string representation of this object.

  • Method Details

    • hasStringParameters

      public final boolean hasStringParameters()

      For responses, this returns true if the service returned a value for the StringParameters 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.

    • stringParameters

      The parameters that have a data type of string.

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

      Returns:
      The parameters that have a data type of string.
    • hasIntegerParameters

      public final boolean hasIntegerParameters()

      For responses, this returns true if the service returned a value for the IntegerParameters 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.

    • integerParameters

      The parameters that have a data type of integer.

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

      Returns:
      The parameters that have a data type of integer.
    • hasDecimalParameters

      public final boolean hasDecimalParameters()

      For responses, this returns true if the service returned a value for the DecimalParameters 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.

    • decimalParameters

      The parameters that have a data type of decimal.

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

      Returns:
      The parameters that have a data type of decimal.
    • hasDateTimeParameters

      public final boolean hasDateTimeParameters()

      For responses, this returns true if the service returned a value for the DateTimeParameters 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.

    • dateTimeParameters

      The parameters that have a data type of date-time.

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

      Returns:
      The parameters that have a data type of date-time.
    • toBuilder

      Take this object and create a builder that contains all of the current property values of this object.

      Specified by:
      toBuilder in interface ToCopyableBuilder<Parameters.Builder,Parameters>
      Returns:
      a builder for type T
    • 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: SdkPojoIndicates 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

    • sdkFields

      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

You Might Also Like