ImageBuilder (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.appstream.model.ImageBuilder

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ImageBuilder
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes a streaming instance used for editing an image. New images are created from a snapshot through an image builder.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ImageBuilder()

Constructors
Constructor and Description
`ImageBuilder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ImageBuilder`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAppstreamAgentVersion()` The version of the AppStream 2.0 agent that is currently being used by this image builder.
`String`	`getArn()` The ARN for the image builder.
`Date`	`getCreatedTime()` The time stamp when the image builder was created.
`String`	`getDescription()` The description for display.
`String`	`getDisplayName()` The image builder name for display.
`DomainJoinInfo`	`getDomainJoinInfo()` The information needed to join a Microsoft Active Directory domain.
`Boolean`	`getEnableDefaultInternetAccess()` Enables or disables default internet access for the image builder.
`String`	`getImageArn()` The ARN of the image from which this builder was created.
`List<ResourceError>`	`getImageBuilderErrors()` The image builder errors.
`String`	`getInstanceType()` The instance type for the image builder.
`String`	`getName()` The name of the image builder.
`String`	`getPlatform()` The operating system platform of the image builder.
`String`	`getState()` The state of the image builder.
`ImageBuilderStateChangeReason`	`getStateChangeReason()` The reason why the last state change occurred.
`VpcConfig`	`getVpcConfig()` The VPC configuration of the image builder.
`int`	`hashCode()`
`Boolean`	`isEnableDefaultInternetAccess()` Enables or disables default internet access for the image builder.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAppstreamAgentVersion(String appstreamAgentVersion)` The version of the AppStream 2.0 agent that is currently being used by this image builder.
`void`	`setArn(String arn)` The ARN for the image builder.
`void`	`setCreatedTime(Date createdTime)` The time stamp when the image builder was created.
`void`	`setDescription(String description)` The description for display.
`void`	`setDisplayName(String displayName)` The image builder name for display.
`void`	`setDomainJoinInfo(DomainJoinInfo domainJoinInfo)` The information needed to join a Microsoft Active Directory domain.
`void`	`setEnableDefaultInternetAccess(Boolean enableDefaultInternetAccess)` Enables or disables default internet access for the image builder.
`void`	`setImageArn(String imageArn)` The ARN of the image from which this builder was created.
`void`	`setImageBuilderErrors(Collection<ResourceError> imageBuilderErrors)` The image builder errors.
`void`	`setInstanceType(String instanceType)` The instance type for the image builder.
`void`	`setName(String name)` The name of the image builder.
`void`	`setPlatform(String platform)` The operating system platform of the image builder.
`void`	`setState(String state)` The state of the image builder.
`void`	`setStateChangeReason(ImageBuilderStateChangeReason stateChangeReason)` The reason why the last state change occurred.
`void`	`setVpcConfig(VpcConfig vpcConfig)` The VPC configuration of the image builder.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ImageBuilder`	`withAppstreamAgentVersion(String appstreamAgentVersion)` The version of the AppStream 2.0 agent that is currently being used by this image builder.
`ImageBuilder`	`withArn(String arn)` The ARN for the image builder.
`ImageBuilder`	`withCreatedTime(Date createdTime)` The time stamp when the image builder was created.
`ImageBuilder`	`withDescription(String description)` The description for display.
`ImageBuilder`	`withDisplayName(String displayName)` The image builder name for display.
`ImageBuilder`	`withDomainJoinInfo(DomainJoinInfo domainJoinInfo)` The information needed to join a Microsoft Active Directory domain.
`ImageBuilder`	`withEnableDefaultInternetAccess(Boolean enableDefaultInternetAccess)` Enables or disables default internet access for the image builder.
`ImageBuilder`	`withImageArn(String imageArn)` The ARN of the image from which this builder was created.
`ImageBuilder`	`withImageBuilderErrors(Collection<ResourceError> imageBuilderErrors)` The image builder errors.
`ImageBuilder`	`withImageBuilderErrors(ResourceError... imageBuilderErrors)` The image builder errors.
`ImageBuilder`	`withInstanceType(String instanceType)` The instance type for the image builder.
`ImageBuilder`	`withName(String name)` The name of the image builder.
`ImageBuilder`	`withPlatform(PlatformType platform)` The operating system platform of the image builder.
`ImageBuilder`	`withPlatform(String platform)` The operating system platform of the image builder.
`ImageBuilder`	`withState(ImageBuilderState state)` The state of the image builder.
`ImageBuilder`	`withState(String state)` The state of the image builder.
`ImageBuilder`	`withStateChangeReason(ImageBuilderStateChangeReason stateChangeReason)` The reason why the last state change occurred.
`ImageBuilder`	`withVpcConfig(VpcConfig vpcConfig)` The VPC configuration of the image builder.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ImageBuilder
```
public ImageBuilder()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the image builder.
    
    Parameters:
    
    name - The name of the image builder.
  - getName
```
public String getName()
```
    The name of the image builder.
    
    Returns:
    
    The name of the image builder.
  - withName
```
public ImageBuilder withName(String name)
```
    The name of the image builder.
    
    Parameters:
    
    name - The name of the image builder.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The ARN for the image builder.
    
    Parameters:
    
    arn - The ARN for the image builder.
  - getArn
```
public String getArn()
```
    The ARN for the image builder.
    
    Returns:
    
    The ARN for the image builder.
  - withArn
```
public ImageBuilder withArn(String arn)
```
    The ARN for the image builder.
    
    Parameters:
    
    arn - The ARN for the image builder.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImageArn
```
public void setImageArn(String imageArn)
```
    The ARN of the image from which this builder was created.
    
    Parameters:
    
    imageArn - The ARN of the image from which this builder was created.
  - getImageArn
```
public String getImageArn()
```
    The ARN of the image from which this builder was created.
    
    Returns:
    
    The ARN of the image from which this builder was created.
  - withImageArn
```
public ImageBuilder withImageArn(String imageArn)
```
    The ARN of the image from which this builder was created.
    
    Parameters:
    
    imageArn - The ARN of the image from which this builder was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description for display.
    
    Parameters:
    
    description - The description for display.
  - getDescription
```
public String getDescription()
```
    The description for display.
    
    Returns:
    
    The description for display.
  - withDescription
```
public ImageBuilder withDescription(String description)
```
    The description for display.
    
    Parameters:
    
    description - The description for display.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    The image builder name for display.
    
    Parameters:
    
    displayName - The image builder name for display.
  - getDisplayName
```
public String getDisplayName()
```
    The image builder name for display.
    
    Returns:
    
    The image builder name for display.
  - withDisplayName
```
public ImageBuilder withDisplayName(String displayName)
```
    The image builder name for display.
    
    Parameters:
    
    displayName - The image builder name for display.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcConfig
```
public void setVpcConfig(VpcConfig vpcConfig)
```
    The VPC configuration of the image builder.
    
    Parameters:
    
    vpcConfig - The VPC configuration of the image builder.
  - getVpcConfig
```
public VpcConfig getVpcConfig()
```
    The VPC configuration of the image builder.
    
    Returns:
    
    The VPC configuration of the image builder.
  - withVpcConfig
```
public ImageBuilder withVpcConfig(VpcConfig vpcConfig)
```
    The VPC configuration of the image builder.
    
    Parameters:
    
    vpcConfig - The VPC configuration of the image builder.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceType
```
public void setInstanceType(String instanceType)
```
    The instance type for the image builder.
    
    Parameters:
    
    instanceType - The instance type for the image builder.
  - getInstanceType
```
public String getInstanceType()
```
    The instance type for the image builder.
    
    Returns:
    
    The instance type for the image builder.
  - withInstanceType
```
public ImageBuilder withInstanceType(String instanceType)
```
    The instance type for the image builder.
    
    Parameters:
    
    instanceType - The instance type for the image builder.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlatform
```
public void setPlatform(String platform)
```
    The operating system platform of the image builder.
    
    Parameters:
    
    platform - The operating system platform of the image builder.
    
    See Also:
    
    PlatformType
  - getPlatform
```
public String getPlatform()
```
    The operating system platform of the image builder.
    
    Returns:
    
    The operating system platform of the image builder.
    
    See Also:
    
    PlatformType
  - withPlatform
```
public ImageBuilder withPlatform(String platform)
```
    The operating system platform of the image builder.
    
    Parameters:
    
    platform - The operating system platform of the image builder.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformType
  - withPlatform
```
public ImageBuilder withPlatform(PlatformType platform)
```
    The operating system platform of the image builder.
    
    Parameters:
    
    platform - The operating system platform of the image builder.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformType
  - setState
```
public void setState(String state)
```
    The state of the image builder.
    
    Parameters:
    
    state - The state of the image builder.
    
    See Also:
    
    ImageBuilderState
  - getState
```
public String getState()
```
    The state of the image builder.
    
    Returns:
    
    The state of the image builder.
    
    See Also:
    
    ImageBuilderState
  - withState
```
public ImageBuilder withState(String state)
```
    The state of the image builder.
    
    Parameters:
    
    state - The state of the image builder.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ImageBuilderState
  - withState
```
public ImageBuilder withState(ImageBuilderState state)
```
    The state of the image builder.
    
    Parameters:
    
    state - The state of the image builder.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ImageBuilderState
  - setStateChangeReason
```
public void setStateChangeReason(ImageBuilderStateChangeReason stateChangeReason)
```
    The reason why the last state change occurred.
    
    Parameters:
    
    stateChangeReason - The reason why the last state change occurred.
  - getStateChangeReason
```
public ImageBuilderStateChangeReason getStateChangeReason()
```
    The reason why the last state change occurred.
    
    Returns:
    
    The reason why the last state change occurred.
  - withStateChangeReason
```
public ImageBuilder withStateChangeReason(ImageBuilderStateChangeReason stateChangeReason)
```
    The reason why the last state change occurred.
    
    Parameters:
    
    stateChangeReason - The reason why the last state change occurred.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedTime
```
public void setCreatedTime(Date createdTime)
```
    The time stamp when the image builder was created.
    
    Parameters:
    
    createdTime - The time stamp when the image builder was created.
  - getCreatedTime
```
public Date getCreatedTime()
```
    The time stamp when the image builder was created.
    
    Returns:
    
    The time stamp when the image builder was created.
  - withCreatedTime
```
public ImageBuilder withCreatedTime(Date createdTime)
```
    The time stamp when the image builder was created.
    
    Parameters:
    
    createdTime - The time stamp when the image builder was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnableDefaultInternetAccess
```
public void setEnableDefaultInternetAccess(Boolean enableDefaultInternetAccess)
```
    Enables or disables default internet access for the image builder.
    
    Parameters:
    
    enableDefaultInternetAccess - Enables or disables default internet access for the image builder.
  - getEnableDefaultInternetAccess
```
public Boolean getEnableDefaultInternetAccess()
```
    Enables or disables default internet access for the image builder.
    
    Returns:
    
    Enables or disables default internet access for the image builder.
  - withEnableDefaultInternetAccess
```
public ImageBuilder withEnableDefaultInternetAccess(Boolean enableDefaultInternetAccess)
```
    Enables or disables default internet access for the image builder.
    
    Parameters:
    
    enableDefaultInternetAccess - Enables or disables default internet access for the image builder.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableDefaultInternetAccess
```
public Boolean isEnableDefaultInternetAccess()
```
    Enables or disables default internet access for the image builder.
    
    Returns:
    
    Enables or disables default internet access for the image builder.
  - setDomainJoinInfo
```
public void setDomainJoinInfo(DomainJoinInfo domainJoinInfo)
```
    The information needed to join a Microsoft Active Directory domain.
    
    Parameters:
    
    domainJoinInfo - The information needed to join a Microsoft Active Directory domain.
  - getDomainJoinInfo
```
public DomainJoinInfo getDomainJoinInfo()
```
    The information needed to join a Microsoft Active Directory domain.
    
    Returns:
    
    The information needed to join a Microsoft Active Directory domain.
  - withDomainJoinInfo
```
public ImageBuilder withDomainJoinInfo(DomainJoinInfo domainJoinInfo)
```
    The information needed to join a Microsoft Active Directory domain.
    
    Parameters:
    
    domainJoinInfo - The information needed to join a Microsoft Active Directory domain.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getImageBuilderErrors
```
public List<ResourceError> getImageBuilderErrors()
```
    The image builder errors.
    
    Returns:
    
    The image builder errors.
  - setImageBuilderErrors
```
public void setImageBuilderErrors(Collection<ResourceError> imageBuilderErrors)
```
    The image builder errors.
    
    Parameters:
    
    imageBuilderErrors - The image builder errors.
  - withImageBuilderErrors
```
public ImageBuilder withImageBuilderErrors(ResourceError... imageBuilderErrors)
```
    The image builder errors.
    
    NOTE: This method appends the values to the existing list (if any). Use setImageBuilderErrors(java.util.Collection) or withImageBuilderErrors(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    imageBuilderErrors - The image builder errors.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withImageBuilderErrors
```
public ImageBuilder withImageBuilderErrors(Collection<ResourceError> imageBuilderErrors)
```
    The image builder errors.
    
    Parameters:
    
    imageBuilderErrors - The image builder errors.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAppstreamAgentVersion
```
public void setAppstreamAgentVersion(String appstreamAgentVersion)
```
    The version of the AppStream 2.0 agent that is currently being used by this image builder.
    
    Parameters:
    
    appstreamAgentVersion - The version of the AppStream 2.0 agent that is currently being used by this image builder.
  - getAppstreamAgentVersion
```
public String getAppstreamAgentVersion()
```
    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.
  - withAppstreamAgentVersion
```
public ImageBuilder withAppstreamAgentVersion(String appstreamAgentVersion)
```
    The version of the AppStream 2.0 agent that is currently being used by this image builder.
    
    Parameters:
    
    appstreamAgentVersion - The version of the AppStream 2.0 agent that is currently being used by this image builder.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ImageBuilder clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class ImageBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ImageBuilder

Method Detail

setName

getName

withName

setArn

getArn

withArn

setImageArn

getImageArn

withImageArn

setDescription

getDescription

withDescription

setDisplayName

getDisplayName

withDisplayName

setVpcConfig

getVpcConfig

withVpcConfig

setInstanceType

getInstanceType

withInstanceType

setPlatform

getPlatform

withPlatform

withPlatform

setState

getState

withState

withState

setStateChangeReason

getStateChangeReason

withStateChangeReason

setCreatedTime

getCreatedTime

withCreatedTime

setEnableDefaultInternetAccess

getEnableDefaultInternetAccess

withEnableDefaultInternetAccess

isEnableDefaultInternetAccess

setDomainJoinInfo

getDomainJoinInfo

withDomainJoinInfo

getImageBuilderErrors

setImageBuilderErrors

withImageBuilderErrors

withImageBuilderErrors

setAppstreamAgentVersion

getAppstreamAgentVersion

withAppstreamAgentVersion

toString

equals

hashCode

clone

marshall