software.amazon.awssdk.services.imagebuilder.model

Class ImagePipeline

java.lang.Object

software.amazon.awssdk.services.imagebuilder.model.ImagePipeline

All Implemented Interfaces:

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

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

Details of an image pipeline.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImagePipeline.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) of the image pipeline.
static ImagePipeline.Builder	builder()
String	dateCreated() The date on which this image pipeline was created.
String	dateLastRun() The date on which this image pipeline was last run.
String	dateNextRun() The date on which this image pipeline will next be run.
String	dateUpdated() The date on which this image pipeline was last updated.
String	description() The description of the image pipeline.
String	distributionConfigurationArn() The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.
Boolean	enhancedImageMetadataEnabled() Collects additional information about the image being created, including the operating system (OS) version and package list.
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)
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	imageRecipeArn() The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
ImageTestsConfiguration	imageTestsConfiguration() The image tests configuration of the image pipeline.
String	infrastructureConfigurationArn() The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.
String	name() The name of the image pipeline.
Platform	platform() The platform of the image pipeline.
String	platformAsString() The platform of the image pipeline.
Schedule	schedule() The schedule of the image pipeline.
List<SdkField<?>>	sdkFields()
static Class<? extends ImagePipeline.Builder>	serializableBuilderClass()
PipelineStatus	status() The status of the image pipeline.
String	statusAsString() The status of the image pipeline.
Map<String,String>	tags() The tags of this image pipeline.
ImagePipeline.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.

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 String arn()

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

Returns:

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

name

public String name()

The name of the image pipeline.

Returns:

The name of the image pipeline.

description

public String description()

The description of the image pipeline.

Returns:

The description of the image pipeline.

platform

public Platform platform()

The platform of the image pipeline.

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 pipeline.

See Also:

Platform

platformAsString

public String platformAsString()

The platform of the image pipeline.

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 pipeline.

See Also:

Platform

enhancedImageMetadataEnabled

public Boolean enhancedImageMetadataEnabled()

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

Returns:

Collects additional information about the image being created, including the operating system (OS) version and package list. This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.

imageRecipeArn

public String imageRecipeArn()

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

Returns:

The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.

infrastructureConfigurationArn

public String infrastructureConfigurationArn()

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

Returns:

The Amazon Resource Name (ARN) of the infrastructure configuration associated with this image pipeline.

distributionConfigurationArn

public String distributionConfigurationArn()

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

Returns:

The Amazon Resource Name (ARN) of the distribution configuration associated with this image pipeline.

imageTestsConfiguration

public ImageTestsConfiguration imageTestsConfiguration()

The image tests configuration of the image pipeline.

Returns:

The image tests configuration of the image pipeline.

schedule

public Schedule schedule()

The schedule of the image pipeline.

Returns:

The schedule of the image pipeline.

status

public PipelineStatus status()

The status of the image pipeline.

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

Returns:

The status of the image pipeline.

See Also:

PipelineStatus

statusAsString

public String statusAsString()

The status of the image pipeline.

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

Returns:

The status of the image pipeline.

See Also:

PipelineStatus

dateCreated

public String dateCreated()

The date on which this image pipeline was created.

Returns:

The date on which this image pipeline was created.

dateUpdated

public String dateUpdated()

The date on which this image pipeline was last updated.

Returns:

The date on which this image pipeline was last updated.

dateLastRun

public String dateLastRun()

The date on which this image pipeline was last run.

Returns:

The date on which this image pipeline was last run.

dateNextRun

public String dateNextRun()

The date on which this image pipeline will next be run.

Returns:

The date on which this image pipeline will next be run.

hasTags

public 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 Map<String,String> tags()

The tags of this image pipeline.

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 this image pipeline.

toBuilder

public ImagePipeline.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<ImagePipeline.Builder,ImagePipeline>

Returns:

a builder for type T

builder

public static ImagePipeline.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public 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 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.