Class ParameterValue

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

An object that includes the data type of a security control parameter and its current value.

See Also:

  • Method Details

    • integer

      public final Integer integer()

      A control parameter that is an integer.

      Returns:
      A control parameter that is an integer.

    • hasIntegerList

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

    • integerList

      public final List<Integer> integerList()

      A control parameter that is a list of integers.

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

      Returns:
      A control parameter that is a list of integers.

    • doubleValue

      public final Double doubleValue()

      A control parameter that is a double.

      Returns:
      A control parameter that is a double.

    • string

      public final String string()

      A control parameter that is a string.

      Returns:
      A control parameter that is a string.

    • hasStringList

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

    • stringList

      public final List<String> stringList()

      A control parameter that is a list of strings.

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

      Returns:
      A control parameter that is a list of strings.

    • booleanValue

      public final Boolean booleanValue()

      A control parameter that is a boolean.

      Returns:
      A control parameter that is a boolean.

    • enumValue

      public final String enumValue()

      A control parameter that is an enum.

      Returns:
      A control parameter that is an enum.

    • hasEnumList

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

    • enumList

      public final List<String> enumList()

      A control parameter that is a list of enums.

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

      Returns:
      A control parameter that is a list of enums.

    • toBuilder

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

    • builder

      public static ParameterValue.Builder builder()

    • serializableBuilderClass

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

    • fromInteger

      public static ParameterValue fromInteger(Integer integer)
      Create an instance of this class with integer() initialized to the given value.

      A control parameter that is an integer.

      Parameters:
      integer - A control parameter that is an integer.

    • fromIntegerList

      public static ParameterValue fromIntegerList(List<Integer> integerList)
      Create an instance of this class with integerList() initialized to the given value.

      A control parameter that is a list of integers.

      Parameters:
      integerList - A control parameter that is a list of integers.

    • fromDoubleValue

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

      A control parameter that is a double.

      Parameters:
      doubleValue - A control parameter that is a double.

    • fromString

      public static ParameterValue fromString(String string)
      Create an instance of this class with string() initialized to the given value.

      A control parameter that is a string.

      Parameters:
      string - A control parameter that is a string.

    • fromStringList

      public static ParameterValue fromStringList(List<String> stringList)
      Create an instance of this class with stringList() initialized to the given value.

      A control parameter that is a list of strings.

      Parameters:
      stringList - A control parameter that is a list of strings.

    • fromBooleanValue

      public static ParameterValue fromBooleanValue(Boolean booleanValue)
      Create an instance of this class with booleanValue() initialized to the given value.

      A control parameter that is a boolean.

      Parameters:
      booleanValue - A control parameter that is a boolean.

    • fromEnumValue

      public static ParameterValue fromEnumValue(String enumValue)
      Create an instance of this class with enumValue() initialized to the given value.

      A control parameter that is an enum.

      Parameters:
      enumValue - A control parameter that is an enum.

    • fromEnumList

      public static ParameterValue fromEnumList(List<String> enumList)
      Create an instance of this class with enumList() initialized to the given value.

      A control parameter that is a list of enums.

      Parameters:
      enumList - A control parameter that is a list of enums.

    • type

      public ParameterValue.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 ParameterValue.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 ParameterValue.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.