Class ListPackageVersionsRequest

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

  • Method Details

    • domain

      public final String domain()

      The name of the domain that contains the repository that contains the requested package versions.

      Returns:
      The name of the domain that contains the repository that contains the requested package versions.

    • domainOwner

      public final String domainOwner()

      The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

      Returns:
      The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

    • repository

      public final String repository()

      The name of the repository that contains the requested package versions.

      Returns:
      The name of the repository that contains the requested package versions.

    • format

      public final PackageFormat format()

      The format of the package versions you want to list.

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

      Returns:
      The format of the package versions you want to list.
      See Also:

    • formatAsString

      public final String formatAsString()

      The format of the package versions you want to list.

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

      Returns:
      The format of the package versions you want to list.
      See Also:

    • namespace

      public final String namespace()

      The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

      The namespace is required when deleting package versions of the following formats:

      • Maven

      • Swift

      • generic

      • The namespace of a Maven package version is its groupId.

      • The namespace of an npm or Swift package version is its scope.

      • The namespace of a generic package is its namespace.

      • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

      Returns:
      The namespace of the package that contains the requested package versions. The package component that specifies its namespace depends on its type. For example:

      The namespace is required when deleting package versions of the following formats:

      • Maven

      • Swift

      • generic

      • The namespace of a Maven package version is its groupId.

      • The namespace of an npm or Swift package version is its scope.

      • The namespace of a generic package is its namespace.

      • Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of those formats do not have a namespace.

    • packageValue

      public final String packageValue()

      The name of the package for which you want to request package versions.

      Returns:
      The name of the package for which you want to request package versions.

    • status

      public final PackageVersionStatus status()

      A string that filters the requested package versions by status.

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

      Returns:
      A string that filters the requested package versions by status.
      See Also:

    • statusAsString

      public final String statusAsString()

      A string that filters the requested package versions by status.

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

      Returns:
      A string that filters the requested package versions by status.
      See Also:

    • sortBy

      public final PackageVersionSortType sortBy()

      How to sort the requested list of package versions.

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

      Returns:
      How to sort the requested list of package versions.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      How to sort the requested list of package versions.

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

      Returns:
      How to sort the requested list of package versions.
      See Also:

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return per page.

      Returns:
      The maximum number of results to return per page.

    • nextToken

      public final String nextToken()

      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

      Returns:
      The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

    • originType

      public final PackageVersionOriginType originType()

      The originType used to filter package versions. Only package versions with the provided originType will be returned.

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

      Returns:
      The originType used to filter package versions. Only package versions with the provided originType will be returned.
      See Also:

    • originTypeAsString

      public final String originTypeAsString()

      The originType used to filter package versions. Only package versions with the provided originType will be returned.

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

      Returns:
      The originType used to filter package versions. Only package versions with the provided originType will be returned.
      See Also:

    • toBuilder

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

    • builder

      public static ListPackageVersionsRequest.Builder builder()

    • serializableBuilderClass

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