Class ResultSetOptions

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

Options that control how the result set is returned.

See Also:

  • Method Details

    • decimalReturnType

      public final DecimalReturnType decimalReturnType()

      A value that indicates how a field of DECIMAL type is represented in the response. The value of STRING, the default, specifies that it is converted to a String value. The value of DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise.

      Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to String, especially when working with currency values.

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

      Returns:
      A value that indicates how a field of DECIMAL type is represented in the response. The value of STRING, the default, specifies that it is converted to a String value. The value of DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise.

      Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to String, especially when working with currency values.

      See Also:

    • decimalReturnTypeAsString

      public final String decimalReturnTypeAsString()

      A value that indicates how a field of DECIMAL type is represented in the response. The value of STRING, the default, specifies that it is converted to a String value. The value of DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise.

      Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to String, especially when working with currency values.

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

      Returns:
      A value that indicates how a field of DECIMAL type is represented in the response. The value of STRING, the default, specifies that it is converted to a String value. The value of DOUBLE_OR_LONG specifies that it is converted to a Long value if its scale is 0, or to a Double value otherwise.

      Conversion to Double or Long can result in roundoff errors due to precision loss. We recommend converting to String, especially when working with currency values.

      See Also:

    • longReturnType

      public final LongReturnType longReturnType()

      A value that indicates how a field of LONG type is represented. Allowed values are LONG and STRING. The default is LONG. Specify STRING if the length or precision of numeric values might cause truncation or rounding errors.

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

      Returns:
      A value that indicates how a field of LONG type is represented. Allowed values are LONG and STRING. The default is LONG. Specify STRING if the length or precision of numeric values might cause truncation or rounding errors.
      See Also:

    • longReturnTypeAsString

      public final String longReturnTypeAsString()

      A value that indicates how a field of LONG type is represented. Allowed values are LONG and STRING. The default is LONG. Specify STRING if the length or precision of numeric values might cause truncation or rounding errors.

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

      Returns:
      A value that indicates how a field of LONG type is represented. Allowed values are LONG and STRING. The default is LONG. Specify STRING if the length or precision of numeric values might cause truncation or rounding errors.
      See Also:

    • toBuilder

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

    • builder

      public static ResultSetOptions.Builder builder()

    • serializableBuilderClass

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