software.amazon.awssdk.services.codeartifact.model.PackageSummary 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.io.Serializable;
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.Function;
import software.amazon.awssdk.annotations.Generated;
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;
/**
*
* Details about a package, including its format, namespace, and name. The ListPackages
* operation returns a list of PackageSummary objects.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PackageSummary implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField FORMAT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("format")
.getter(getter(PackageSummary::formatAsString)).setter(setter(Builder::format))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("format").build()).build();
private static final SdkField NAMESPACE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("namespace").getter(getter(PackageSummary::namespace)).setter(setter(Builder::namespace))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("namespace").build()).build();
private static final SdkField PACKAGE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("package")
.getter(getter(PackageSummary::packageValue)).setter(setter(Builder::packageValue))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("package").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FORMAT_FIELD, NAMESPACE_FIELD,
PACKAGE_FIELD));
private static final long serialVersionUID = 1L;
private final String format;
private final String namespace;
private final String packageValue;
private PackageSummary(BuilderImpl builder) {
this.format = builder.format;
this.namespace = builder.namespace;
this.packageValue = builder.packageValue;
}
/**
*
* The format of the package. Valid values are:
*
*
* -
*
* npm
*
*
* -
*
* pypi
*
*
* -
*
* maven
*
*
*
*
* 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. Valid values are:
*
* -
*
* npm
*
*
* -
*
* pypi
*
*
* -
*
* maven
*
*
* @see PackageFormat
*/
public PackageFormat format() {
return PackageFormat.fromValue(format);
}
/**
*
* The format of the package. Valid values are:
*
*
* -
*
* npm
*
*
* -
*
* pypi
*
*
* -
*
* maven
*
*
*
*
* 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. Valid values are:
*
* -
*
* npm
*
*
* -
*
* pypi
*
*
* -
*
* maven
*
*
* @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;
}
/**
*
* The name of the package.
*
*
* @return The name of the package.
*/
public String packageValue() {
return packageValue;
}
@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 + Objects.hashCode(formatAsString());
hashCode = 31 * hashCode + Objects.hashCode(namespace());
hashCode = 31 * hashCode + Objects.hashCode(packageValue());
return hashCode;
}
@Override
public boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PackageSummary)) {
return false;
}
PackageSummary other = (PackageSummary) obj;
return Objects.equals(formatAsString(), other.formatAsString()) && Objects.equals(namespace(), other.namespace())
&& Objects.equals(packageValue(), other.packageValue());
}
/**
* 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("PackageSummary").add("Format", formatAsString()).add("Namespace", namespace())
.add("Package", packageValue()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "format":
return Optional.ofNullable(clazz.cast(formatAsString()));
case "namespace":
return Optional.ofNullable(clazz.cast(namespace()));
case "package":
return Optional.ofNullable(clazz.cast(packageValue()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PackageSummary) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The format of the package. Valid values are:
*
*
* -
*
* npm
*
*
* -
*
* pypi
*
*
* -
*
* maven
*
*
*
*
* @param format
* The format of the package. Valid values are:
*
* -
*
* npm
*
*
* -
*
* pypi
*
*
* -
*
* maven
*
*
* @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 package. Valid values are:
*
*
* -
*
* npm
*
*
* -
*
* pypi
*
*
* -
*
* maven
*
*
*
*
* @param format
* The format of the package. Valid values are:
*
* -
*
* npm
*
*
* -
*
* pypi
*
*
* -
*
* maven
*
*
* @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);
/**
*
* The name of the package.
*
*
* @param packageValue
* The name of the package.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder packageValue(String packageValue);
}
static final class BuilderImpl implements Builder {
private String format;
private String namespace;
private String packageValue;
private BuilderImpl() {
}
private BuilderImpl(PackageSummary model) {
format(model.format);
namespace(model.namespace);
packageValue(model.packageValue);
}
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 getPackageValue() {
return packageValue;
}
@Override
public final Builder packageValue(String packageValue) {
this.packageValue = packageValue;
return this;
}
public final void setPackageValue(String packageValue) {
this.packageValue = packageValue;
}
@Override
public PackageSummary build() {
return new PackageSummary(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}