software.amazon.awssdk.services.codeartifact.model.PackageDescription 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.Consumer;
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.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class PackageDescription implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField FORMAT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("format")
.getter(getter(PackageDescription::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(PackageDescription::namespace)).setter(setter(Builder::namespace))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("namespace").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(PackageDescription::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField ORIGIN_CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("originConfiguration")
.getter(getter(PackageDescription::originConfiguration)).setter(setter(Builder::originConfiguration))
.constructor(PackageOriginConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("originConfiguration").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FORMAT_FIELD, NAMESPACE_FIELD,
NAME_FIELD, ORIGIN_CONFIGURATION_FIELD));
private static final long serialVersionUID = 1L;
private final String format;
private final String namespace;
private final String name;
private final PackageOriginConfiguration originConfiguration;
private PackageDescription(BuilderImpl builder) {
this.format = builder.format;
this.namespace = builder.namespace;
this.name = builder.name;
this.originConfiguration = builder.originConfiguration;
}
/**
*
* A format that specifies the type of the package.
*
*
* 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 A format that specifies the type of the package.
* @see PackageFormat
*/
public final PackageFormat format() {
return PackageFormat.fromValue(format);
}
/**
*
* A format that specifies the type of the package.
*
*
* 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 A format that specifies the type of the package.
* @see PackageFormat
*/
public final 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.
*
*
* -
*
* 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. 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.
*
*
* @return The name of the package.
*/
public final String name() {
return name;
}
/**
*
* The package origin configuration for the package.
*
*
* @return The package origin configuration for the package.
*/
public final PackageOriginConfiguration originConfiguration() {
return originConfiguration;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(formatAsString());
hashCode = 31 * hashCode + Objects.hashCode(namespace());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(originConfiguration());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof PackageDescription)) {
return false;
}
PackageDescription other = (PackageDescription) obj;
return Objects.equals(formatAsString(), other.formatAsString()) && Objects.equals(namespace(), other.namespace())
&& Objects.equals(name(), other.name()) && Objects.equals(originConfiguration(), other.originConfiguration());
}
/**
* 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("PackageDescription").add("Format", formatAsString()).add("Namespace", namespace())
.add("Name", name()).add("OriginConfiguration", originConfiguration()).build();
}
public final 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 "name":
return Optional.ofNullable(clazz.cast(name()));
case "originConfiguration":
return Optional.ofNullable(clazz.cast(originConfiguration()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((PackageDescription) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* A format that specifies the type of the package.
*
*
* @param format
* A format that specifies the type of the package.
* @see PackageFormat
* @return Returns a reference to this object so that method calls can be chained together.
* @see PackageFormat
*/
Builder format(String format);
/**
*
* A format that specifies the type of the package.
*
*
* @param format
* A format that specifies the type of the package.
* @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.
*
*
* -
*
* 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 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.
*
*
* -
*
* 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.
*/
Builder namespace(String namespace);
/**
*
* The name of the package.
*
*
* @param name
* The name of the package.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* The package origin configuration for the package.
*
*
* @param originConfiguration
* The package origin configuration for the package.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder originConfiguration(PackageOriginConfiguration originConfiguration);
/**
*
* The package origin configuration for the package.
*
* This is a convenience method that creates an instance of the {@link PackageOriginConfiguration.Builder}
* avoiding the need to create one manually via {@link PackageOriginConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link PackageOriginConfiguration.Builder#build()} is called immediately
* and its result is passed to {@link #originConfiguration(PackageOriginConfiguration)}.
*
* @param originConfiguration
* a consumer that will call methods on {@link PackageOriginConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #originConfiguration(PackageOriginConfiguration)
*/
default Builder originConfiguration(Consumer originConfiguration) {
return originConfiguration(PackageOriginConfiguration.builder().applyMutation(originConfiguration).build());
}
}
static final class BuilderImpl implements Builder {
private String format;
private String namespace;
private String name;
private PackageOriginConfiguration originConfiguration;
private BuilderImpl() {
}
private BuilderImpl(PackageDescription model) {
format(model.format);
namespace(model.namespace);
name(model.name);
originConfiguration(model.originConfiguration);
}
public final String getFormat() {
return format;
}
public final void setFormat(String format) {
this.format = 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 String getNamespace() {
return namespace;
}
public final void setNamespace(String namespace) {
this.namespace = namespace;
}
@Override
public final Builder namespace(String namespace) {
this.namespace = namespace;
return this;
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
public final Builder name(String name) {
this.name = name;
return this;
}
public final PackageOriginConfiguration.Builder getOriginConfiguration() {
return originConfiguration != null ? originConfiguration.toBuilder() : null;
}
public final void setOriginConfiguration(PackageOriginConfiguration.BuilderImpl originConfiguration) {
this.originConfiguration = originConfiguration != null ? originConfiguration.build() : null;
}
@Override
public final Builder originConfiguration(PackageOriginConfiguration originConfiguration) {
this.originConfiguration = originConfiguration;
return this;
}
@Override
public PackageDescription build() {
return new PackageDescription(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}