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

Class StandardsSubscription

java.lang.Object

software.amazon.awssdk.services.securityhub.model.StandardsSubscription

All Implemented Interfaces:

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

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

A resource that represents your subscription to a supported standard.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StandardsSubscription.Builder

Method Summary

Modifier and Type	Method	Description
static StandardsSubscription.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStandardsInput()	For responses, this returns true if the service returned a value for the StandardsInput property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends StandardsSubscription.Builder>	serializableBuilderClass()
String	standardsArn()	The ARN of a standard.
Map<String,String>	standardsInput()	A key-value pair of input for the standard.
StandardsStatus	standardsStatus()	The status of the standard subscription.
String	standardsStatusAsString()	The status of the standard subscription.
StandardsStatusReason	standardsStatusReason()	The reason for the current status.
String	standardsSubscriptionArn()	The ARN of a resource that represents your subscription to a supported standard.
StandardsSubscription.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

standardsSubscriptionArn

public final String standardsSubscriptionArn()

The ARN of a resource that represents your subscription to a supported standard.

Returns:

The ARN of a resource that represents your subscription to a supported standard.

standardsArn

public final String standardsArn()

The ARN of a standard.

Returns:

The ARN of a standard.

hasStandardsInput

public final boolean hasStandardsInput()

For responses, this returns true if the service returned a value for the StandardsInput 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.

standardsInput

public final Map<String,String> standardsInput()

A key-value pair of input for the standard.

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

Returns:

A key-value pair of input for the standard.

standardsStatus

public final StandardsStatus standardsStatus()

The status of the standard subscription.

The status values are as follows:

• PENDING - Standard is in the process of being enabled.

• READY - Standard is enabled.

• INCOMPLETE - Standard could not be enabled completely. Some controls may not be available.

• DELETING - Standard is in the process of being disabled.

• FAILED - Standard could not be disabled.

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

Returns:

The status of the standard subscription.

The status values are as follows:

• PENDING - Standard is in the process of being enabled.

• READY - Standard is enabled.

• INCOMPLETE - Standard could not be enabled completely. Some controls may not be available.

• DELETING - Standard is in the process of being disabled.

• FAILED - Standard could not be disabled.

See Also:

StandardsStatus

standardsStatusAsString

public final String standardsStatusAsString()

The status of the standard subscription.

The status values are as follows:

• PENDING - Standard is in the process of being enabled.

• READY - Standard is enabled.

• INCOMPLETE - Standard could not be enabled completely. Some controls may not be available.

• DELETING - Standard is in the process of being disabled.

• FAILED - Standard could not be disabled.

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

Returns:

The status of the standard subscription.

The status values are as follows:

• PENDING - Standard is in the process of being enabled.

• READY - Standard is enabled.

• INCOMPLETE - Standard could not be enabled completely. Some controls may not be available.

• DELETING - Standard is in the process of being disabled.

• FAILED - Standard could not be disabled.

See Also:

StandardsStatus

standardsStatusReason

public final StandardsStatusReason standardsStatusReason()

The reason for the current status.

Returns:

The reason for the current status.

toBuilder

public StandardsSubscription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StandardsSubscription.Builder,StandardsSubscription>

builder

public static StandardsSubscription.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo