software.amazon.awssdk.services.imagebuilder.model

Class ImageRecipe

java.lang.Object

software.amazon.awssdk.services.imagebuilder.model.ImageRecipe

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ImageRecipe.Builder,ImageRecipe>

@Generated(value="software.amazon.awssdk:codegen")
public final class ImageRecipe
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ImageRecipe.Builder,ImageRecipe>

An image recipe.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImageRecipe.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the image recipe.
List<InstanceBlockDeviceMapping>	blockDeviceMappings() The block device mappings to apply when creating images from this recipe.
static ImageRecipe.Builder	builder()
List<ComponentConfiguration>	components() The components of the image recipe.
String	dateCreated() The date on which this image recipe was created.
String	description() The description of the image recipe.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasBlockDeviceMappings() Returns true if the BlockDeviceMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasComponents() Returns true if the Components property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	name() The name of the image recipe.
String	owner() The owner of the image recipe.
String	parentImage() The parent image of the image recipe.
Platform	platform() The platform of the image recipe.
String	platformAsString() The platform of the image recipe.
List<SdkField<?>>	sdkFields()
static Class<? extends ImageRecipe.Builder>	serializableBuilderClass()
Map<String,String>	tags() The tags of the image recipe.
ImageRecipe.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
ImageType	type() Specifies which type of image is created by the recipe - an AMI or a container image.
String	typeAsString() Specifies which type of image is created by the recipe - an AMI or a container image.
String	version() The version of the image recipe.
String	workingDirectory() The working directory to be used during build and test workflows.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public final String arn()

The Amazon Resource Name (ARN) of the image recipe.

Returns:

The Amazon Resource Name (ARN) of the image recipe.

type

public final ImageType type()

Specifies which type of image is created by the recipe - an AMI or a container image.

If the service returns an enum value that is not available in the current SDK version, type will return ImageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Specifies which type of image is created by the recipe - an AMI or a container image.

See Also:

ImageType

typeAsString

public final String typeAsString()

Specifies which type of image is created by the recipe - an AMI or a container image.

If the service returns an enum value that is not available in the current SDK version, type will return ImageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

Specifies which type of image is created by the recipe - an AMI or a container image.

See Also:

ImageType

name

public final String name()

The name of the image recipe.

Returns:

The name of the image recipe.

description

public final String description()

The description of the image recipe.

Returns:

The description of the image recipe.

platform

public final Platform platform()

The platform of the image recipe.

If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

Returns:

The platform of the image recipe.

See Also:

Platform

platformAsString

public final String platformAsString()

The platform of the image recipe.

If the service returns an enum value that is not available in the current SDK version, platform will return Platform.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

Returns:

The platform of the image recipe.

See Also:

Platform

owner

public final String owner()

The owner of the image recipe.

Returns:

The owner of the image recipe.

version

public final String version()

The version of the image recipe.

Returns:

The version of the image recipe.

hasComponents

public final boolean hasComponents()

Returns true if the Components property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

components

public final List<ComponentConfiguration> components()

The components of the image recipe.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasComponents() to see if a value was sent in this field.

Returns:

The components of the image recipe.

parentImage

public final String parentImage()

The parent image of the image recipe.

Returns:

The parent image of the image recipe.

hasBlockDeviceMappings

public final boolean hasBlockDeviceMappings()

Returns true if the BlockDeviceMappings property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

blockDeviceMappings

public final List<InstanceBlockDeviceMapping> blockDeviceMappings()

The block device mappings to apply when creating images from this recipe.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasBlockDeviceMappings() to see if a value was sent in this field.

Returns:

The block device mappings to apply when creating images from this recipe.

dateCreated

public final String dateCreated()

The date on which this image recipe was created.

Returns:

The date on which this image recipe was created.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

The tags of the image recipe.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasTags() to see if a value was sent in this field.

Returns:

The tags of the image recipe.

workingDirectory

public final String workingDirectory()

The working directory to be used during build and test workflows.

Returns:

The working directory to be used during build and test workflows.

toBuilder

public ImageRecipe.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ImageRecipe.Builder,ImageRecipe>

Returns:

a builder for type T

builder

public static ImageRecipe.Builder builder()

serializableBuilderClass

public static Class<? extends ImageRecipe.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.