java.lang.Object
- software.amazon.awssdk.services.imagebuilder.model.ImagePipeline

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<ImagePipeline.Builder,ImagePipeline>

@Generated("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 Description

static interface ImagePipeline.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`arn()`	The Amazon Resource Name (ARN) of the image pipeline.
`static ImagePipeline.Builder`	`builder()`
`String`	`containerRecipeArn()`	The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
`String`	`dateCreated()`	The date on which this image pipeline was created.
`String`	`dateLastRun()`	This is no longer supported, and does not return a value.
`String`	`dateNextRun()`	The next date when the pipeline is scheduled to 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)`
`String`	`executionRole()`	The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasWorkflows()`	For responses, this returns true if the service returned a value for the Workflows property.
`String`	`imageRecipeArn()`	The Amazon Resource Name (ARN) of the image recipe associated with this image pipeline.
`ImageScanningConfiguration`	`imageScanningConfiguration()`	Contains settings for vulnerability scans.
`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()`
`String`	`toString()`	Returns a string representation of this object.
`List<WorkflowConfiguration>`	`workflows()`	Contains the workflows that run for the image pipeline.

Methods inherited from class java.lang.Object
clone, finalize, 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 pipeline.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the image pipeline.
  - name
```
public final String name()
```
    The name of the image pipeline.
    
    Returns:
    
    The name of the image pipeline.
  - description
```
public final String description()
```
    The description of the image pipeline.
    
    Returns:
    
    The description of the image pipeline.
  - platform
```
public final 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 final 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 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.
  - imageRecipeArn
```
public final 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.
  - containerRecipeArn
```
public final String containerRecipeArn()
```
    The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the container recipe that is used for this pipeline.
  - infrastructureConfigurationArn
```
public final 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 final 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 final ImageTestsConfiguration imageTestsConfiguration()
```
    The image tests configuration of the image pipeline.
    
    Returns:
    
    The image tests configuration of the image pipeline.
  - 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
  - dateCreated
```
public final String dateCreated()
```
    The date on which this image pipeline was created.
    
    Returns:
    
    The date on which this image pipeline was created.
  - dateUpdated
```
public final 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 final String dateLastRun()
```
    This is no longer supported, and does not return a value.
    
    Returns:
    
    This is no longer supported, and does not return a value.
  - dateNextRun
```
public final String dateNextRun()
```
    The next date when the pipeline is scheduled to run.
    
    Returns:
    
    The next date when the pipeline is scheduled to run.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final Map<String,String> tags()
```
    The tags of this image pipeline.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    The tags of this image pipeline.
  - imageScanningConfiguration
```
public final ImageScanningConfiguration imageScanningConfiguration()
```
    Contains settings for vulnerability scans.
    
    Returns:
    
    Contains settings for vulnerability scans.
  - executionRole
```
public final String executionRole()
```
    The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
    
    Returns:
    
    The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.
  - hasWorkflows
```
public final boolean hasWorkflows()
```
    For responses, this returns true if the service returned a value for the Workflows property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - workflows
```
public final List<WorkflowConfiguration> workflows()
```
    Contains the workflows that run for the image pipeline.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasWorkflows() method.
    
    Returns:
    
    Contains the workflows that run for the image pipeline.
  - toBuilder
```
public ImagePipeline.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ImagePipeline.Builder,ImagePipeline>
  - builder
```
public static ImagePipeline.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ImagePipeline.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class ImagePipeline

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

name

description

platform

platformAsString

enhancedImageMetadataEnabled

imageRecipeArn

containerRecipeArn

infrastructureConfigurationArn

distributionConfigurationArn

imageTestsConfiguration

schedule

status

statusAsString

dateCreated

dateUpdated

dateLastRun

dateNextRun

hasTags

tags

imageScanningConfiguration

executionRole

hasWorkflows

workflows

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields