
software.amazon.awssdk.services.imagebuilder.model.ImageVersion Maven / Gradle / Ivy
/*
* 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.imagebuilder.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;
/**
*
* The defining characteristics of a specific version of an Image Builder image.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ImageVersion implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField ARN_FIELD = SdkField. builder(MarshallingType.STRING).memberName("arn")
.getter(getter(ImageVersion::arn)).setter(setter(Builder::arn))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("arn").build()).build();
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("name")
.getter(getter(ImageVersion::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("name").build()).build();
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("type")
.getter(getter(ImageVersion::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("type").build()).build();
private static final SdkField VERSION_FIELD = SdkField. builder(MarshallingType.STRING).memberName("version")
.getter(getter(ImageVersion::version)).setter(setter(Builder::version))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("version").build()).build();
private static final SdkField PLATFORM_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("platform").getter(getter(ImageVersion::platformAsString)).setter(setter(Builder::platform))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("platform").build()).build();
private static final SdkField OS_VERSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("osVersion").getter(getter(ImageVersion::osVersion)).setter(setter(Builder::osVersion))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("osVersion").build()).build();
private static final SdkField OWNER_FIELD = SdkField. builder(MarshallingType.STRING).memberName("owner")
.getter(getter(ImageVersion::owner)).setter(setter(Builder::owner))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("owner").build()).build();
private static final SdkField DATE_CREATED_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("dateCreated").getter(getter(ImageVersion::dateCreated)).setter(setter(Builder::dateCreated))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("dateCreated").build()).build();
private static final SdkField BUILD_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("buildType").getter(getter(ImageVersion::buildTypeAsString)).setter(setter(Builder::buildType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("buildType").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ARN_FIELD, NAME_FIELD,
TYPE_FIELD, VERSION_FIELD, PLATFORM_FIELD, OS_VERSION_FIELD, OWNER_FIELD, DATE_CREATED_FIELD, BUILD_TYPE_FIELD));
private static final long serialVersionUID = 1L;
private final String arn;
private final String name;
private final String type;
private final String version;
private final String platform;
private final String osVersion;
private final String owner;
private final String dateCreated;
private final String buildType;
private ImageVersion(BuilderImpl builder) {
this.arn = builder.arn;
this.name = builder.name;
this.type = builder.type;
this.version = builder.version;
this.platform = builder.platform;
this.osVersion = builder.osVersion;
this.owner = builder.owner;
this.dateCreated = builder.dateCreated;
this.buildType = builder.buildType;
}
/**
*
* The Amazon Resource Name (ARN) of a specific version of an Image Builder image.
*
*
*
* Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to that
* object as follows:
*
*
* -
*
* Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either left off
* entirely, or they are specified as wildcards, for example: x.x.x.
*
*
* -
*
* Version ARNs have only the first three nodes: <major>.<minor>.<patch>
*
*
* -
*
* Build version ARNs have all four nodes, and point to a specific build for a specific version of an object.
*
*
*
*
*
* @return The Amazon Resource Name (ARN) of a specific version of an Image Builder image.
*
* Semantic versioning is included in each object's Amazon Resource Name (ARN), at the level that applies to
* that object as follows:
*
*
* -
*
* Versionless ARNs and Name ARNs do not include specific values in any of the nodes. The nodes are either
* left off entirely, or they are specified as wildcards, for example: x.x.x.
*
*
* -
*
* Version ARNs have only the first three nodes: <major>.<minor>.<patch>
*
*
* -
*
* Build version ARNs have all four nodes, and point to a specific build for a specific version of an
* object.
*
*
*
*/
public final String arn() {
return arn;
}
/**
*
* The name of this specific version of an Image Builder image.
*
*
* @return The name of this specific version of an Image Builder image.
*/
public final String name() {
return name;
}
/**
*
* Specifies whether this image is an AMI or a container image.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link ImageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return Specifies whether this image is an AMI or a container image.
* @see ImageType
*/
public final ImageType type() {
return ImageType.fromValue(type);
}
/**
*
* Specifies whether this image is an AMI or a container image.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link ImageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return Specifies whether this image is an AMI or a container image.
* @see ImageType
*/
public final String typeAsString() {
return type;
}
/**
*
* Details for a specific version of an Image Builder image. This version follows the semantic version syntax.
*
*
*
* The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign
* values for the first three, and can filter on all of them.
*
*
* Assignment: For the first three nodes you can assign any positive integer value, including zero, with an
* upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the
* fourth node.
*
*
* Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that
* you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as
* 2021.01.01.
*
*
* Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the most
* recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in
* any node, all nodes to the right of the first wildcard must also be wildcards.
*
*
*
* @return Details for a specific version of an Image Builder image. This version follows the semantic version
* syntax.
*
* The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can
* assign values for the first three, and can filter on all of them.
*
*
* Assignment: For the first three nodes you can assign any positive integer value, including zero,
* with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build
* number to the fourth node.
*
*
* Patterns: You can use any numeric pattern that adheres to the assignment requirements for the
* nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a
* date, such as 2021.01.01.
*
*
* Filtering: With semantic versioning, you have the flexibility to use wildcards (x) to specify the
* most recent versions or nodes when selecting the base image or components for your recipe. When you use a
* wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.
*
*/
public final String version() {
return version;
}
/**
*
* The platform of the image version, for example "Windows" or "Linux".
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #platform} will
* return {@link Platform#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #platformAsString}.
*
*
* @return The platform of the image version, for example "Windows" or "Linux".
* @see Platform
*/
public final Platform platform() {
return Platform.fromValue(platform);
}
/**
*
* The platform of the image version, for example "Windows" or "Linux".
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #platform} will
* return {@link Platform#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #platformAsString}.
*
*
* @return The platform of the image version, for example "Windows" or "Linux".
* @see Platform
*/
public final String platformAsString() {
return platform;
}
/**
*
* The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or
* Microsoft Windows Server 2019.
*
*
* @return The operating system version of the Amazon EC2 build instance. For example, Amazon Linux 2, Ubuntu 18, or
* Microsoft Windows Server 2019.
*/
public final String osVersion() {
return osVersion;
}
/**
*
* The owner of the image version.
*
*
* @return The owner of the image version.
*/
public final String owner() {
return owner;
}
/**
*
* The date on which this specific version of the Image Builder image was created.
*
*
* @return The date on which this specific version of the Image Builder image was created.
*/
public final String dateCreated() {
return dateCreated;
}
/**
*
* Indicates the type of build that created this image. The build can be initiated in the following ways:
*
*
* -
*
* USER_INITIATED – A manual pipeline build request.
*
*
* -
*
* SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from
* EventBridge.
*
*
* -
*
* IMPORT – A VM import created the image to use as the base image for the recipe.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #buildType} will
* return {@link BuildType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #buildTypeAsString}.
*
*
* @return Indicates the type of build that created this image. The build can be initiated in the following
* ways:
*
* -
*
* USER_INITIATED – A manual pipeline build request.
*
*
* -
*
* SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from
* EventBridge.
*
*
* -
*
* IMPORT – A VM import created the image to use as the base image for the recipe.
*
*
* @see BuildType
*/
public final BuildType buildType() {
return BuildType.fromValue(buildType);
}
/**
*
* Indicates the type of build that created this image. The build can be initiated in the following ways:
*
*
* -
*
* USER_INITIATED – A manual pipeline build request.
*
*
* -
*
* SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from
* EventBridge.
*
*
* -
*
* IMPORT – A VM import created the image to use as the base image for the recipe.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #buildType} will
* return {@link BuildType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #buildTypeAsString}.
*
*
* @return Indicates the type of build that created this image. The build can be initiated in the following
* ways:
*
* -
*
* USER_INITIATED – A manual pipeline build request.
*
*
* -
*
* SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from
* EventBridge.
*
*
* -
*
* IMPORT – A VM import created the image to use as the base image for the recipe.
*
*
* @see BuildType
*/
public final String buildTypeAsString() {
return buildType;
}
@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(arn());
hashCode = 31 * hashCode + Objects.hashCode(name());
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(version());
hashCode = 31 * hashCode + Objects.hashCode(platformAsString());
hashCode = 31 * hashCode + Objects.hashCode(osVersion());
hashCode = 31 * hashCode + Objects.hashCode(owner());
hashCode = 31 * hashCode + Objects.hashCode(dateCreated());
hashCode = 31 * hashCode + Objects.hashCode(buildTypeAsString());
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 ImageVersion)) {
return false;
}
ImageVersion other = (ImageVersion) obj;
return Objects.equals(arn(), other.arn()) && Objects.equals(name(), other.name())
&& Objects.equals(typeAsString(), other.typeAsString()) && Objects.equals(version(), other.version())
&& Objects.equals(platformAsString(), other.platformAsString()) && Objects.equals(osVersion(), other.osVersion())
&& Objects.equals(owner(), other.owner()) && Objects.equals(dateCreated(), other.dateCreated())
&& Objects.equals(buildTypeAsString(), other.buildTypeAsString());
}
/**
* 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("ImageVersion").add("Arn", arn()).add("Name", name()).add("Type", typeAsString())
.add("Version", version()).add("Platform", platformAsString()).add("OsVersion", osVersion())
.add("Owner", owner()).add("DateCreated", dateCreated()).add("BuildType", buildTypeAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "arn":
return Optional.ofNullable(clazz.cast(arn()));
case "name":
return Optional.ofNullable(clazz.cast(name()));
case "type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "version":
return Optional.ofNullable(clazz.cast(version()));
case "platform":
return Optional.ofNullable(clazz.cast(platformAsString()));
case "osVersion":
return Optional.ofNullable(clazz.cast(osVersion()));
case "owner":
return Optional.ofNullable(clazz.cast(owner()));
case "dateCreated":
return Optional.ofNullable(clazz.cast(dateCreated()));
case "buildType":
return Optional.ofNullable(clazz.cast(buildTypeAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function