Package software.amazon.awssdk.services.iot.model

Class DescribeAuditMitigationActionsTaskResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iot.model.IotResponse
software.amazon.awssdk.services.iot.model.DescribeAuditMitigationActionsTaskResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeAuditMitigationActionsTaskResponse.Builder,DescribeAuditMitigationActionsTaskResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeAuditMitigationActionsTaskResponse extends IotResponse implements ToCopyableBuilder<DescribeAuditMitigationActionsTaskResponse.Builder,DescribeAuditMitigationActionsTaskResponse>

  • Method Details

    • taskStatus

      public final AuditMitigationActionsTaskStatus taskStatus()

      The current status of the task.

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

      Returns:
      The current status of the task.
      See Also:

    • taskStatusAsString

      public final String taskStatusAsString()

      The current status of the task.

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

      Returns:
      The current status of the task.
      See Also:

    • startTime

      public final Instant startTime()

      The date and time when the task was started.

      Returns:
      The date and time when the task was started.

    • endTime

      public final Instant endTime()

      The date and time when the task was completed or canceled.

      Returns:
      The date and time when the task was completed or canceled.

    • hasTaskStatistics

      public final boolean hasTaskStatistics()
      For responses, this returns true if the service returned a value for the TaskStatistics 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.

    • taskStatistics

      public final Map<String,TaskStatisticsForAuditCheck> taskStatistics()

      Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

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

      Returns:
      Aggregate counts of the results when the mitigation tasks were applied to the findings for this audit mitigation actions task.

    • target

      public final AuditMitigationActionsTaskTarget target()

      Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.

      Returns:
      Identifies the findings to which the mitigation actions are applied. This can be by audit checks, by audit task, or a set of findings.

    • hasAuditCheckToActionsMapping

      public final boolean hasAuditCheckToActionsMapping()
      For responses, this returns true if the service returned a value for the AuditCheckToActionsMapping 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.

    • auditCheckToActionsMapping

      public final Map<String,List<String>> auditCheckToActionsMapping()

      Specifies the mitigation actions that should be applied to specific audit checks.

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

      Returns:
      Specifies the mitigation actions that should be applied to specific audit checks.

    • hasActionsDefinition

      public final boolean hasActionsDefinition()
      For responses, this returns true if the service returned a value for the ActionsDefinition 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.

    • actionsDefinition

      public final List<MitigationAction> actionsDefinition()

      Specifies the mitigation actions and their parameters that are applied as part of this task.

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

      Returns:
      Specifies the mitigation actions and their parameters that are applied as part of this task.

    • toBuilder

      public DescribeAuditMitigationActionsTaskResponse.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<DescribeAuditMitigationActionsTaskResponse.Builder,DescribeAuditMitigationActionsTaskResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeAuditMitigationActionsTaskResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeAuditMitigationActionsTaskResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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