Class AutomationExecutionPreview

java.lang.Object
software.amazon.awssdk.services.ssm.model.AutomationExecutionPreview
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AutomationExecutionPreview.Builder,AutomationExecutionPreview>
@Generated("software.amazon.awssdk:codegen") public final class AutomationExecutionPreview extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AutomationExecutionPreview.Builder,AutomationExecutionPreview>

Information about the results of the execution preview.

See Also:

  • Method Details

    • stepPreviews

      public final Map<ImpactType,Integer> stepPreviews()

      Information about the type of impact a runbook step would have on a resource.

      • Mutating: The runbook step would make changes to the targets through actions that create, modify, or delete resources.

      • Non_Mutating: The runbook step would retrieve data about resources but not make changes to them. This category generally includes Describe*, List*, Get*, and similar read-only API actions.

      • Undetermined: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.

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

      Returns:
      Information about the type of impact a runbook step would have on a resource.

      • Mutating: The runbook step would make changes to the targets through actions that create, modify, or delete resources.

      • Non_Mutating: The runbook step would retrieve data about resources but not make changes to them. This category generally includes Describe*, List*, Get*, and similar read-only API actions.

      • Undetermined: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.

    • hasStepPreviews

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

    • stepPreviewsAsStrings

      public final Map<String,Integer> stepPreviewsAsStrings()

      Information about the type of impact a runbook step would have on a resource.

      • Mutating: The runbook step would make changes to the targets through actions that create, modify, or delete resources.

      • Non_Mutating: The runbook step would retrieve data about resources but not make changes to them. This category generally includes Describe*, List*, Get*, and similar read-only API actions.

      • Undetermined: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.

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

      Returns:
      Information about the type of impact a runbook step would have on a resource.

      • Mutating: The runbook step would make changes to the targets through actions that create, modify, or delete resources.

      • Non_Mutating: The runbook step would retrieve data about resources but not make changes to them. This category generally includes Describe*, List*, Get*, and similar read-only API actions.

      • Undetermined: An undetermined step invokes executions performed by another orchestration service like Lambda, Step Functions, or Amazon Web Services Systems Manager Run Command. An undetermined step might also call a third-party API. Systems Manager Automation doesn't know the outcome of the orchestration processes or third-party API executions, so the results of the steps are undetermined.

    • hasRegions

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

    • regions

      public final List<String> regions()

      Information about the Amazon Web Services Regions targeted by the execution preview.

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

      Returns:
      Information about the Amazon Web Services Regions targeted by the execution preview.

    • hasTargetPreviews

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

    • targetPreviews

      public final List<TargetPreview> targetPreviews()

      Information that provides a preview of what the impact of running the specified Automation runbook would be.

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

      Returns:
      Information that provides a preview of what the impact of running the specified Automation runbook would be.

    • totalAccounts

      public final Integer totalAccounts()

      Information about the Amazon Web Services accounts that were included in the execution preview.

      Returns:
      Information about the Amazon Web Services accounts that were included in the execution preview.

    • toBuilder

      public AutomationExecutionPreview.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<AutomationExecutionPreview.Builder,AutomationExecutionPreview>
      Returns:
      a builder for type T

    • builder

      public static AutomationExecutionPreview.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AutomationExecutionPreview.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.