ImageRecipe (AWS SDK for Java

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ImageRecipe.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`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 String arn()
```
    The Amazon Resource Name (ARN) of the image recipe.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the image recipe.
  - name
```
public String name()
```
    The name of the image recipe.
    
    Returns:
    
    The name of the image recipe.
  - description
```
public String description()
```
    The description of the image recipe.
    
    Returns:
    
    The description of the image recipe.
  - platform
```
public 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 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 String owner()
```
    The owner of the image recipe.
    
    Returns:
    
    The owner of the image recipe.
  - version
```
public String version()
```
    The version of the image recipe.
    
    Returns:
    
    The version of the image recipe.
  - hasComponents
```
public 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 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 String parentImage()
```
    The parent image of the image recipe.
    
    Returns:
    
    The parent image of the image recipe.
  - hasBlockDeviceMappings
```
public 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 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 String dateCreated()
```
    The date on which this image recipe was created.
    
    Returns:
    
    The date on which this image recipe was created.
  - 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 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 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 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.

AWS SDK for Java API Reference - 2.14.20

Class ImageRecipe

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

owner

version

hasComponents

components

parentImage

hasBlockDeviceMappings

blockDeviceMappings

dateCreated

hasTags

tags

workingDirectory

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

Copyright © 2020 Amazon Web Services, Inc. All Rights Reserved.