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.ListPackagesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListPackagesRequest.Builder,ListPackagesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListPackagesRequest
extends CodeartifactRequest
implements ToCopyableBuilder<ListPackagesRequest.Builder,ListPackagesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListPackagesRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static ListPackagesRequest.Builder`	`builder()`
`String`	`domain()`	The name of the domain that contains the repository that contains the requested packages.
`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 used to filter requested packages.
`String`	`formatAsString()`	The format used to filter requested packages.
`<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 prefix used to filter requested packages.
`String`	`nextToken()`	The token for the next set of results.
`String`	`packagePrefix()`	A prefix used to filter requested packages.
`AllowPublish`	`publish()`	The value of the `Publish` package origin control restriction used to filter requested packages.
`String`	`publishAsString()`	The value of the `Publish` package origin control restriction used to filter requested packages.
`String`	`repository()`	The name of the repository that contains the requested packages.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListPackagesRequest.Builder>`	`serializableBuilderClass()`
`ListPackagesRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`AllowUpstream`	`upstream()`	The value of the `Upstream` package origin control restriction used to filter requested packages.
`String`	`upstreamAsString()`	The value of the `Upstream` package origin control restriction used to filter requested packages.

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 packages.
    
    Returns:
    
    The name of the domain that contains the repository that contains the requested packages.
  - 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 packages.
    
    Returns:
    
    The name of the repository that contains the requested packages.
  - format
```
public final PackageFormat format()
```
    The format used to filter requested packages. Only packages from the provided format will be returned.
    
    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 used to filter requested packages. Only packages from the provided format will be returned.
    
    See Also:
    
    PackageFormat
  - formatAsString
```
public final String formatAsString()
```
    The format used to filter requested packages. Only packages from the provided format will be returned.
    
    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 used to filter requested packages. Only packages from the provided format will be returned.
    
    See Also:
    
    PackageFormat
  - namespace
```
public final String namespace()
```
    The namespace prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is called --namespace and not --namespace-prefix, it has prefix-matching behavior.
    
    Each package format uses namespace as follows:
    
    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 prefix used to filter requested packages. Only packages with a namespace that starts with the provided string value are returned. Note that although this option is called --namespace and not --namespace-prefix, it has prefix-matching behavior.
    
    Each package format uses namespace as follows:
    
    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.
  - packagePrefix
```
public final String packagePrefix()
```
    A prefix used to filter requested packages. Only packages with names that start with packagePrefix are returned.
    
    Returns:
    
    A prefix used to filter requested packages. Only packages with names that start with packagePrefix are returned.
  - 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.
  - publish
```
public final AllowPublish publish()
```
    The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
    
    If the service returns an enum value that is not available in the current SDK version, publish will return AllowPublish.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from publishAsString().
    
    Returns:
    
    The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
    
    See Also:
    
    AllowPublish
  - publishAsString
```
public final String publishAsString()
```
    The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
    
    If the service returns an enum value that is not available in the current SDK version, publish will return AllowPublish.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from publishAsString().
    
    Returns:
    
    The value of the Publish package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
    
    See Also:
    
    AllowPublish
  - upstream
```
public final AllowUpstream upstream()
```
    The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
    
    If the service returns an enum value that is not available in the current SDK version, upstream will return AllowUpstream.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from upstreamAsString().
    
    Returns:
    
    The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
    
    See Also:
    
    AllowUpstream
  - upstreamAsString
```
public final String upstreamAsString()
```
    The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
    
    If the service returns an enum value that is not available in the current SDK version, upstream will return AllowUpstream.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from upstreamAsString().
    
    Returns:
    
    The value of the Upstream package origin control restriction used to filter requested packages. Only packages with the provided restriction are returned. For more information, see PackageOriginRestrictions.
    
    See Also:
    
    AllowUpstream
  - toBuilder
```
public ListPackagesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListPackagesRequest.Builder,ListPackagesRequest>
    
    Specified by:
    
    toBuilder in class CodeartifactRequest
  - builder
```
public static ListPackagesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListPackagesRequest.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

Class ListPackagesRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

domain

domainOwner

repository

format

formatAsString

namespace

packagePrefix

maxResults

nextToken

publish

publishAsString

upstream

upstreamAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields