Class GetTestSuiteResponse

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

  • Method Details

    • testSuiteId

      public final String testSuiteId()

      The response ID of the test suite.

      Returns:
      The response ID of the test suite.

    • name

      public final String name()

      The name of the test suite.

      Returns:
      The name of the test suite.

    • latestVersion

      public final TestSuiteLatestVersion latestVersion()

      The latest version of the test suite.

      Returns:
      The latest version of the test suite.

    • testSuiteVersion

      public final Integer testSuiteVersion()

      The version of the test suite.

      Returns:
      The version of the test suite.

    • status

      public final TestSuiteLifecycle status()

      The status of the test suite.

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

      Returns:
      The status of the test suite.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the test suite.

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

      Returns:
      The status of the test suite.
      See Also:

    • statusReason

      public final String statusReason()

      The status reason of the test suite.

      Returns:
      The status reason of the test suite.

    • testSuiteArn

      public final String testSuiteArn()

      The test suite Amazon Resource Name (ARN).

      Returns:
      The test suite Amazon Resource Name (ARN).

    • creationTime

      public final Instant creationTime()

      The creation time of the test suite.

      Returns:
      The creation time of the test suite.

    • lastUpdateTime

      public final Instant lastUpdateTime()

      The last update time of the test suite.

      Returns:
      The last update time of the test suite.

    • description

      public final String description()

      The description of the test suite.

      Returns:
      The description of the test suite.

    • hasBeforeSteps

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

    • beforeSteps

      public final List<Step> beforeSteps()

      The before steps of the test suite.

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

      Returns:
      The before steps of the test suite.

    • hasAfterSteps

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

    • afterSteps

      public final List<Step> afterSteps()

      The after steps of the test suite.

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

      Returns:
      The after steps of the test suite.

    • testCases

      public final TestCases testCases()

      The test cases of the test suite.

      Returns:
      The test cases of the test suite.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags of the test suite.

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

      Returns:
      The tags of the test suite.

    • toBuilder

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

    • builder

      public static GetTestSuiteResponse.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

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