Class TestRun

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

Represents a single run of a test. Configuration is snapshotted from the test and service at the time the run is started.

See Also:

  • Method Details

    • testRunId

      public final String testRunId()

      The unique identifier of the test run.

      Returns:
      The unique identifier of the test run.

    • testId

      public final String testId()

      The identifier of the test that was run.

      Returns:
      The identifier of the test that was run.

    • status

      public final TestRunStatus status()

      The current status of the test run.

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

      Returns:
      The current status of the test run.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the test run.

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

      Returns:
      The current status of the test run.
      See Also:

    • serviceArn

      public final String serviceArn()

      The ARN of the service the test run belongs to.

      Returns:
      The ARN of the service the test run belongs to.

    • startedAt

      public final Instant startedAt()

      The timestamp when the test run started.

      Returns:
      The timestamp when the test run started.

    • endedAt

      public final Instant endedAt()

      The timestamp when the test run ended.

      Returns:
      The timestamp when the test run ended.

    • hasExperiments

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

    • experiments

      public final List<ExperimentDetails> experiments()

      The AWS Fault Injection Service (AWS FIS) experiments run as part of the test run.

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

      Returns:
      The AWS Fault Injection Service (AWS FIS) experiments run as part of the test run.

    • eventCount

      public final Integer eventCount()

      The number of events recorded for the test run. Use ListTestRunEvents to retrieve the details.

      Returns:
      The number of events recorded for the test run. Use ListTestRunEvents to retrieve the details.

    • hasParameters

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

    • parameters

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

      The parameter values used for the test run.

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

      Returns:
      The parameter values used for the test run.

    • errorMessage

      public final String errorMessage()

      A human-readable reason for test run failure. Only present when the status is FAILED or ERROR.

      Returns:
      A human-readable reason for test run failure. Only present when the status is FAILED or ERROR.

    • hasStopConditions

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

    • stopConditions

      public final List<StopCondition> stopConditions()

      The stop conditions snapshotted from the test when the run was started.

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

      Returns:
      The stop conditions snapshotted from the test when the run was started.

    • loggingConfiguration

      public final LoggingConfiguration loggingConfiguration()

      The logging configuration snapshotted from the test when the run was started.

      Returns:
      The logging configuration snapshotted from the test when the run was started.

    • roleName

      public final String roleName()

      The IAM execution role name snapshotted from the test when the run was started.

      Returns:
      The IAM execution role name snapshotted from the test when the run was started.

    • testTemplateArn

      public final String testTemplateArn()

      The ARN of the test template snapshotted from the test when the run was started.

      Returns:
      The ARN of the test template snapshotted from the test when the run was started.

    • reportConfiguration

      public final TestRunReportConfiguration reportConfiguration()

      The report configuration snapshotted from the service when the run was started.

      Returns:
      The report configuration snapshotted from the service when the run was started.

    • policy

      public final TestRunPolicySnapshot policy()

      The resilience policy snapshotted from the service when the run was started.

      Returns:
      The resilience policy snapshotted from the service when the run was started.

    • reportOutput

      public final ReportGenerationResult reportOutput()

      The report generation result for the test run. Present after report generation completes or fails.

      Returns:
      The report generation result for the test run. Present after report generation completes or fails.

    • regionSwitchPlanArn

      public final String regionSwitchPlanArn()

      The ARN of the ARC Region switch plan associated with the test run.

      Returns:
      The ARN of the ARC Region switch plan associated with the test run.

    • regionSwitchExecutionId

      public final String regionSwitchExecutionId()

      The identifier of the ARC Region switch execution detected during the test run.

      Returns:
      The identifier of the ARC Region switch execution detected during the test run.

    • permissionModel

      public final PermissionModel permissionModel()

      The permission model snapshotted from the service when the run was started.

      Returns:
      The permission model snapshotted from the service when the run was started.

    • 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()

      The Regions snapshotted from the service when the run was started.

      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:
      The Regions snapshotted from the service when the run was started.

    • accountTargeting

      public final AccountTargeting accountTargeting()

      Indicates whether this test run targets a single account or multiple accounts.

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

      Returns:
      Indicates whether this test run targets a single account or multiple accounts.
      See Also:

    • accountTargetingAsString

      public final String accountTargetingAsString()

      Indicates whether this test run targets a single account or multiple accounts.

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

      Returns:
      Indicates whether this test run targets a single account or multiple accounts.
      See Also:

    • toBuilder

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

    • builder

      public static TestRun.Builder builder()

    • serializableBuilderClass

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