software.amazon.awssdk.services.codeartifact.model.ListPackageVersionsRequest 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 ListPackageVersionsRequest extends CodeartifactRequest implements
ToCopyableBuilder {
private static final SdkField DOMAIN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("domain")
.getter(getter(ListPackageVersionsRequest::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(ListPackageVersionsRequest::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(ListPackageVersionsRequest::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(ListPackageVersionsRequest::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(ListPackageVersionsRequest::namespace)).setter(setter(Builder::namespace))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("namespace").build()).build();
private static final SdkField PACKAGE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("package")
.getter(getter(ListPackageVersionsRequest::packageValue)).setter(setter(Builder::packageValue))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("package").build()).build();
private static final SdkField STATUS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("status")
.getter(getter(ListPackageVersionsRequest::statusAsString)).setter(setter(Builder::status))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("status").build()).build();
private static final SdkField SORT_BY_FIELD = SdkField. builder(MarshallingType.STRING).memberName("sortBy")
.getter(getter(ListPackageVersionsRequest::sortByAsString)).setter(setter(Builder::sortBy))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("sortBy").build()).build();
private static final SdkField MAX_RESULTS_FIELD = SdkField. builder(MarshallingType.INTEGER)
.memberName("maxResults").getter(getter(ListPackageVersionsRequest::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(ListPackageVersionsRequest::nextToken)).setter(setter(Builder::nextToken))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("next-token").build()).build();
private static final SdkField ORIGIN_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("originType").getter(getter(ListPackageVersionsRequest::originTypeAsString))
.setter(setter(Builder::originType))
.traits(LocationTrait.builder().location(MarshallLocation.QUERY_PARAM).locationName("originType").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(DOMAIN_FIELD,
DOMAIN_OWNER_FIELD, REPOSITORY_FIELD, FORMAT_FIELD, NAMESPACE_FIELD, PACKAGE_FIELD, STATUS_FIELD, SORT_BY_FIELD,
MAX_RESULTS_FIELD, NEXT_TOKEN_FIELD, ORIGIN_TYPE_FIELD));
private final String domain;
private final String domainOwner;
private final String repository;
private final String format;
private final String namespace;
private final String packageValue;
private final String status;
private final String sortBy;
private final Integer maxResults;
private final String nextToken;
private final String originType;
private ListPackageVersionsRequest(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.packageValue = builder.packageValue;
this.status = builder.status;
this.sortBy = builder.sortBy;
this.maxResults = builder.maxResults;
this.nextToken = builder.nextToken;
this.originType = builder.originType;
}
/**
*
* The name of the domain that contains the repository that contains the requested package versions.
*
*
* @return The name of the domain that contains the repository that contains the requested package versions.
*/
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 package versions.
*
*
* @return The name of the repository that contains the requested package versions.
*/
public final String repository() {
return repository;
}
/**
*
* The format of the package versions you want to list.
*
*
* 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 package versions you want to list.
* @see PackageFormat
*/
public final PackageFormat format() {
return PackageFormat.fromValue(format);
}
/**
*
* The format of the package versions you want to list.
*
*
* 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 package versions you want to list.
* @see PackageFormat
*/
public final String formatAsString() {
return format;
}
/**
*
* The namespace of the package that contains the requested package versions. 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
.
*
*
* -
*
* 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 of the package that contains the requested package versions. 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
.
*
*
* -
*
* 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;
}
/**
*
* The name of the package for which you want to request package versions.
*
*
* @return The name of the package for which you want to request package versions.
*/
public final String packageValue() {
return packageValue;
}
/**
*
* A string that filters the requested package versions by status.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link PackageVersionStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return A string that filters the requested package versions by status.
* @see PackageVersionStatus
*/
public final PackageVersionStatus status() {
return PackageVersionStatus.fromValue(status);
}
/**
*
* A string that filters the requested package versions by status.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #status} will
* return {@link PackageVersionStatus#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #statusAsString}.
*
*
* @return A string that filters the requested package versions by status.
* @see PackageVersionStatus
*/
public final String statusAsString() {
return status;
}
/**
*
* How to sort the requested list of package versions.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortBy} will
* return {@link PackageVersionSortType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #sortByAsString}.
*
*
* @return How to sort the requested list of package versions.
* @see PackageVersionSortType
*/
public final PackageVersionSortType sortBy() {
return PackageVersionSortType.fromValue(sortBy);
}
/**
*
* How to sort the requested list of package versions.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #sortBy} will
* return {@link PackageVersionSortType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #sortByAsString}.
*
*
* @return How to sort the requested list of package versions.
* @see PackageVersionSortType
*/
public final String sortByAsString() {
return sortBy;
}
/**
*
* 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 originType
used to filter package versions. Only package versions with the provided
* originType
will be returned.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #originType} will
* return {@link PackageVersionOriginType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #originTypeAsString}.
*
*
* @return The originType
used to filter package versions. Only package versions with the provided
* originType
will be returned.
* @see PackageVersionOriginType
*/
public final PackageVersionOriginType originType() {
return PackageVersionOriginType.fromValue(originType);
}
/**
*
* The originType
used to filter package versions. Only package versions with the provided
* originType
will be returned.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #originType} will
* return {@link PackageVersionOriginType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #originTypeAsString}.
*
*
* @return The originType
used to filter package versions. Only package versions with the provided
* originType
will be returned.
* @see PackageVersionOriginType
*/
public final String originTypeAsString() {
return originType;
}
@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(packageValue());
hashCode = 31 * hashCode + Objects.hashCode(statusAsString());
hashCode = 31 * hashCode + Objects.hashCode(sortByAsString());
hashCode = 31 * hashCode + Objects.hashCode(maxResults());
hashCode = 31 * hashCode + Objects.hashCode(nextToken());
hashCode = 31 * hashCode + Objects.hashCode(originTypeAsString());
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 ListPackageVersionsRequest)) {
return false;
}
ListPackageVersionsRequest other = (ListPackageVersionsRequest) 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(packageValue(), other.packageValue())
&& Objects.equals(statusAsString(), other.statusAsString())
&& Objects.equals(sortByAsString(), other.sortByAsString()) && Objects.equals(maxResults(), other.maxResults())
&& Objects.equals(nextToken(), other.nextToken())
&& Objects.equals(originTypeAsString(), other.originTypeAsString());
}
/**
* 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("ListPackageVersionsRequest").add("Domain", domain()).add("DomainOwner", domainOwner())
.add("Repository", repository()).add("Format", formatAsString()).add("Namespace", namespace())
.add("Package", packageValue()).add("Status", statusAsString()).add("SortBy", sortByAsString())
.add("MaxResults", maxResults()).add("NextToken", nextToken()).add("OriginType", originTypeAsString()).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 "package":
return Optional.ofNullable(clazz.cast(packageValue()));
case "status":
return Optional.ofNullable(clazz.cast(statusAsString()));
case "sortBy":
return Optional.ofNullable(clazz.cast(sortByAsString()));
case "maxResults":
return Optional.ofNullable(clazz.cast(maxResults()));
case "nextToken":
return Optional.ofNullable(clazz.cast(nextToken()));
case "originType":
return Optional.ofNullable(clazz.cast(originTypeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function