Class ComplianceItem
- java.lang.Object
-
- software.amazon.awssdk.services.ssm.model.ComplianceItem
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ComplianceItem.Builder,ComplianceItem>
@Generated("software.amazon.awssdk:codegen") public final class ComplianceItem extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ComplianceItem.Builder,ComplianceItem>
Information about the compliance as defined by the resource type. For example, for a patch resource type,
Items
includes information about the PatchSeverity, Classification, and so on.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ComplianceItem.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ComplianceItem.Builder
builder()
String
complianceType()
The compliance type.Map<String,String>
details()
A "Key": "Value" tag combination for the compliance item.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
ComplianceExecutionSummary
executionSummary()
A summary for the compliance item.<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()
An ID for the compliance item.String
resourceId()
An ID for the resource.String
resourceType()
The type of resource.List<SdkField<?>>
sdkFields()
static Class<? extends ComplianceItem.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()
A title for the compliance item.ComplianceItem.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
-
complianceType
public final String complianceType()
The compliance type. For example, Association (for a State Manager association), Patch, or Custom:
string
are all valid compliance types.- Returns:
- The compliance type. For example, Association (for a State Manager association), Patch, or Custom:
string
are all valid compliance types.
-
resourceType
public final String resourceType()
The type of resource.
ManagedInstance
is currently the only supported resource type.- Returns:
- The type of resource.
ManagedInstance
is currently the only supported resource type.
-
resourceId
public final String resourceId()
An ID for the resource. For a managed node, this is the node ID.
- Returns:
- An ID for the resource. For a managed node, this is the node ID.
-
id
public final String id()
An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.
- Returns:
- An ID for the compliance item. For example, if the compliance item is a Windows patch, the ID could be the number of the KB article; for example: KB4010320.
-
title
public final String title()
A title for 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:
- A title for 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.
-
status
public final ComplianceStatus status()
The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).
If the service returns an enum value that is not available in the current SDK version,
status
will returnComplianceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).
- See Also:
ComplianceStatus
-
statusAsString
public final String statusAsString()
The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).
If the service returns an enum value that is not available in the current SDK version,
status
will returnComplianceStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the compliance item. An item is either COMPLIANT, NON_COMPLIANT, or an empty string (for Windows patches that aren't applicable).
- See Also:
ComplianceStatus
-
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 returnComplianceSeverity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromseverityAsString()
.- 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 returnComplianceSeverity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromseverityAsString()
.- Returns:
- The severity of the compliance status. Severity can be one of the following: Critical, High, Medium, Low, Informational, Unspecified.
- See Also:
ComplianceSeverity
-
executionSummary
public final ComplianceExecutionSummary executionSummary()
A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.
- Returns:
- A summary for the compliance item. The summary includes an execution ID, the execution type (for example, command), and the execution time.
-
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 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.
-
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 ComplianceItem.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ComplianceItem.Builder,ComplianceItem>
-
builder
public static ComplianceItem.Builder builder()
-
serializableBuilderClass
public static Class<? extends ComplianceItem.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in 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.
-
-