software.amazon.awssdk.services.imagebuilder.model

Class UpdateImagePipelineRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.imagebuilder.model.ImagebuilderRequest

software.amazon.awssdk.services.imagebuilder.model.UpdateImagePipelineRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateImagePipelineRequest.Builder,UpdateImagePipelineRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class UpdateImagePipelineRequest
extends ImagebuilderRequest
implements ToCopyableBuilder<UpdateImagePipelineRequest.Builder,UpdateImagePipelineRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateImagePipelineRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateImagePipelineRequest.Builder	builder()
String	clientToken() The idempotency token used to make this request idempotent.
String	containerRecipeArn() The Amazon Resource Name (ARN) of the container pipeline to update.
String	description() The description of the image pipeline.
String	distributionConfigurationArn() The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by 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) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	imagePipelineArn() The Amazon Resource Name (ARN) of the image pipeline that you want to update.
String	imageRecipeArn() The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.
ImageTestsConfiguration	imageTestsConfiguration() The image test configuration of the image pipeline.
String	infrastructureConfigurationArn() The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.
Schedule	schedule() The schedule of the image pipeline.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateImagePipelineRequest.Builder>	serializableBuilderClass()
PipelineStatus	status() The status of the image pipeline.
String	statusAsString() The status of the image pipeline.
UpdateImagePipelineRequest.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 software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

imagePipelineArn

public final String imagePipelineArn()

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

Returns:

The Amazon Resource Name (ARN) of the image pipeline that you want to update.

description

public final String description()

The description of the image pipeline.

Returns:

The description of the image pipeline.

imageRecipeArn

public final String imageRecipeArn()

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.

Returns:

The Amazon Resource Name (ARN) of the image recipe that will be used to configure images updated by this image pipeline.

containerRecipeArn

public final String containerRecipeArn()

The Amazon Resource Name (ARN) of the container pipeline to update.

Returns:

The Amazon Resource Name (ARN) of the container pipeline to update.

infrastructureConfigurationArn

public final String infrastructureConfigurationArn()

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.

Returns:

The Amazon Resource Name (ARN) of the infrastructure configuration that will be used to build images updated by this image pipeline.

distributionConfigurationArn

public final String distributionConfigurationArn()

The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.

Returns:

The Amazon Resource Name (ARN) of the distribution configuration that will be used to configure and distribute images updated by this image pipeline.

imageTestsConfiguration

public final ImageTestsConfiguration imageTestsConfiguration()

The image test configuration of the image pipeline.

Returns:

The image test configuration of the image pipeline.

enhancedImageMetadataEnabled

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

schedule

public final Schedule schedule()

The schedule of the image pipeline.

Returns:

The schedule of the image pipeline.

status

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

clientToken

public final String clientToken()

The idempotency token used to make this request idempotent.

Returns:

The idempotency token used to make this request idempotent.

toBuilder

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

Specified by:

toBuilder in class ImagebuilderRequest

Returns:

a builder for type T

builder

public static UpdateImagePipelineRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.