Class UpdateListRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateListRequest.Builder,UpdateListRequest>

@Generated("software.amazon.awssdk:codegen") public final class UpdateListRequest extends FraudDetectorRequest implements ToCopyableBuilder<UpdateListRequest.Builder,UpdateListRequest>
  • Method Details

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

    • toBuilder

      public UpdateListRequest.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<UpdateListRequest.Builder,UpdateListRequest>
      Specified by:
      toBuilder in class FraudDetectorRequest
      Returns:
      a builder for type T
    • builder

      public static UpdateListRequest.Builder builder()
    • serializableBuilderClass

      public static Class<? extends UpdateListRequest.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest
    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value
    • 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.