Interface ListPackagesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CodeartifactRequest.Builder, CopyableBuilder<ListPackagesRequest.Builder,ListPackagesRequest>, SdkBuilder<ListPackagesRequest.Builder,ListPackagesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListPackagesRequest
@Mutable @NotThreadSafe public static interface ListPackagesRequest.Builder extends CodeartifactRequest.Builder, SdkPojo, CopyableBuilder<ListPackagesRequest.Builder,ListPackagesRequest>

  • Method Details

    • domain

      ListPackagesRequest.Builder domain(String domain)

      The name of the domain that contains the repository that contains the requested packages.

      Parameters:
      domain - The name of the domain that contains the repository that contains the requested packages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainOwner

      ListPackagesRequest.Builder domainOwner(String domainOwner)

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

      Parameters:
      domainOwner - The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • repository

      ListPackagesRequest.Builder repository(String repository)

      The name of the repository that contains the requested packages.

      Parameters:
      repository - The name of the repository that contains the requested packages.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • format

      ListPackagesRequest.Builder format(String format)

      The format used to filter requested packages. Only packages from the provided format will be returned.

      Parameters:
      format - The format used to filter requested packages. Only packages from the provided format will be returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • format

      ListPackagesRequest.Builder format(PackageFormat format)

      The format used to filter requested packages. Only packages from the provided format will be returned.

      Parameters:
      format - The format used to filter requested packages. Only packages from the provided format will be returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • namespace

      ListPackagesRequest.Builder namespace(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 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.

      Parameters:
      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 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:
      Returns a reference to this object so that method calls can be chained together.

    • packagePrefix

      ListPackagesRequest.Builder packagePrefix(String packagePrefix)

      A prefix used to filter requested packages. Only packages with names that start with packagePrefix are returned.

      Parameters:
      packagePrefix - A prefix used to filter requested packages. Only packages with names that start with packagePrefix are returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      ListPackagesRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return per page.

      Parameters:
      maxResults - The maximum number of results to return per page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListPackagesRequest.Builder nextToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • publish

      ListPackagesRequest.Builder publish(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • publish

      ListPackagesRequest.Builder publish(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • upstream

      ListPackagesRequest.Builder upstream(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • upstream

      ListPackagesRequest.Builder upstream(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      ListPackagesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListPackagesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.