software.amazon.awssdk.services.codeartifact.model.ListPackagesRequest Maven / Gradle / Ivy
Show all versions of codeartifact Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.codeartifact.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class ListPackagesRequest extends CodeartifactRequest implements
ToCopyableBuilder {
private static final SdkField DOMAIN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("domain")
.getter(getter(ListPackagesRequest::domain)).setter(setter(Builder::domain))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("domain").build()).build();
private static final SdkField DOMAIN_OWNER_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("domainOwner").getter(getter(ListPackagesRequest::domainOwner)).setter(setter(Builder::domainOwner))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("domain-owner").build()).build();
private static final SdkField REPOSITORY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("repository").getter(getter(ListPackagesRequest::repository)).setter(setter(Builder::repository))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("repository").build()).build();
private static final SdkField FORMAT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("format")
.getter(getter(ListPackagesRequest::formatAsString)).setter(setter(Builder::format))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("format").build()).build();
private static final SdkField NAMESPACE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("namespace").getter(getter(ListPackagesRequest::namespace)).setter(setter(Builder::namespace))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("namespace").build()).build();
private static final SdkField PACKAGE_PREFIX_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("packagePrefix").getter(getter(ListPackagesRequest::packagePrefix))
.setter(setter(Builder::packagePrefix))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("package-prefix").build())
.build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("maxResults").getter(getter(ListPackagesRequest::maxResults)).setter(setter(Builder::maxResults))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("max-results").build()).build();
private static final SdkField NEXT_TOKEN_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("nextToken").getter(getter(ListPackagesRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("next-token").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOMAIN_FIELD,
DOMAIN_OWNER_FIELD, REPOSITORY_FIELD, FORMAT_FIELD, NAMESPACE_FIELD, PACKAGE_PREFIX_FIELD, MAX_RESULTS_FIELD,
NEXT_TOKEN_FIELD));
private final String domain;
private final String domainOwner;
private final String repository;
private final String format;
private final String namespace;
private final String packagePrefix;
private final Integer maxResults;
private final String nextToken;
private ListPackagesRequest(BuilderImpl builder) {
super(builder);
this.domain = builder.domain;
this.domainOwner = builder.domainOwner;
this.repository = builder.repository;
this.format = builder.format;
this.namespace = builder.namespace;
this.packagePrefix = builder.packagePrefix;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
}
/**
*
* The domain that contains the repository that contains the requested list of packages.
*
*
* @return The domain that contains the repository that contains the requested list of packages.
*/
public String domain() {
return domain;
}
/**
*
* The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
*
*
* @return The 12-digit account number of the AWS account that owns the domain. It does not include dashes or
* spaces.
*/
public String domainOwner() {
return domainOwner;
}
/**
*
* The name of the repository from which packages are to be listed.
*
*
* @return The name of the repository from which packages are to be listed.
*/
public String repository() {
return repository;
}
/**
*
* The format of the packages. The valid package types are:
*
*
* -
*
* npm: A Node Package Manager (npm) package.
*
*
* -
*
* pypi: A Python Package Index (PyPI) package.
*
*
* -
*
* maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #format} will
* return {@link PackageFormat#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #formatAsString}.
*
*
* @return The format of the packages. The valid package types are:
*
* -
*
* npm: A Node Package Manager (npm) package.
*
*
* -
*
* pypi: A Python Package Index (PyPI) package.
*
*
* -
*
* maven: A Maven package that contains compiled code in a distributable format, such as a JAR
* file.
*
*
* @see PackageFormat
*/
public PackageFormat format() {
return PackageFormat.fromValue(format);
}
/**
*
* The format of the packages. The valid package types are:
*
*
* -
*
* npm: A Node Package Manager (npm) package.
*
*
* -
*
* pypi: A Python Package Index (PyPI) package.
*
*
* -
*
* maven: A Maven package that contains compiled code in a distributable format, such as a JAR file.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #format} will
* return {@link PackageFormat#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #formatAsString}.
*
*
* @return The format of the packages. The valid package types are:
*
* -
*
* npm: A Node Package Manager (npm) package.
*
*
* -
*
* pypi: A Python Package Index (PyPI) package.
*
*
* -
*
* maven: A Maven package that contains compiled code in a distributable format, such as a JAR
* file.
*
*
* @see PackageFormat
*/
public String formatAsString() {
return format;
}
/**
*
* The namespace of the package. The package component that specifies its namespace depends on its type. For
* example:
*
*
* -
*
* The namespace of a Maven package is its groupId.
*
*
* -
*
* The namespace of an npm package is its scope.
*
*
* -
*
* A Python package does not contain a corresponding component, so Python packages do not have a namespace.
*
*
*
*
* @return The namespace of the package. The package component that specifies its namespace depends on its type. For
* example:
*
* -
*
* The namespace of a Maven package is its groupId.
*
*
* -
*
* The namespace of an npm package is its scope.
*
*
* -
*
* A Python package does not contain a corresponding component, so Python packages do not have a namespace.
*
*
*/
public String namespace() {
return namespace;
}
/**
*
* A prefix used to filter returned repositories. Only repositories with names that start with
* repositoryPrefix are returned.
*
*
* @return A prefix used to filter returned repositories. Only repositories with names that start with
* repositoryPrefix are returned.
*/
public String packagePrefix() {
return packagePrefix;
}
/**
*
* The maximum number of results to return per page.
*
*
* @return The maximum number of results to return per page.
*/
public Integer maxResults() {
return 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.
*
*
* @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 nextToken() {
return nextToken;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(domain());
hashCode = 31 * hashCode + Objects.hashCode(domainOwner());
hashCode = 31 * hashCode + Objects.hashCode(repository());
hashCode = 31 * hashCode + Objects.hashCode(formatAsString());
hashCode = 31 * hashCode + Objects.hashCode(namespace());
hashCode = 31 * hashCode + Objects.hashCode(packagePrefix());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ListPackagesRequest)) {
return false;
}
ListPackagesRequest other = (ListPackagesRequest) obj;
return Objects.equals(domain(), other.domain()) && Objects.equals(domainOwner(), other.domainOwner())
&& Objects.equals(repository(), other.repository()) && Objects.equals(formatAsString(), other.formatAsString())
&& Objects.equals(namespace(), other.namespace()) && Objects.equals(packagePrefix(), other.packagePrefix())
&& Objects.equals(maxResults(), other.maxResults()) && Objects.equals(nextToken(), other.nextToken());
}
/**
* 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.
*/
@Override
public String toString() {
return ToString.builder("ListPackagesRequest").add("Domain", domain()).add("DomainOwner", domainOwner())
.add("Repository", repository()).add("Format", formatAsString()).add("Namespace", namespace())
.add("PackagePrefix", packagePrefix()).add("MaxResults", maxResults()).add("NextToken", nextToken()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "domain":
return Optional.ofNullable(clazz.cast(domain()));
case "domainOwner":
return Optional.ofNullable(clazz.cast(domainOwner()));
case "repository":
return Optional.ofNullable(clazz.cast(repository()));
case "format":
return Optional.ofNullable(clazz.cast(formatAsString()));
case "namespace":
return Optional.ofNullable(clazz.cast(namespace()));
case "packagePrefix":
return Optional.ofNullable(clazz.cast(packagePrefix()));
case "maxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((ListPackagesRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CodeartifactRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The domain that contains the repository that contains the requested list of packages.
*
*
* @param domain
* The domain that contains the repository that contains the requested list of packages.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder domain(String domain);
/**
*
* The 12-digit account number of the AWS account that owns the domain. It does not include dashes or spaces.
*
*
* @param domainOwner
* The 12-digit account number of the AWS 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.
*/
Builder domainOwner(String domainOwner);
/**
*
* The name of the repository from which packages are to be listed.
*
*
* @param repository
* The name of the repository from which packages are to be listed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder repository(String repository);
/**
*
* The format of the packages. The valid package types are:
*
*
* -
*
* npm: A Node Package Manager (npm) package.
*
*
* -
*
* pypi: A Python Package Index (PyPI) package.
*
*
* -
*
* maven: A Maven package that contains compiled code in a distributable format, such as a JAR
* file.
*
*
*
*
* @param format
* The format of the packages. The valid package types are:
*
* -
*
* npm: A Node Package Manager (npm) package.
*
*
* -
*
* pypi: A Python Package Index (PyPI) package.
*
*
* -
*
* maven: A Maven package that contains compiled code in a distributable format, such as a
* JAR file.
*
*
* @see PackageFormat
* @return Returns a reference to this object so that method calls can be chained together.
* @see PackageFormat
*/
Builder format(String format);
/**
*
* The format of the packages. The valid package types are:
*
*
* -
*
* npm: A Node Package Manager (npm) package.
*
*
* -
*
* pypi: A Python Package Index (PyPI) package.
*
*
* -
*
* maven: A Maven package that contains compiled code in a distributable format, such as a JAR
* file.
*
*
*
*
* @param format
* The format of the packages. The valid package types are:
*
* -
*
* npm: A Node Package Manager (npm) package.
*
*
* -
*
* pypi: A Python Package Index (PyPI) package.
*
*
* -
*
* maven: A Maven package that contains compiled code in a distributable format, such as a
* JAR file.
*
*
* @see PackageFormat
* @return Returns a reference to this object so that method calls can be chained together.
* @see PackageFormat
*/
Builder format(PackageFormat format);
/**
*
* The namespace of the package. The package component that specifies its namespace depends on its type. For
* example:
*
*
* -
*
* The namespace of a Maven package is its groupId.
*
*
* -
*
* The namespace of an npm package is its scope.
*
*
* -
*
* A Python package does not contain a corresponding component, so Python packages do not have a namespace.
*
*
*
*
* @param namespace
* The namespace of the package. The package component that specifies its namespace depends on its type.
* For example:
*
* -
*
* The namespace of a Maven package is its groupId.
*
*
* -
*
* The namespace of an npm package is its scope.
*
*
* -
*
* A Python package does not contain a corresponding component, so Python packages do not have a
* namespace.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder namespace(String namespace);
/**
*
* A prefix used to filter returned repositories. Only repositories with names that start with
* repositoryPrefix are returned.
*
*
* @param packagePrefix
* A prefix used to filter returned repositories. Only repositories with names that start with
* repositoryPrefix are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder packagePrefix(String packagePrefix);
/**
*
* 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.
*/
Builder maxResults(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.
*
*
* @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.
*/
Builder nextToken(String nextToken);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CodeartifactRequest.BuilderImpl implements Builder {
private String domain;
private String domainOwner;
private String repository;
private String format;
private String namespace;
private String packagePrefix;
private Integer maxResults;
private String nextToken;
private BuilderImpl() {
}
private BuilderImpl(ListPackagesRequest model) {
super(model);
domain(model.domain);
domainOwner(model.domainOwner);
repository(model.repository);
format(model.format);
namespace(model.namespace);
packagePrefix(model.packagePrefix);
maxResults(model.maxResults);
nextToken(model.nextToken);
}
public final String getDomain() {
return domain;
}
@Override
public final Builder domain(String domain) {
this.domain = domain;
return this;
}
public final void setDomain(String domain) {
this.domain = domain;
}
public final String getDomainOwner() {
return domainOwner;
}
@Override
public final Builder domainOwner(String domainOwner) {
this.domainOwner = domainOwner;
return this;
}
public final void setDomainOwner(String domainOwner) {
this.domainOwner = domainOwner;
}
public final String getRepository() {
return repository;
}
@Override
public final Builder repository(String repository) {
this.repository = repository;
return this;
}
public final void setRepository(String repository) {
this.repository = repository;
}
public final String getFormat() {
return format;
}
@Override
public final Builder format(String format) {
this.format = format;
return this;
}
@Override
public final Builder format(PackageFormat format) {
this.format(format == null ? null : format.toString());
return this;
}
public final void setFormat(String format) {
this.format = format;
}
public final String getNamespace() {
return namespace;
}
@Override
public final Builder namespace(String namespace) {
this.namespace = namespace;
return this;
}
public final void setNamespace(String namespace) {
this.namespace = namespace;
}
public final String getPackagePrefix() {
return packagePrefix;
}
@Override
public final Builder packagePrefix(String packagePrefix) {
this.packagePrefix = packagePrefix;
return this;
}
public final void setPackagePrefix(String packagePrefix) {
this.packagePrefix = packagePrefix;
}
public final Integer getMaxResults() {
return maxResults;
}
@Override
public final Builder maxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
public final void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
public final String getNextToken() {
return nextToken;
}
@Override
public final Builder nextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
public final void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public ListPackagesRequest build() {
return new ListPackagesRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}