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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceParameterValue.Builderstatic classParameterValue.Type
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description BooleanbooleanValue()A control parameter that is a boolean.static ParameterValue.Builderbuilder()DoubledoubleValue()A control parameter that is a double.List<String>enumList()A control parameter that is a list of enums.StringenumValue()A control parameter that is an enum.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)static ParameterValuefromBooleanValue(Boolean booleanValue)Create an instance of this class withbooleanValue()initialized to the given value.static ParameterValuefromDoubleValue(Double doubleValue)Create an instance of this class withdoubleValue()initialized to the given value.static ParameterValuefromEnumList(List<String> enumList)Create an instance of this class withenumList()initialized to the given value.static ParameterValuefromEnumValue(String enumValue)Create an instance of this class withenumValue()initialized to the given value.static ParameterValuefromInteger(Integer integer)Create an instance of this class withinteger()initialized to the given value.static ParameterValuefromIntegerList(List<Integer> integerList)Create an instance of this class withintegerList()initialized to the given value.static ParameterValuefromString(String string)Create an instance of this class withstring()initialized to the given value.static ParameterValuefromStringList(List<String> stringList)Create an instance of this class withstringList()initialized to the given value.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasEnumList()For responses, this returns true if the service returned a value for the EnumList property.inthashCode()booleanhasIntegerList()For responses, this returns true if the service returned a value for the IntegerList property.booleanhasStringList()For responses, this returns true if the service returned a value for the StringList property.Integerinteger()A control parameter that is an integer.List<Integer>integerList()A control parameter that is a list of integers.List<SdkField<?>>sdkFields()static Class<? extends ParameterValue.Builder>serializableBuilderClass()Stringstring()A control parameter that is a string.List<String>stringList()A control parameter that is a list of strings.ParameterValue.BuildertoBuilder()StringtoString()Returns a string representation of this object.ParameterValue.Typetype()Retrieve an enum value representing which member of this object is populated.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
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 theisEmpty()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 theisEmpty()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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ParameterValue.Builder,ParameterValue>
-
builder
public static ParameterValue.Builder builder()
-
serializableBuilderClass
public static Class<? extends ParameterValue.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
fromInteger
public static ParameterValue fromInteger(Integer integer)
Create an instance of this class withinteger()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 withintegerList()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 withdoubleValue()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 withstring()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 withstringList()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 withbooleanValue()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 withenumValue()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 withenumList()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 beParameterValue.Type.UNKNOWN_TO_SDK_VERSIONif 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 beParameterValue.Type.UNKNOWN_TO_SDK_VERSIONif zero members are set, andnullif more than one member is set.
-
-