Class Value

    • Method Detail

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