Class ListPackagesRequest

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>

  • Method Details

    • 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:

    • 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:

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

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

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

    • 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)
      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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.