Package software.amazon.awssdk.services.cloudformation.model

Class TestTypeRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudformation.model.CloudFormationRequest
software.amazon.awssdk.services.cloudformation.model.TestTypeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<TestTypeRequest.Builder,TestTypeRequest>
@Generated("software.amazon.awssdk:codegen") public final class TestTypeRequest extends CloudFormationRequest implements ToCopyableBuilder<TestTypeRequest.Builder,TestTypeRequest>

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the extension.

      Conditional: You must specify Arn, or TypeName and Type.

      Returns:
      The Amazon Resource Name (ARN) of the extension.

      Conditional: You must specify Arn, or TypeName and Type.

    • type

      public final ThirdPartyType type()

      The type of the extension to test.

      Conditional: You must specify Arn, or TypeName and Type.

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

      Returns:
      The type of the extension to test.

      Conditional: You must specify Arn, or TypeName and Type.

      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the extension to test.

      Conditional: You must specify Arn, or TypeName and Type.

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

      Returns:
      The type of the extension to test.

      Conditional: You must specify Arn, or TypeName and Type.

      See Also:

    • typeName

      public final String typeName()

      The name of the extension to test.

      Conditional: You must specify Arn, or TypeName and Type.

      Returns:
      The name of the extension to test.

      Conditional: You must specify Arn, or TypeName and Type.

    • versionId

      public final String versionId()

      The version of the extension to test.

      You can specify the version id with either Arn, or with TypeName and Type.

      If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region for testing.

      Returns:
      The version of the extension to test.

      You can specify the version id with either Arn, or with TypeName and Type.

      If you don't specify a version, CloudFormation uses the default version of the extension in this account and Region for testing.

    • logDeliveryBucket

      public final String logDeliveryBucket()

      The S3 bucket to which CloudFormation delivers the contract test execution logs.

      CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED.

      The user calling TestType must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:

      • GetObject

      • PutObject

      For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.

      Returns:
      The S3 bucket to which CloudFormation delivers the contract test execution logs.

      CloudFormation delivers the logs by the time contract testing has completed and the extension has been assigned a test type status of PASSED or FAILED.

      The user calling TestType must be able to access items in the specified S3 bucket. Specifically, the user needs the following permissions:

      • GetObject

      • PutObject

      For more information, see Actions, Resources, and Condition Keys for Amazon S3 in the Amazon Web Services Identity and Access Management User Guide.

    • toBuilder

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

    • builder

      public static TestTypeRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.