com.amazonaws.services.imagebuilder.model

Class CreateComponentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.imagebuilder.model.CreateComponentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateComponentRequest
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
CreateComponentRequest()

Method Summary

Modifier and Type	Method and Description
CreateComponentRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateComponentRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateComponentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getChangeDescription() The change description of the component.
String	getClientToken() The idempotency token of the component.
String	getData() The data of the component.
String	getDescription() The description of the component.
String	getKmsKeyId() The ID of the KMS key that should be used to encrypt this component.
String	getName() The name of the component.
String	getPlatform() The platform of the component.
String	getSemanticVersion() The semantic version of the component.
List<String>	getSupportedOsVersions() The operating system (OS) version supported by the component.
Map<String,String>	getTags() The tags of the component.
String	getUri() The uri of the component.
int	hashCode()
void	setChangeDescription(String changeDescription) The change description of the component.
void	setClientToken(String clientToken) The idempotency token of the component.
void	setData(String data) The data of the component.
void	setDescription(String description) The description of the component.
void	setKmsKeyId(String kmsKeyId) The ID of the KMS key that should be used to encrypt this component.
void	setName(String name) The name of the component.
void	setPlatform(String platform) The platform of the component.
void	setSemanticVersion(String semanticVersion) The semantic version of the component.
void	setSupportedOsVersions(Collection<String> supportedOsVersions) The operating system (OS) version supported by the component.
void	setTags(Map<String,String> tags) The tags of the component.
void	setUri(String uri) The uri of the component.
String	toString() Returns a string representation of this object.
CreateComponentRequest	withChangeDescription(String changeDescription) The change description of the component.
CreateComponentRequest	withClientToken(String clientToken) The idempotency token of the component.
CreateComponentRequest	withData(String data) The data of the component.
CreateComponentRequest	withDescription(String description) The description of the component.
CreateComponentRequest	withKmsKeyId(String kmsKeyId) The ID of the KMS key that should be used to encrypt this component.
CreateComponentRequest	withName(String name) The name of the component.
CreateComponentRequest	withPlatform(Platform platform) The platform of the component.
CreateComponentRequest	withPlatform(String platform) The platform of the component.
CreateComponentRequest	withSemanticVersion(String semanticVersion) The semantic version of the component.
CreateComponentRequest	withSupportedOsVersions(Collection<String> supportedOsVersions) The operating system (OS) version supported by the component.
CreateComponentRequest	withSupportedOsVersions(String... supportedOsVersions) The operating system (OS) version supported by the component.
CreateComponentRequest	withTags(Map<String,String> tags) The tags of the component.
CreateComponentRequest	withUri(String uri) The uri of the component.

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

CreateComponentRequest

public CreateComponentRequest()

Method Detail

setName

public void setName(String name)

The name of the component.

Parameters:

name - The name of the component.

getName

public String getName()

The name of the component.

Returns:

The name of the component.

withName

public CreateComponentRequest withName(String name)

The name of the component.

Parameters:

name - The name of the component.

Returns:

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

setSemanticVersion

public void setSemanticVersion(String semanticVersion)

The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).

Parameters:

semanticVersion - The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).

getSemanticVersion

public String getSemanticVersion()

The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).

Returns:

The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).

withSemanticVersion

public CreateComponentRequest withSemanticVersion(String semanticVersion)

The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).

Parameters:

semanticVersion - The semantic version of the component. This version follows the semantic version syntax. For example, major.minor.patch. This could be versioned like software (2.0.1) or like a date (2019.12.01).

Returns:

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

setDescription

public void setDescription(String description)

The description of the component. Describes the contents of the component.

Parameters:

description - The description of the component. Describes the contents of the component.

getDescription

public String getDescription()

The description of the component. Describes the contents of the component.

Returns:

The description of the component. Describes the contents of the component.

withDescription

public CreateComponentRequest withDescription(String description)

The description of the component. Describes the contents of the component.

Parameters:

description - The description of the component. Describes the contents of the component.

Returns:

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

setChangeDescription

public void setChangeDescription(String changeDescription)

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

Parameters:

changeDescription - The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

getChangeDescription

public String getChangeDescription()

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

Returns:

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

withChangeDescription

public CreateComponentRequest withChangeDescription(String changeDescription)

The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

Parameters:

changeDescription - The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of this component.

Returns:

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

setPlatform

public void setPlatform(String platform)

The platform of the component.

Parameters:

platform - The platform of the component.

See Also:

Platform

getPlatform

public String getPlatform()

The platform of the component.

Returns:

The platform of the component.

See Also:

Platform

withPlatform

public CreateComponentRequest withPlatform(String platform)

The platform of the component.

Parameters:

platform - The platform of the component.

Returns:

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

See Also:

Platform

withPlatform

public CreateComponentRequest withPlatform(Platform platform)

The platform of the component.

Parameters:

platform - The platform of the component.

Returns:

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

See Also:

Platform

getSupportedOsVersions

public List<String> getSupportedOsVersions()

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.

Returns:

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.

setSupportedOsVersions

public void setSupportedOsVersions(Collection<String> supportedOsVersions)

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.

Parameters:

supportedOsVersions - The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.

withSupportedOsVersions

public CreateComponentRequest withSupportedOsVersions(String... supportedOsVersions)

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.

NOTE: This method appends the values to the existing list (if any). Use setSupportedOsVersions(java.util.Collection) or withSupportedOsVersions(java.util.Collection) if you want to override the existing values.

Parameters:

supportedOsVersions - The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.

Returns:

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

withSupportedOsVersions

public CreateComponentRequest withSupportedOsVersions(Collection<String> supportedOsVersions)

The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.

Parameters:

supportedOsVersions - The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the parent image OS version during image recipe creation.

Returns:

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

setData

public void setData(String data)

The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

Parameters:

data - The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

getData

public String getData()

The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

Returns:

The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

withData

public CreateComponentRequest withData(String data)

The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

Parameters:

data - The data of the component. Used to specify the data inline. Either data or uri can be used to specify the data within the component.

Returns:

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

setUri

public void setUri(String uri)

The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

Parameters:

uri - The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

getUri

public String getUri()

The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

Returns:

The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

withUri

public CreateComponentRequest withUri(String uri)

The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

Parameters:

uri - The uri of the component. Must be an S3 URL and the requester must have permission to access the S3 bucket. If you use S3, you can specify component content up to your service quota. Either data or uri can be used to specify the data within the component.

Returns:

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

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

The ID of the KMS key that should be used to encrypt this component.

Parameters:

kmsKeyId - The ID of the KMS key that should be used to encrypt this component.

getKmsKeyId

public String getKmsKeyId()

The ID of the KMS key that should be used to encrypt this component.

Returns:

The ID of the KMS key that should be used to encrypt this component.

withKmsKeyId

public CreateComponentRequest withKmsKeyId(String kmsKeyId)

The ID of the KMS key that should be used to encrypt this component.

Parameters:

kmsKeyId - The ID of the KMS key that should be used to encrypt this component.

Returns:

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

getTags

public Map<String,String> getTags()

The tags of the component.

Returns:

The tags of the component.

setTags

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

The tags of the component.

Parameters:

tags - The tags of the component.

withTags

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

The tags of the component.

Parameters:

tags - The tags of the component.

Returns:

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

addTagsEntry

public CreateComponentRequest addTagsEntry(String key,
                                           String value)

Add a single Tags entry

See Also:

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

clearTagsEntries

public CreateComponentRequest 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)

The idempotency token of the component.

Parameters:

clientToken - The idempotency token of the component.

getClientToken

public String getClientToken()

The idempotency token of the component.

Returns:

The idempotency token of the component.

withClientToken

public CreateComponentRequest withClientToken(String clientToken)

The idempotency token of the component.

Parameters:

clientToken - The idempotency token of the component.

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 CreateComponentRequest 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()