com.amazonaws.services.codeartifact.model.ListPackagesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-codeartifact Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.codeartifact.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListPackagesRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the domain that contains the repository that contains the requested packages.
*
*/
private String domain;
/**
*
* The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes
* or spaces.
*
*/
private String domainOwner;
/**
*
* The name of the repository that contains the requested packages.
*
*/
private String repository;
/**
*
* The format used to filter requested packages. Only packages from the provided format will be returned.
*
*/
private String format;
/**
*
* 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.
*
*
*
*/
private String namespace;
/**
*
* A prefix used to filter requested packages. Only packages with names that start with packagePrefix
* are returned.
*
*/
private String packagePrefix;
/**
*
* The maximum number of results to return per page.
*
*/
private Integer maxResults;
/**
*
* 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.
*
*/
private String nextToken;
/**
*
* 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.
*
*/
private String publish;
/**
*
* 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.
*
*/
private String upstream;
/**
*
* The name of the domain that contains the repository that contains the requested packages.
*
*
* @param domain
* The name of the domain that contains the repository that contains the requested packages.
*/
public void setDomain(String domain) {
this.domain = domain;
}
/**
*
* The name of the domain that contains the repository that contains the requested packages.
*
*
* @return The name of the domain that contains the repository that contains the requested packages.
*/
public String getDomain() {
return this.domain;
}
/**
*
* The name of the domain that contains the repository that contains the requested packages.
*
*
* @param domain
* The name of the domain that contains the repository that contains the requested packages.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListPackagesRequest withDomain(String domain) {
setDomain(domain);
return this;
}
/**
*
* The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes
* or spaces.
*
*
* @param domainOwner
* The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include
* dashes or spaces.
*/
public void setDomainOwner(String domainOwner) {
this.domainOwner = domainOwner;
}
/**
*
* The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes
* or spaces.
*
*
* @return The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include
* dashes or spaces.
*/
public String getDomainOwner() {
return this.domainOwner;
}
/**
*
* The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes
* or spaces.
*
*
* @param domainOwner
* The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include
* dashes or spaces.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListPackagesRequest withDomainOwner(String domainOwner) {
setDomainOwner(domainOwner);
return this;
}
/**
*
* The name of the repository that contains the requested packages.
*
*
* @param repository
* The name of the repository that contains the requested packages.
*/
public void setRepository(String repository) {
this.repository = repository;
}
/**
*
* The name of the repository that contains the requested packages.
*
*
* @return The name of the repository that contains the requested packages.
*/
public String getRepository() {
return this.repository;
}
/**
*
* The name of the repository that contains the requested packages.
*
*
* @param repository
* The name of the repository that contains the requested packages.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListPackagesRequest withRepository(String repository) {
setRepository(repository);
return this;
}
/**
*
* The format used to filter requested packages. Only packages from the provided format will be returned.
*
*
* @param format
* The format used to filter requested packages. Only packages from the provided format will be returned.
* @see PackageFormat
*/
public void setFormat(String format) {
this.format = format;
}
/**
*
* The format used to filter requested packages. Only packages from the provided format will be returned.
*
*
* @return The format used to filter requested packages. Only packages from the provided format will be returned.
* @see PackageFormat
*/
public String getFormat() {
return this.format;
}
/**
*
* The format used to filter requested packages. Only packages from the provided format will be returned.
*
*
* @param format
* The format used to filter requested packages. Only packages from the provided format will be returned.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PackageFormat
*/
public ListPackagesRequest withFormat(String format) {
setFormat(format);
return this;
}
/**
*
* The format used to filter requested packages. Only packages from the provided format will be returned.
*
*
* @param format
* The format used to filter requested packages. Only packages from the provided format will be returned.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PackageFormat
*/
public ListPackagesRequest withFormat(PackageFormat format) {
this.format = format.toString();
return this;
}
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
*/
public void setNamespace(String namespace) {
this.namespace = 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.
*
*
*
*
* @return 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.
*
*
*/
public String getNamespace() {
return this.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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListPackagesRequest withNamespace(String namespace) {
setNamespace(namespace);
return this;
}
/**
*
* A prefix used to filter requested packages. Only packages with names that start with packagePrefix
* are returned.
*
*
* @param packagePrefix
* A prefix used to filter requested packages. Only packages with names that start with
* packagePrefix are returned.
*/
public void setPackagePrefix(String packagePrefix) {
this.packagePrefix = packagePrefix;
}
/**
*
* A prefix used to filter requested packages. Only packages with names that start with packagePrefix
* are returned.
*
*
* @return A prefix used to filter requested packages. Only packages with names that start with
* packagePrefix are returned.
*/
public String getPackagePrefix() {
return this.packagePrefix;
}
/**
*
* A prefix used to filter requested packages. Only packages with names that start with packagePrefix
* are returned.
*
*
* @param packagePrefix
* A prefix used to filter requested packages. Only packages with names that start with
* packagePrefix are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListPackagesRequest withPackagePrefix(String packagePrefix) {
setPackagePrefix(packagePrefix);
return this;
}
/**
*
* The maximum number of results to return per page.
*
*
* @param maxResults
* The maximum number of results to return per page.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return per page.
*
*
* @return The maximum number of results to return per page.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return per page.
*
*
* @param maxResults
* The maximum number of results to return per page.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListPackagesRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setNextToken(String nextToken) {
this.nextToken = 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.
*
*
* @return 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.
*/
public String getNextToken() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListPackagesRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* 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.
*
*
* @param 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 AllowPublish
*/
public void setPublish(String publish) {
this.publish = 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.
*
*
* @return 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 AllowPublish
*/
public String getPublish() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AllowPublish
*/
public ListPackagesRequest withPublish(String publish) {
setPublish(publish);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AllowPublish
*/
public ListPackagesRequest withPublish(AllowPublish publish) {
this.publish = publish.toString();
return this;
}
/**
*
* 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.
*
*
* @param 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 AllowUpstream
*/
public void setUpstream(String upstream) {
this.upstream = 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.
*
*
* @return 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 AllowUpstream
*/
public String getUpstream() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AllowUpstream
*/
public ListPackagesRequest withUpstream(String upstream) {
setUpstream(upstream);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AllowUpstream
*/
public ListPackagesRequest withUpstream(AllowUpstream upstream) {
this.upstream = upstream.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getDomain() != null)
sb.append("Domain: ").append(getDomain()).append(",");
if (getDomainOwner() != null)
sb.append("DomainOwner: ").append(getDomainOwner()).append(",");
if (getRepository() != null)
sb.append("Repository: ").append(getRepository()).append(",");
if (getFormat() != null)
sb.append("Format: ").append(getFormat()).append(",");
if (getNamespace() != null)
sb.append("Namespace: ").append(getNamespace()).append(",");
if (getPackagePrefix() != null)
sb.append("PackagePrefix: ").append(getPackagePrefix()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getPublish() != null)
sb.append("Publish: ").append(getPublish()).append(",");
if (getUpstream() != null)
sb.append("Upstream: ").append(getUpstream());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListPackagesRequest == false)
return false;
ListPackagesRequest other = (ListPackagesRequest) obj;
if (other.getDomain() == null ^ this.getDomain() == null)
return false;
if (other.getDomain() != null && other.getDomain().equals(this.getDomain()) == false)
return false;
if (other.getDomainOwner() == null ^ this.getDomainOwner() == null)
return false;
if (other.getDomainOwner() != null && other.getDomainOwner().equals(this.getDomainOwner()) == false)
return false;
if (other.getRepository() == null ^ this.getRepository() == null)
return false;
if (other.getRepository() != null && other.getRepository().equals(this.getRepository()) == false)
return false;
if (other.getFormat() == null ^ this.getFormat() == null)
return false;
if (other.getFormat() != null && other.getFormat().equals(this.getFormat()) == false)
return false;
if (other.getNamespace() == null ^ this.getNamespace() == null)
return false;
if (other.getNamespace() != null && other.getNamespace().equals(this.getNamespace()) == false)
return false;
if (other.getPackagePrefix() == null ^ this.getPackagePrefix() == null)
return false;
if (other.getPackagePrefix() != null && other.getPackagePrefix().equals(this.getPackagePrefix()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getPublish() == null ^ this.getPublish() == null)
return false;
if (other.getPublish() != null && other.getPublish().equals(this.getPublish()) == false)
return false;
if (other.getUpstream() == null ^ this.getUpstream() == null)
return false;
if (other.getUpstream() != null && other.getUpstream().equals(this.getUpstream()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDomain() == null) ? 0 : getDomain().hashCode());
hashCode = prime * hashCode + ((getDomainOwner() == null) ? 0 : getDomainOwner().hashCode());
hashCode = prime * hashCode + ((getRepository() == null) ? 0 : getRepository().hashCode());
hashCode = prime * hashCode + ((getFormat() == null) ? 0 : getFormat().hashCode());
hashCode = prime * hashCode + ((getNamespace() == null) ? 0 : getNamespace().hashCode());
hashCode = prime * hashCode + ((getPackagePrefix() == null) ? 0 : getPackagePrefix().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getPublish() == null) ? 0 : getPublish().hashCode());
hashCode = prime * hashCode + ((getUpstream() == null) ? 0 : getUpstream().hashCode());
return hashCode;
}
@Override
public ListPackagesRequest clone() {
return (ListPackagesRequest) super.clone();
}
}