Class AssessmentControl
- java.lang.Object
-
- software.amazon.awssdk.services.auditmanager.model.AssessmentControl
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<AssessmentControl.Builder,AssessmentControl>
@Generated("software.amazon.awssdk:codegen") public final class AssessmentControl extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AssessmentControl.Builder,AssessmentControl>
The control entity that represents a standard control or a custom control in an Audit Manager assessment.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceAssessmentControl.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description IntegerassessmentReportEvidenceCount()The amount of evidence in the assessment report.static AssessmentControl.Builderbuilder()List<ControlComment>comments()The list of comments that's attached to the control.Stringdescription()The description of the control.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)IntegerevidenceCount()The amount of evidence that's collected for the control.List<String>evidenceSources()The list of data sources for the evidence.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasComments()For responses, this returns true if the service returned a value for the Comments property.booleanhasEvidenceSources()For responses, this returns true if the service returned a value for the EvidenceSources property.inthashCode()Stringid()The identifier for the control.Stringname()The name of the control.ControlResponseresponse()The response of the control.StringresponseAsString()The response of the control.List<SdkField<?>>sdkFields()static Class<? extends AssessmentControl.Builder>serializableBuilderClass()ControlStatusstatus()The status of the control.StringstatusAsString()The status of the control.AssessmentControl.BuildertoBuilder()StringtoString()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 identifier for the control.
- Returns:
- The identifier for the control.
-
name
public final String name()
The name of the control.
- Returns:
- The name of the control.
-
description
public final String description()
The description of the control.
- Returns:
- The description of the control.
-
status
public final ControlStatus status()
The status of the control.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnControlStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the control.
- See Also:
ControlStatus
-
statusAsString
public final String statusAsString()
The status of the control.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnControlStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the control.
- See Also:
ControlStatus
-
response
public final ControlResponse response()
The response of the control.
If the service returns an enum value that is not available in the current SDK version,
responsewill returnControlResponse.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresponseAsString().- Returns:
- The response of the control.
- See Also:
ControlResponse
-
responseAsString
public final String responseAsString()
The response of the control.
If the service returns an enum value that is not available in the current SDK version,
responsewill returnControlResponse.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromresponseAsString().- Returns:
- The response of the control.
- See Also:
ControlResponse
-
hasComments
public final boolean hasComments()
For responses, this returns true if the service returned a value for the Comments 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.
-
comments
public final List<ControlComment> comments()
The list of comments that's attached to the control.
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
hasComments()method.- Returns:
- The list of comments that's attached to the control.
-
hasEvidenceSources
public final boolean hasEvidenceSources()
For responses, this returns true if the service returned a value for the EvidenceSources 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.
-
evidenceSources
public final List<String> evidenceSources()
The list of data sources for the evidence.
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
hasEvidenceSources()method.- Returns:
- The list of data sources for the evidence.
-
evidenceCount
public final Integer evidenceCount()
The amount of evidence that's collected for the control.
- Returns:
- The amount of evidence that's collected for the control.
-
assessmentReportEvidenceCount
public final Integer assessmentReportEvidenceCount()
The amount of evidence in the assessment report.
- Returns:
- The amount of evidence in the assessment report.
-
toBuilder
public AssessmentControl.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<AssessmentControl.Builder,AssessmentControl>
-
builder
public static AssessmentControl.Builder builder()
-
serializableBuilderClass
public static Class<? extends AssessmentControl.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.
-
-