software.amazon.awssdk.services.codeartifact.model

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(value="software.amazon.awssdk:codegen")
public final class ListPackageVersionsRequest
extends CodeartifactRequest
implements ToCopyableBuilder<ListPackageVersionsRequest.Builder,ListPackageVersionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListPackageVersionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListPackageVersionsRequest.Builder	builder()
String	domain() The name of the domain that contains the repository that contains the requested package versions.
String	domainOwner() The 12-digit account number of the Amazon Web Services account that owns the domain.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
PackageFormat	format() The format of the package versions you want to list.
String	formatAsString() The format of the package versions you want to list.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults() The maximum number of results to return per page.
String	namespace() The namespace of the package that contains the requested package versions.
String	nextToken() The token for the next set of results.
PackageVersionOriginType	originType() The originType used to filter package versions.
String	originTypeAsString() The originType used to filter package versions.
String	packageValue() The name of the package for which you want to request package versions.
String	repository() The name of the repository that contains the requested package versions.
List<SdkField<?>>	sdkFields()
static Class<? extends ListPackageVersionsRequest.Builder>	serializableBuilderClass()
PackageVersionSortType	sortBy() How to sort the requested list of package versions.
String	sortByAsString() How to sort the requested list of package versions.
PackageVersionStatus	status() A string that filters the requested package versions by status.
String	statusAsString() A string that filters the requested package versions by status.
ListPackageVersionsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

PackageFormat

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:

PackageFormat

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 of a Maven package is its groupId.

• The namespace of an npm package is its scope.

• Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

• The namespace of a generic package is its 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 of a Maven package is its groupId.

• The namespace of an npm package is its scope.

• Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

• The namespace of a generic package is its 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:

PackageVersionStatus

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:

PackageVersionStatus

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:

PackageVersionSortType

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:

PackageVersionSortType

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:

PackageVersionOriginType

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:

PackageVersionOriginType

toBuilder

public ListPackageVersionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListPackageVersionsRequest.Builder,ListPackageVersionsRequest>

Specified by:

toBuilder in class CodeartifactRequest

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)

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