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 SdkField PUBLISH_FIELD = SdkField. builder(MarshallingType.STRING).memberName("publish")
.getter(getter(ListPackagesRequest::publishAsString)).setter(setter(Builder::publish))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("publish").build()).build();
private static final SdkField UPSTREAM_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("upstream").getter(getter(ListPackagesRequest::upstreamAsString)).setter(setter(Builder::upstream))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("upstream").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, PUBLISH_FIELD, UPSTREAM_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 final String publish;
private final String upstream;
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;
this.publish = builder.publish;
this.upstream = builder.upstream;
}
/**
*
* 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 final String domain() {
return domain;
}
/**
*
* 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 final String domainOwner() {
return domainOwner;
}
/**
*
* The name of the repository that contains the requested packages.
*
*
* @return The name of the repository that contains the requested packages.
*/
public final String repository() {
return repository;
}
/**
*
* 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, {@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 used to filter requested packages. Only packages from the provided format will be returned.
* @see PackageFormat
*/
public final PackageFormat format() {
return PackageFormat.fromValue(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, {@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 used to filter requested packages. Only packages from the provided format will be returned.
* @see PackageFormat
*/
public final String formatAsString() {
return 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
.
*
*
*
*
* @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 final String namespace() {
return namespace;
}
/**
*
* 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 final String packagePrefix() {
return packagePrefix;
}
/**
*
* The maximum number of results to return per page.
*
*
* @return The maximum number of results to return per page.
*/
public final 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 final String nextToken() {
return 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.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #publish} will
* return {@link AllowPublish#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #publishAsString}.
*
*
* @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 final AllowPublish publish() {
return AllowPublish.fromValue(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, {@link #publish} will
* return {@link AllowPublish#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #publishAsString}.
*
*
* @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 final String publishAsString() {
return 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.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #upstream} will
* return {@link AllowUpstream#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #upstreamAsString}.
*
*
* @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 final AllowUpstream upstream() {
return AllowUpstream.fromValue(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, {@link #upstream} will
* return {@link AllowUpstream#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #upstreamAsString}.
*
*
* @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 final String upstreamAsString() {
return upstream;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final 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());
hashCode = 31 * hashCode + Objects.hashCode(publishAsString());
hashCode = 31 * hashCode + Objects.hashCode(upstreamAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final 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())
&& Objects.equals(publishAsString(), other.publishAsString())
&& Objects.equals(upstreamAsString(), other.upstreamAsString());
}
/**
* 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 final 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())
.add("Publish", publishAsString()).add("Upstream", upstreamAsString()).build();
}
public final 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()));
case "publish":
return Optional.ofNullable(clazz.cast(publishAsString()));
case "upstream":
return Optional.ofNullable(clazz.cast(upstreamAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function