Package software.amazon.awssdk.services.securityhub.model

Class ParameterConfiguration

java.lang.Object

software.amazon.awssdk.services.securityhub.model.ParameterConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ParameterConfiguration.Builder,ParameterConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class ParameterConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ParameterConfiguration.Builder,ParameterConfiguration>

An object that provides the current value of a security control parameter and identifies whether it has been customized.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ParameterConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static ParameterConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends ParameterConfiguration.Builder>	serializableBuilderClass()
ParameterConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ParameterValue	value()	The current value of a control parameter.
ParameterValueType	valueType()	Identifies whether a control parameter uses a custom user-defined value or subscribes to the default Security Hub behavior.
String	valueTypeAsString()	Identifies whether a control parameter uses a custom user-defined value or subscribes to the default Security Hub behavior.

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

valueType

public final ParameterValueType valueType()

Identifies whether a control parameter uses a custom user-defined value or subscribes to the default Security Hub behavior.

When ValueType is set equal to DEFAULT, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. When ValueType is set equal to DEFAULT, Security Hub ignores user-provided input for the Value field.

When ValueType is set equal to CUSTOM, the Value field can't be empty.

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

Returns:

Identifies whether a control parameter uses a custom user-defined value or subscribes to the default Security Hub behavior.

When ValueType is set equal to DEFAULT, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. When ValueType is set equal to DEFAULT, Security Hub ignores user-provided input for the Value field.

When ValueType is set equal to CUSTOM, the Value field can't be empty.

See Also:

ParameterValueType

valueTypeAsString

public final String valueTypeAsString()

Identifies whether a control parameter uses a custom user-defined value or subscribes to the default Security Hub behavior.

When ValueType is set equal to DEFAULT, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. When ValueType is set equal to DEFAULT, Security Hub ignores user-provided input for the Value field.

When ValueType is set equal to CUSTOM, the Value field can't be empty.

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

Returns:

Identifies whether a control parameter uses a custom user-defined value or subscribes to the default Security Hub behavior.

When ValueType is set equal to DEFAULT, the default behavior can be a specific Security Hub default value, or the default behavior can be to ignore a specific parameter. When ValueType is set equal to DEFAULT, Security Hub ignores user-provided input for the Value field.

When ValueType is set equal to CUSTOM, the Value field can't be empty.

See Also:

ParameterValueType

value

public final ParameterValue value()

The current value of a control parameter.

Returns:

The current value of a control parameter.

toBuilder

public ParameterConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ParameterConfiguration.Builder,ParameterConfiguration>

builder

public static ParameterConfiguration.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo