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:

  • Method Details

    • 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, status will return ControlStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the control.
      See Also:

    • 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, status will return ControlStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The status of the control.
      See Also:

    • 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, response will return ControlResponse.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from responseAsString().

      Returns:
      The response of the control.
      See Also:

    • 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, response will return ControlResponse.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from responseAsString().

      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 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.

    • 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 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.

    • 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()
      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 interface ToCopyableBuilder<AssessmentControl.Builder,AssessmentControl>
      Returns:
      a builder for type T

    • builder

      public static AssessmentControl.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AssessmentControl.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.