com.amazonaws.services.imagebuilder.model

Class ImportVmImageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.imagebuilder.model.ImportVmImageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ImportVmImageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ImportVmImageRequest()

Method Summary

Modifier and Type	Method and Description
ImportVmImageRequest	addTagsEntry(String key, String value) Add a single Tags entry
ImportVmImageRequest	clearTagsEntries() Removes all the entries added into Tags.
ImportVmImageRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() Unique, case-sensitive identifier you provide to ensure idempotency of the request.
String	getDescription() The description for the base image that is created by the import process.
String	getName() The name of the base image that is created by the import process.
String	getOsVersion() The operating system version for the imported VM.
String	getPlatform() The operating system platform for the imported VM.
String	getSemanticVersion() The semantic version to attach to the base image that was created during the import process.
Map<String,String>	getTags() Tags that are attached to the import resources.
String	getVmImportTaskId() The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process.
int	hashCode()
void	setClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
void	setDescription(String description) The description for the base image that is created by the import process.
void	setName(String name) The name of the base image that is created by the import process.
void	setOsVersion(String osVersion) The operating system version for the imported VM.
void	setPlatform(String platform) The operating system platform for the imported VM.
void	setSemanticVersion(String semanticVersion) The semantic version to attach to the base image that was created during the import process.
void	setTags(Map<String,String> tags) Tags that are attached to the import resources.
void	setVmImportTaskId(String vmImportTaskId) The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process.
String	toString() Returns a string representation of this object.
ImportVmImageRequest	withClientToken(String clientToken) Unique, case-sensitive identifier you provide to ensure idempotency of the request.
ImportVmImageRequest	withDescription(String description) The description for the base image that is created by the import process.
ImportVmImageRequest	withName(String name) The name of the base image that is created by the import process.
ImportVmImageRequest	withOsVersion(String osVersion) The operating system version for the imported VM.
ImportVmImageRequest	withPlatform(Platform platform) The operating system platform for the imported VM.
ImportVmImageRequest	withPlatform(String platform) The operating system platform for the imported VM.
ImportVmImageRequest	withSemanticVersion(String semanticVersion) The semantic version to attach to the base image that was created during the import process.
ImportVmImageRequest	withTags(Map<String,String> tags) Tags that are attached to the import resources.
ImportVmImageRequest	withVmImportTaskId(String vmImportTaskId) The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImportVmImageRequest

public ImportVmImageRequest()

Method Detail

setName

public void setName(String name)

The name of the base image that is created by the import process.

Parameters:

name - The name of the base image that is created by the import process.

getName

public String getName()

The name of the base image that is created by the import process.

Returns:

The name of the base image that is created by the import process.

withName

public ImportVmImageRequest withName(String name)

The name of the base image that is created by the import process.

Parameters:

name - The name of the base image that is created by the import process.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSemanticVersion

public void setSemanticVersion(String semanticVersion)

The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Parameters:

semanticVersion - The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

getSemanticVersion

public String getSemanticVersion()

The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Returns:

The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

withSemanticVersion

public ImportVmImageRequest withSemanticVersion(String semanticVersion)

The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Parameters:

semanticVersion - The semantic version to attach to the base image that was created during the import process. This version follows the semantic version syntax.

The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

Assignment: For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.

Patterns: You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

The description for the base image that is created by the import process.

Parameters:

description - The description for the base image that is created by the import process.

getDescription

public String getDescription()

The description for the base image that is created by the import process.

Returns:

The description for the base image that is created by the import process.

withDescription

public ImportVmImageRequest withDescription(String description)

The description for the base image that is created by the import process.

Parameters:

description - The description for the base image that is created by the import process.

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 for the imported VM.

Parameters:

platform - The operating system platform for the imported VM.

See Also:

Platform

getPlatform

public String getPlatform()

The operating system platform for the imported VM.

Returns:

The operating system platform for the imported VM.

See Also:

Platform

withPlatform

public ImportVmImageRequest withPlatform(String platform)

The operating system platform for the imported VM.

Parameters:

platform - The operating system platform for the imported VM.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Platform

withPlatform

public ImportVmImageRequest withPlatform(Platform platform)

The operating system platform for the imported VM.

Parameters:

platform - The operating system platform for the imported VM.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Platform

setOsVersion

public void setOsVersion(String osVersion)

The operating system version for the imported VM.

Parameters:

osVersion - The operating system version for the imported VM.

getOsVersion

public String getOsVersion()

The operating system version for the imported VM.

Returns:

The operating system version for the imported VM.

withOsVersion

public ImportVmImageRequest withOsVersion(String osVersion)

The operating system version for the imported VM.

Parameters:

osVersion - The operating system version for the imported VM.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVmImportTaskId

public void setVmImportTaskId(String vmImportTaskId)

The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.

Parameters:

vmImportTaskId - The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.

getVmImportTaskId

public String getVmImportTaskId()

The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.

Returns:

The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.

withVmImportTaskId

public ImportVmImageRequest withVmImportTaskId(String vmImportTaskId)

The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.

Parameters:

vmImportTaskId - The importTaskId (API) or ImportTaskId (CLI) from the Amazon EC2 VM import process. Image Builder retrieves information from the import process to pull in the AMI that is created from the VM source as the base image for your recipe.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

Tags that are attached to the import resources.

Returns:

Tags that are attached to the import resources.

setTags

public void setTags(Map<String,String> tags)

Tags that are attached to the import resources.

Parameters:

tags - Tags that are attached to the import resources.

withTags

public ImportVmImageRequest withTags(Map<String,String> tags)

Tags that are attached to the import resources.

Parameters:

tags - Tags that are attached to the import resources.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public ImportVmImageRequest addTagsEntry(String key,
                                         String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public ImportVmImageRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String clientToken)

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Parameters:

clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

getClientToken

public String getClientToken()

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Returns:

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

withClientToken

public ImportVmImageRequest withClientToken(String clientToken)

Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

Parameters:

clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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 ImportVmImageRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()