Class Value

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

Contains the value of a column.

This data structure is only used with the deprecated ExecuteSql operation. Use the BatchExecuteStatement or ExecuteStatement operation instead.

See Also:

  • Method Details

    • isNull

      public final Boolean isNull()

      A NULL value.

      Returns:
      A NULL value.

    • bitValue

      public final Boolean bitValue()

      A value for a column of BIT data type.

      Returns:
      A value for a column of BIT data type.

    • bigIntValue

      public final Long bigIntValue()

      A value for a column of big integer data type.

      Returns:
      A value for a column of big integer data type.

    • intValue

      public final Integer intValue()

      A value for a column of integer data type.

      Returns:
      A value for a column of integer data type.

    • doubleValue

      public final Double doubleValue()

      A value for a column of double data type.

      Returns:
      A value for a column of double data type.

    • realValue

      public final Float realValue()

      A value for a column of real data type.

      Returns:
      A value for a column of real data type.

    • stringValue

      public final String stringValue()

      A value for a column of string data type.

      Returns:
      A value for a column of string data type.

    • blobValue

      public final SdkBytes blobValue()

      A value for a column of BLOB data type.

      Returns:
      A value for a column of BLOB data type.

    • hasArrayValues

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

    • arrayValues

      public final List<Value> arrayValues()

      An array of column values.

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

      Returns:
      An array of column values.

    • structValue

      public final StructValue structValue()

      A value for a column of STRUCT data type.

      Returns:
      A value for a column of STRUCT data type.

    • toBuilder

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

    • builder

      public static Value.Builder builder()

    • serializableBuilderClass

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

    • fromIsNull

      public static Value fromIsNull(Boolean isNull)
      Create an instance of this class with isNull() initialized to the given value.

      A NULL value.

      Parameters:
      isNull - A NULL value.

    • fromBitValue

      public static Value fromBitValue(Boolean bitValue)
      Create an instance of this class with bitValue() initialized to the given value.

      A value for a column of BIT data type.

      Parameters:
      bitValue - A value for a column of BIT data type.

    • fromBigIntValue

      public static Value fromBigIntValue(Long bigIntValue)
      Create an instance of this class with bigIntValue() initialized to the given value.

      A value for a column of big integer data type.

      Parameters:
      bigIntValue - A value for a column of big integer data type.

    • fromIntValue

      public static Value fromIntValue(Integer intValue)
      Create an instance of this class with intValue() initialized to the given value.

      A value for a column of integer data type.

      Parameters:
      intValue - A value for a column of integer data type.

    • fromDoubleValue

      public static Value fromDoubleValue(Double doubleValue)
      Create an instance of this class with doubleValue() initialized to the given value.

      A value for a column of double data type.

      Parameters:
      doubleValue - A value for a column of double data type.

    • fromRealValue

      public static Value fromRealValue(Float realValue)
      Create an instance of this class with realValue() initialized to the given value.

      A value for a column of real data type.

      Parameters:
      realValue - A value for a column of real data type.

    • fromStringValue

      public static Value fromStringValue(String stringValue)
      Create an instance of this class with stringValue() initialized to the given value.

      A value for a column of string data type.

      Parameters:
      stringValue - A value for a column of string data type.

    • fromBlobValue

      public static Value fromBlobValue(SdkBytes blobValue)
      Create an instance of this class with blobValue() initialized to the given value.

      A value for a column of BLOB data type.

      Parameters:
      blobValue - A value for a column of BLOB data type.

    • fromArrayValues

      public static Value fromArrayValues(List<Value> arrayValues)
      Create an instance of this class with arrayValues() initialized to the given value.

      An array of column values.

      Parameters:
      arrayValues - An array of column values.

    • fromStructValue

      public static Value fromStructValue(StructValue structValue)
      Create an instance of this class with structValue() initialized to the given value.

      A value for a column of STRUCT data type.

      Parameters:
      structValue - A value for a column of STRUCT data type.

    • fromStructValue

      public static Value fromStructValue(Consumer<StructValue.Builder> structValue)
      Create an instance of this class with structValue() initialized to the given value.

      A value for a column of STRUCT data type.

      Parameters:
      structValue - A value for a column of STRUCT data type.

    • type

      public Value.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be Value.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be Value.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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