software.amazon.awssdk.services.ssm.model

Class ComplianceItemEntry

java.lang.Object

software.amazon.awssdk.services.ssm.model.ComplianceItemEntry

All Implemented Interfaces:

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

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

Information about a compliance item.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ComplianceItemEntry.Builder

Method Summary

Modifier and Type	Method and Description
static ComplianceItemEntry.Builder	builder()
Map<String,String>	details() A "Key": "Value" tag combination for the compliance item.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDetails() For responses, this returns true if the service returned a value for the Details property.
int	hashCode()
String	id() The compliance item ID.
List<SdkField<?>>	sdkFields()
static Class<? extends ComplianceItemEntry.Builder>	serializableBuilderClass()
ComplianceSeverity	severity() The severity of the compliance status.
String	severityAsString() The severity of the compliance status.
ComplianceStatus	status() The status of the compliance item.
String	statusAsString() The status of the compliance item.
String	title() The title of the compliance item.
ComplianceItemEntry.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

id

public final String id()

The compliance item ID. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article.

Returns:

The compliance item ID. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article.

title

public final String title()

The title of the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.

Returns:

The title of the compliance item. For example, if the compliance item is a Windows patch, the title could be the title of the KB article for the patch; for example: Security Update for Active Directory Federation Services.

severity

public final ComplianceSeverity severity()

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

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

Returns:

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

See Also:

ComplianceSeverity

severityAsString

public final String severityAsString()

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

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

Returns:

The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.

See Also:

ComplianceSeverity

status

public final ComplianceStatus status()

The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.

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

Returns:

The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.

See Also:

ComplianceStatus

statusAsString

public final String statusAsString()

The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.

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

Returns:

The status of the compliance item. An item is either COMPLIANT or NON_COMPLIANT.

See Also:

ComplianceStatus

hasDetails

public final boolean hasDetails()

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

details

public final Map<String,String> details()

A "Key": "Value" tag combination for the compliance item.

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

Returns:

A "Key": "Value" tag combination for the compliance item.

toBuilder

public ComplianceItemEntry.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ComplianceItemEntry.Builder,ComplianceItemEntry>

builder

public static ComplianceItemEntry.Builder builder()

serializableBuilderClass

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