software.amazon.awssdk.services.codeartifact.model.AssociatedPackage 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.HashMap;
import java.util.List;
import java.util.Map;
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;
/**
*
* A package associated with a package group.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AssociatedPackage implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField FORMAT_FIELD = SdkField. builder(MarshallingType.STRING).memberName("format")
.getter(getter(AssociatedPackage::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(AssociatedPackage::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(AssociatedPackage::packageValue)).setter(setter(Builder::packageValue))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("package").build()).build();
private static final SdkField ASSOCIATION_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("associationType").getter(getter(AssociatedPackage::associationTypeAsString))
.setter(setter(Builder::associationType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("associationType").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(FORMAT_FIELD, NAMESPACE_FIELD,
PACKAGE_FIELD, ASSOCIATION_TYPE_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("format", FORMAT_FIELD);
put("namespace", NAMESPACE_FIELD);
put("package", PACKAGE_FIELD);
put("associationType", ASSOCIATION_TYPE_FIELD);
}
});
private static final long serialVersionUID = 1L;
private final String format;
private final String namespace;
private final String packageValue;
private final String associationType;
private AssociatedPackage(BuilderImpl builder) {
this.format = builder.format;
this.namespace = builder.namespace;
this.packageValue = builder.packageValue;
this.associationType = builder.associationType;
}
/**
*
* A format that specifies the type of the associated 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 associated package.
* @see PackageFormat
*/
public final PackageFormat format() {
return PackageFormat.fromValue(format);
}
/**
*
* A format that specifies the type of the associated 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 associated package.
* @see PackageFormat
*/
public final String formatAsString() {
return format;
}
/**
*
* The namespace of the associated package. The package component that specifies its namespace depends on its type.
* For example:
*
*
* -
*
* The namespace of a Maven package version is its groupId
.
*
*
* -
*
* The namespace of an npm or Swift package version is its scope
.
*
*
* -
*
* The namespace of a generic package is its namespace
.
*
*
* -
*
* Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package versions of
* those formats do not have a namespace.
*
*
*
*
* @return The namespace of the associated package. The package component that specifies its namespace depends on
* its type. For example:
*
* -
*
* The namespace of a Maven package version is its groupId
.
*
*
* -
*
* The namespace of an npm or Swift package version is its scope
.
*
*
* -
*
* The namespace of a generic package is its namespace
.
*
*
* -
*
* Python, NuGet, Ruby, and Cargo package versions do not contain a corresponding component, package
* versions of those formats do not have a namespace.
*
*
*/
public final String namespace() {
return namespace;
}
/**
*
* The name of the associated package.
*
*
* @return The name of the associated package.
*/
public final String packageValue() {
return packageValue;
}
/**
*
* Describes the strength of the association between the package and package group. A strong match can be thought of
* as an exact match, and a weak match can be thought of as a variation match, for example, the package name matches
* a variation of the package group pattern. For more information about package group pattern matching, including
* strong and weak matches, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #associationType}
* will return {@link PackageGroupAssociationType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #associationTypeAsString}.
*
*
* @return Describes the strength of the association between the package and package group. A strong match can be
* thought of as an exact match, and a weak match can be thought of as a variation match, for example, the
* package name matches a variation of the package group pattern. For more information about package group
* pattern matching, including strong and weak matches, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
* @see PackageGroupAssociationType
*/
public final PackageGroupAssociationType associationType() {
return PackageGroupAssociationType.fromValue(associationType);
}
/**
*
* Describes the strength of the association between the package and package group. A strong match can be thought of
* as an exact match, and a weak match can be thought of as a variation match, for example, the package name matches
* a variation of the package group pattern. For more information about package group pattern matching, including
* strong and weak matches, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #associationType}
* will return {@link PackageGroupAssociationType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #associationTypeAsString}.
*
*
* @return Describes the strength of the association between the package and package group. A strong match can be
* thought of as an exact match, and a weak match can be thought of as a variation match, for example, the
* package name matches a variation of the package group pattern. For more information about package group
* pattern matching, including strong and weak matches, see Package group definition syntax and matching behavior in the CodeArtifact User Guide.
* @see PackageGroupAssociationType
*/
public final String associationTypeAsString() {
return associationType;
}
@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 + Objects.hashCode(formatAsString());
hashCode = 31 * hashCode + Objects.hashCode(namespace());
hashCode = 31 * hashCode + Objects.hashCode(packageValue());
hashCode = 31 * hashCode + Objects.hashCode(associationTypeAsString());
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 AssociatedPackage)) {
return false;
}
AssociatedPackage other = (AssociatedPackage) obj;
return Objects.equals(formatAsString(), other.formatAsString()) && Objects.equals(namespace(), other.namespace())
&& Objects.equals(packageValue(), other.packageValue())
&& Objects.equals(associationTypeAsString(), other.associationTypeAsString());
}
/**
* 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("AssociatedPackage").add("Format", formatAsString()).add("Namespace", namespace())
.add("Package", packageValue()).add("AssociationType", associationTypeAsString()).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 "package":
return Optional.ofNullable(clazz.cast(packageValue()));
case "associationType":
return Optional.ofNullable(clazz.cast(associationTypeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function