Class UpdateListRequest

    • Method Detail

      • name

        public final String name()

        The name of the list to update.

        Returns:
        The name of the list to update.
      • hasElements

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

        public final List<String> elements()

        One or more list elements to add or replace. If you are providing the elements, make sure to specify the updateMode to use.

        If you are deleting all elements from the list, use REPLACE for the updateMode and provide an empty list (0 elements).

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

        Returns:
        One or more list elements to add or replace. If you are providing the elements, make sure to specify the updateMode to use.

        If you are deleting all elements from the list, use REPLACE for the updateMode and provide an empty list (0 elements).

      • description

        public final String description()

        The new description.

        Returns:
        The new description.
      • updateMode

        public final ListUpdateMode updateMode()

        The update mode (type).

        • Use APPEND if you are adding elements to the list.

        • Use REPLACE if you replacing existing elements in the list.

        • Use REMOVE if you are removing elements from the list.

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

        Returns:
        The update mode (type).

        • Use APPEND if you are adding elements to the list.

        • Use REPLACE if you replacing existing elements in the list.

        • Use REMOVE if you are removing elements from the list.

        See Also:
        ListUpdateMode
      • updateModeAsString

        public final String updateModeAsString()

        The update mode (type).

        • Use APPEND if you are adding elements to the list.

        • Use REPLACE if you replacing existing elements in the list.

        • Use REMOVE if you are removing elements from the list.

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

        Returns:
        The update mode (type).

        • Use APPEND if you are adding elements to the list.

        • Use REPLACE if you replacing existing elements in the list.

        • Use REMOVE if you are removing elements from the list.

        See Also:
        ListUpdateMode
      • variableType

        public final String variableType()

        The variable type you want to assign to the list.

        You cannot update a variable type of a list that already has a variable type assigned to it. You can assign a variable type to a list only if the list does not already have a variable type.

        Returns:
        The variable type you want to assign to the list.

        You cannot update a variable type of a list that already has a variable type assigned to it. You can assign a variable type to a list only if the list does not already have a variable type.

      • 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