ImageBuilder (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.appstream.model.ImageBuilder

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ImageBuilder.Builder,ImageBuilder>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class ImageBuilder
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ImageBuilder.Builder,ImageBuilder>
```
Describes a streaming instance used for editing an image. New images are created from a snapshot through an image builder.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ImageBuilder.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`appstreamAgentVersion()` The version of the AppStream 2.0 agent that is currently being used by this image builder.
`String`	`arn()` The ARN for the image builder.
`static ImageBuilder.Builder`	`builder()`
`Instant`	`createdTime()` The time stamp when the image builder was created.
`String`	`description()` The description for display.
`String`	`displayName()` The image builder name for display.
`DomainJoinInfo`	`domainJoinInfo()` The information needed to join a Microsoft Active Directory domain.
`Boolean`	`enableDefaultInternetAccess()` Enables or disables default internet access for the image builder.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`imageArn()` The ARN of the image from which this builder was created.
`List<ResourceError>`	`imageBuilderErrors()` The image builder errors.
`String`	`instanceType()` The instance type for the image builder.
`String`	`name()` The name of the image builder.
`PlatformType`	`platform()` The operating system platform of the image builder.
`String`	`platformAsString()` The operating system platform of the image builder.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ImageBuilder.Builder>`	`serializableBuilderClass()`
`ImageBuilderState`	`state()` The state of the image builder.
`String`	`stateAsString()` The state of the image builder.
`ImageBuilderStateChangeReason`	`stateChangeReason()` The reason why the last state change occurred.
`ImageBuilder.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`VpcConfig`	`vpcConfig()` The VPC configuration of the image builder.

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
  - name
```
public String name()
```
    The name of the image builder.
    
    Returns:
    
    The name of the image builder.
  - arn
```
public String arn()
```
    The ARN for the image builder.
    
    Returns:
    
    The ARN for the image builder.
  - imageArn
```
public String imageArn()
```
    The ARN of the image from which this builder was created.
    
    Returns:
    
    The ARN of the image from which this builder was created.
  - description
```
public String description()
```
    The description for display.
    
    Returns:
    
    The description for display.
  - displayName
```
public String displayName()
```
    The image builder name for display.
    
    Returns:
    
    The image builder name for display.
  - vpcConfig
```
public VpcConfig vpcConfig()
```
    The VPC configuration of the image builder.
    
    Returns:
    
    The VPC configuration of the image builder.
  - instanceType
```
public String instanceType()
```
    The instance type for the image builder.
    
    Returns:
    
    The instance type for the image builder.
  - platform
```
public PlatformType platform()
```
    The operating system platform of the image builder.
    
    If the service returns an enum value that is not available in the current SDK version, platform will return PlatformType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().
    
    Returns:
    
    The operating system platform of the image builder.
    
    See Also:
    
    PlatformType
  - platformAsString
```
public String platformAsString()
```
    The operating system platform of the image builder.
    
    If the service returns an enum value that is not available in the current SDK version, platform will return PlatformType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().
    
    Returns:
    
    The operating system platform of the image builder.
    
    See Also:
    
    PlatformType
  - state
```
public ImageBuilderState state()
```
    The state of the image builder.
    
    If the service returns an enum value that is not available in the current SDK version, state will return ImageBuilderState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the image builder.
    
    See Also:
    
    ImageBuilderState
  - stateAsString
```
public String stateAsString()
```
    The state of the image builder.
    
    If the service returns an enum value that is not available in the current SDK version, state will return ImageBuilderState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the image builder.
    
    See Also:
    
    ImageBuilderState
  - stateChangeReason
```
public ImageBuilderStateChangeReason stateChangeReason()
```
    The reason why the last state change occurred.
    
    Returns:
    
    The reason why the last state change occurred.
  - createdTime
```
public Instant createdTime()
```
    The time stamp when the image builder was created.
    
    Returns:
    
    The time stamp when the image builder was created.
  - enableDefaultInternetAccess
```
public Boolean enableDefaultInternetAccess()
```
    Enables or disables default internet access for the image builder.
    
    Returns:
    
    Enables or disables default internet access for the image builder.
  - domainJoinInfo
```
public DomainJoinInfo domainJoinInfo()
```
    The information needed to join a Microsoft Active Directory domain.
    
    Returns:
    
    The information needed to join a Microsoft Active Directory domain.
  - imageBuilderErrors
```
public List<ResourceError> imageBuilderErrors()
```
    The image builder errors.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The image builder errors.
  - appstreamAgentVersion
```
public String appstreamAgentVersion()
```
    The version of the AppStream 2.0 agent that is currently being used by this image builder.
    
    Returns:
    
    The version of the AppStream 2.0 agent that is currently being used by this image builder.
  - toBuilder
```
public ImageBuilder.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<ImageBuilder.Builder,ImageBuilder>
    
    Returns:
    
    a builder for type T
  - builder
```
public static ImageBuilder.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ImageBuilder.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    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.

Class ImageBuilder

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

arn

imageArn

description

displayName

vpcConfig

instanceType

platform

platformAsString

state

stateAsString

stateChangeReason

createdTime

enableDefaultInternetAccess

domainJoinInfo

imageBuilderErrors

appstreamAgentVersion

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields