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

Class DescribeTypeRequest

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.DescribeTypeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeTypeRequest.Builder,DescribeTypeRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeTypeRequest extends CloudFormationRequest implements ToCopyableBuilder<DescribeTypeRequest.Builder,DescribeTypeRequest>

  • Method Details

    • type

      public final RegistryType type()

      The kind of extension.

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

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

      Returns:
      The kind of extension.

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

      See Also:

    • typeAsString

      public final String typeAsString()

      The kind of extension.

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

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

      Returns:
      The kind of extension.

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

      See Also:

    • typeName

      public final String typeName()

      The name of the extension.

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

      Returns:
      The name of the extension.

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

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the extension.

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

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

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

    • versionId

      public final String versionId()

      The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

      If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

      Returns:
      The ID of a specific version of the extension. The version ID is the value at the end of the Amazon Resource Name (ARN) assigned to the extension version when it is registered.

      If you specify a VersionId, DescribeType returns information about that specific extension version. Otherwise, it returns information about the default extension version.

    • publisherId

      public final String publisherId()

      The publisher ID of the extension publisher.

      Extensions provided by Amazon Web Services are not assigned a publisher ID.

      Returns:
      The publisher ID of the extension publisher.

      Extensions provided by Amazon Web Services are not assigned a publisher ID.

    • publicVersionNumber

      public final String publicVersionNumber()

      The version number of a public third-party extension.

      Returns:
      The version number of a public third-party extension.

    • toBuilder

      public DescribeTypeRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeTypeRequest.Builder,DescribeTypeRequest>
      Specified by:
      toBuilder in class CloudFormationRequest

    • builder

      public static DescribeTypeRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeTypeRequest.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)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • 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)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo