Class AssessmentControl
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AssessmentControl.Builder,
AssessmentControl>
The control entity that represents a standard control or a custom control in an Audit Manager assessment.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Integer
The amount of evidence in the assessment report.static AssessmentControl.Builder
builder()
final List
<ControlComment> comments()
The list of comments that's attached to the control.final String
The description of the control.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
The amount of evidence that's collected for the control.The list of data sources for the evidence.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Comments property.final boolean
For responses, this returns true if the service returned a value for the EvidenceSources property.final int
hashCode()
final String
id()
The identifier for the control.final String
name()
The name of the control.final ControlResponse
response()
The response of the control.final String
The response of the control.static Class
<? extends AssessmentControl.Builder> final ControlStatus
status()
The status of the control.final String
The status of the control.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The identifier for the control.
- Returns:
- The identifier for the control.
-
name
The name of the control.
- Returns:
- The name of the control.
-
description
The description of the control.
- Returns:
- The description of the control.
-
status
The status of the control.
If the service returns an enum value that is not available in the current SDK version,
status
will returnControlStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the control.
- See Also:
-
statusAsString
The status of the control.
If the service returns an enum value that is not available in the current SDK version,
status
will returnControlStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the control.
- See Also:
-
response
The response of the control.
If the service returns an enum value that is not available in the current SDK version,
response
will returnControlResponse.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresponseAsString()
.- Returns:
- The response of the control.
- See Also:
-
responseAsString
The response of the control.
If the service returns an enum value that is not available in the current SDK version,
response
will returnControlResponse.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromresponseAsString()
.- Returns:
- The response of the control.
- See Also:
-
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
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
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
The amount of evidence that's collected for the control.
- Returns:
- The amount of evidence that's collected for the control.
-
assessmentReportEvidenceCount
The amount of evidence in the assessment report.
- Returns:
- The amount of evidence in the assessment report.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<AssessmentControl.Builder,
AssessmentControl> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-