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

Class ListTypeVersionsRequest

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

  • Method Details

    • type

      public final RegistryType type()

      The kind of the 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 the extension.

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

      See Also:

    • typeAsString

      public final String typeAsString()

      The kind of the 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 the extension.

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

      See Also:

    • typeName

      public final String typeName()

      The name of the extension for which you want version summary information.

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

      Returns:
      The name of the extension for which you want version summary information.

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

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the extension for which you want version summary information.

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

      Returns:
      The Amazon Resource Name (ARN) of the extension for which you want version summary information.

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

    • maxResults

      public final Integer maxResults()

      The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

      Returns:
      The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

    • nextToken

      public final String nextToken()

      If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

      Returns:
      If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

    • deprecatedStatus

      public final DeprecatedStatus deprecatedStatus()

      The deprecation status of the extension versions that you want to get summary information about.

      Valid values include:

      • LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

      • DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.

      The default is LIVE.

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

      Returns:
      The deprecation status of the extension versions that you want to get summary information about.

      Valid values include:

      • LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

      • DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.

      The default is LIVE.

      See Also:

    • deprecatedStatusAsString

      public final String deprecatedStatusAsString()

      The deprecation status of the extension versions that you want to get summary information about.

      Valid values include:

      • LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

      • DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.

      The default is LIVE.

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

      Returns:
      The deprecation status of the extension versions that you want to get summary information about.

      Valid values include:

      • LIVE: The extension version is registered and can be used in CloudFormation operations, dependent on its provisioning behavior and visibility scope.

      • DEPRECATED: The extension version has been deregistered and can no longer be used in CloudFormation operations.

      The default is LIVE.

      See Also:

    • publisherId

      public final String publisherId()

      The publisher ID of the extension publisher.

      Extensions published by Amazon aren't assigned a publisher ID.

      Returns:
      The publisher ID of the extension publisher.

      Extensions published by Amazon aren't assigned a publisher ID.

    • toBuilder

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

    • builder

      public static ListTypeVersionsRequest.Builder builder()

    • serializableBuilderClass

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