com.amazonaws.services.codeartifact.model

Class ListPackagesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.codeartifact.model.ListPackagesRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListPackagesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListPackagesRequest()

Method Summary

Modifier and Type	Method and Description
ListPackagesRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getDomain() The name of the domain that contains the repository that contains the requested packages.
String	getDomainOwner() The 12-digit account number of the Amazon Web Services account that owns the domain.
String	getFormat() The format used to filter requested packages.
Integer	getMaxResults() The maximum number of results to return per page.
String	getNamespace() The namespace prefix used to filter requested packages.
String	getNextToken() The token for the next set of results.
String	getPackagePrefix() A prefix used to filter requested packages.
String	getPublish() The value of the Publish package origin control restriction used to filter requested packages.
String	getRepository() The name of the repository that contains the requested packages.
String	getUpstream() The value of the Upstream package origin control restriction used to filter requested packages.
int	hashCode()
void	setDomain(String domain) The name of the domain that contains the repository that contains the requested packages.
void	setDomainOwner(String domainOwner) The 12-digit account number of the Amazon Web Services account that owns the domain.
void	setFormat(String format) The format used to filter requested packages.
void	setMaxResults(Integer maxResults) The maximum number of results to return per page.
void	setNamespace(String namespace) The namespace prefix used to filter requested packages.
void	setNextToken(String nextToken) The token for the next set of results.
void	setPackagePrefix(String packagePrefix) A prefix used to filter requested packages.
void	setPublish(String publish) The value of the Publish package origin control restriction used to filter requested packages.
void	setRepository(String repository) The name of the repository that contains the requested packages.
void	setUpstream(String upstream) The value of the Upstream package origin control restriction used to filter requested packages.
String	toString() Returns a string representation of this object.
ListPackagesRequest	withDomain(String domain) The name of the domain that contains the repository that contains the requested packages.
ListPackagesRequest	withDomainOwner(String domainOwner) The 12-digit account number of the Amazon Web Services account that owns the domain.
ListPackagesRequest	withFormat(PackageFormat format) The format used to filter requested packages.
ListPackagesRequest	withFormat(String format) The format used to filter requested packages.
ListPackagesRequest	withMaxResults(Integer maxResults) The maximum number of results to return per page.
ListPackagesRequest	withNamespace(String namespace) The namespace prefix used to filter requested packages.
ListPackagesRequest	withNextToken(String nextToken) The token for the next set of results.
ListPackagesRequest	withPackagePrefix(String packagePrefix) A prefix used to filter requested packages.
ListPackagesRequest	withPublish(AllowPublish publish) The value of the Publish package origin control restriction used to filter requested packages.
ListPackagesRequest	withPublish(String publish) The value of the Publish package origin control restriction used to filter requested packages.
ListPackagesRequest	withRepository(String repository) The name of the repository that contains the requested packages.
ListPackagesRequest	withUpstream(AllowUpstream upstream) The value of the Upstream package origin control restriction used to filter requested packages.
ListPackagesRequest	withUpstream(String upstream) The value of the Upstream package origin control restriction used to filter requested packages.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListPackagesRequest

public ListPackagesRequest()

Method Detail

setDomain

public void setDomain(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.

getDomain

public String getDomain()

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.

withDomain

public ListPackagesRequest withDomain(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.

setDomainOwner

public void setDomainOwner(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.

getDomainOwner

public String getDomainOwner()

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.

withDomainOwner

public ListPackagesRequest withDomainOwner(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.

setRepository

public void setRepository(String repository)

The name of the repository that contains the requested packages.

Parameters:

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

getRepository

public String getRepository()

The name of the repository that contains the requested packages.

Returns:

The name of the repository that contains the requested packages.

withRepository

public ListPackagesRequest withRepository(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.

setFormat

public void setFormat(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.

See Also:

PackageFormat

getFormat

public String getFormat()

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

Returns:

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

See Also:

PackageFormat

withFormat

public ListPackagesRequest withFormat(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:

PackageFormat

withFormat

public ListPackagesRequest withFormat(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:

PackageFormat

setNamespace

public void setNamespace(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.

getNamespace

public String getNamespace()

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.

withNamespace

public ListPackagesRequest withNamespace(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.

setPackagePrefix

public void setPackagePrefix(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.

getPackagePrefix

public String getPackagePrefix()

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.

withPackagePrefix

public ListPackagesRequest withPackagePrefix(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.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return per page.

Parameters:

maxResults - The maximum number of results to return per page.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return per page.

Returns:

The maximum number of results to return per page.

withMaxResults

public ListPackagesRequest withMaxResults(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.

setNextToken

public void setNextToken(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.

getNextToken

public String getNextToken()

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.

withNextToken

public ListPackagesRequest withNextToken(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.

setPublish

public void setPublish(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.

See Also:

AllowPublish

getPublish

public String getPublish()

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:

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

withPublish

public ListPackagesRequest withPublish(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:

AllowPublish

withPublish

public ListPackagesRequest withPublish(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:

AllowPublish

setUpstream

public void setUpstream(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.

See Also:

AllowUpstream

getUpstream

public String getUpstream()

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:

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

withUpstream

public ListPackagesRequest withUpstream(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:

AllowUpstream

withUpstream

public ListPackagesRequest withUpstream(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:

AllowUpstream

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListPackagesRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()