@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateWorkflowRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateWorkflowRequest() |
Modifier and Type | Method and Description |
---|---|
CreateWorkflowRequest |
addTagsEntry(String key,
String value)
Add a single Tags entry
|
CreateWorkflowRequest |
clearTagsEntries()
Removes all the entries added into Tags.
|
CreateWorkflowRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
String |
getChangeDescription()
Describes what change has been made in this version of the workflow, or what makes this version different from
other versions of the workflow.
|
String |
getClientToken()
Unique, case-sensitive identifier you provide to ensure idempotency of the request.
|
String |
getData()
Contains the UTF-8 encoded YAML document content for the workflow.
|
String |
getDescription()
Describes the workflow.
|
String |
getKmsKeyId()
The ID of the KMS key that is used to encrypt this workflow resource.
|
String |
getName()
The name of the workflow to create.
|
String |
getSemanticVersion()
The semantic version of this workflow resource.
|
Map<String,String> |
getTags()
Tags that apply to the workflow resource.
|
String |
getType()
The phase in the image build process for which the workflow resource is responsible.
|
String |
getUri()
The
uri of a YAML component document file. |
int |
hashCode() |
void |
setChangeDescription(String changeDescription)
Describes what change has been made in this version of the workflow, or what makes this version different from
other versions of the workflow.
|
void |
setClientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request.
|
void |
setData(String data)
Contains the UTF-8 encoded YAML document content for the workflow.
|
void |
setDescription(String description)
Describes the workflow.
|
void |
setKmsKeyId(String kmsKeyId)
The ID of the KMS key that is used to encrypt this workflow resource.
|
void |
setName(String name)
The name of the workflow to create.
|
void |
setSemanticVersion(String semanticVersion)
The semantic version of this workflow resource.
|
void |
setTags(Map<String,String> tags)
Tags that apply to the workflow resource.
|
void |
setType(String type)
The phase in the image build process for which the workflow resource is responsible.
|
void |
setUri(String uri)
The
uri of a YAML component document file. |
String |
toString()
Returns a string representation of this object.
|
CreateWorkflowRequest |
withChangeDescription(String changeDescription)
Describes what change has been made in this version of the workflow, or what makes this version different from
other versions of the workflow.
|
CreateWorkflowRequest |
withClientToken(String clientToken)
Unique, case-sensitive identifier you provide to ensure idempotency of the request.
|
CreateWorkflowRequest |
withData(String data)
Contains the UTF-8 encoded YAML document content for the workflow.
|
CreateWorkflowRequest |
withDescription(String description)
Describes the workflow.
|
CreateWorkflowRequest |
withKmsKeyId(String kmsKeyId)
The ID of the KMS key that is used to encrypt this workflow resource.
|
CreateWorkflowRequest |
withName(String name)
The name of the workflow to create.
|
CreateWorkflowRequest |
withSemanticVersion(String semanticVersion)
The semantic version of this workflow resource.
|
CreateWorkflowRequest |
withTags(Map<String,String> tags)
Tags that apply to the workflow resource.
|
CreateWorkflowRequest |
withType(String type)
The phase in the image build process for which the workflow resource is responsible.
|
CreateWorkflowRequest |
withType(WorkflowType type)
The phase in the image build process for which the workflow resource is responsible.
|
CreateWorkflowRequest |
withUri(String uri)
The
uri of a YAML component document file. |
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
public void setName(String name)
The name of the workflow to create.
name
- The name of the workflow to create.public String getName()
The name of the workflow to create.
public CreateWorkflowRequest withName(String name)
The name of the workflow to create.
name
- The name of the workflow to create.public void setSemanticVersion(String semanticVersion)
The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.
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.
semanticVersion
- The semantic version of this workflow resource. The semantic version syntax adheres to the following
rules. 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.
public String getSemanticVersion()
The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.
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.
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.
public CreateWorkflowRequest withSemanticVersion(String semanticVersion)
The semantic version of this workflow resource. The semantic version syntax adheres to the following rules.
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.
semanticVersion
- The semantic version of this workflow resource. The semantic version syntax adheres to the following
rules. 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.
public void setDescription(String description)
Describes the workflow.
description
- Describes the workflow.public String getDescription()
Describes the workflow.
public CreateWorkflowRequest withDescription(String description)
Describes the workflow.
description
- Describes the workflow.public void setChangeDescription(String changeDescription)
Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
changeDescription
- Describes what change has been made in this version of the workflow, or what makes this version different
from other versions of the workflow.public String getChangeDescription()
Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
public CreateWorkflowRequest withChangeDescription(String changeDescription)
Describes what change has been made in this version of the workflow, or what makes this version different from other versions of the workflow.
changeDescription
- Describes what change has been made in this version of the workflow, or what makes this version different
from other versions of the workflow.public void setData(String data)
Contains the UTF-8 encoded YAML document content for the workflow. Alternatively, you can specify the
uri
of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
data
- Contains the UTF-8 encoded YAML document content for the workflow. Alternatively, you can specify the
uri
of a YAML document file stored in Amazon S3. However, you cannot specify both properties.public String getData()
Contains the UTF-8 encoded YAML document content for the workflow. Alternatively, you can specify the
uri
of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
uri
of a YAML document file stored in Amazon S3. However, you cannot specify both
properties.public CreateWorkflowRequest withData(String data)
Contains the UTF-8 encoded YAML document content for the workflow. Alternatively, you can specify the
uri
of a YAML document file stored in Amazon S3. However, you cannot specify both properties.
data
- Contains the UTF-8 encoded YAML document content for the workflow. Alternatively, you can specify the
uri
of a YAML document file stored in Amazon S3. However, you cannot specify both properties.public void setUri(String uri)
The uri
of a YAML component document file. This must be an S3 URL (s3://bucket/key
),
and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can
specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data
property. You
cannot specify both properties.
uri
- The uri
of a YAML component document file. This must be an S3 URL (
s3://bucket/key
), and the requester must have permission to access the S3 bucket it points
to. If you use Amazon S3, you can specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data
property.
You cannot specify both properties.
public String getUri()
The uri
of a YAML component document file. This must be an S3 URL (s3://bucket/key
),
and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can
specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data
property. You
cannot specify both properties.
uri
of a YAML component document file. This must be an S3 URL (
s3://bucket/key
), and the requester must have permission to access the S3 bucket it points
to. If you use Amazon S3, you can specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data
property.
You cannot specify both properties.
public CreateWorkflowRequest withUri(String uri)
The uri
of a YAML component document file. This must be an S3 URL (s3://bucket/key
),
and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can
specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data
property. You
cannot specify both properties.
uri
- The uri
of a YAML component document file. This must be an S3 URL (
s3://bucket/key
), and the requester must have permission to access the S3 bucket it points
to. If you use Amazon S3, you can specify component content up to your service quota.
Alternatively, you can specify the YAML document inline, using the component data
property.
You cannot specify both properties.
public void setKmsKeyId(String kmsKeyId)
The ID of the KMS key that is used to encrypt this workflow resource.
kmsKeyId
- The ID of the KMS key that is used to encrypt this workflow resource.public String getKmsKeyId()
The ID of the KMS key that is used to encrypt this workflow resource.
public CreateWorkflowRequest withKmsKeyId(String kmsKeyId)
The ID of the KMS key that is used to encrypt this workflow resource.
kmsKeyId
- The ID of the KMS key that is used to encrypt this workflow resource.public Map<String,String> getTags()
Tags that apply to the workflow resource.
public void setTags(Map<String,String> tags)
Tags that apply to the workflow resource.
tags
- Tags that apply to the workflow resource.public CreateWorkflowRequest withTags(Map<String,String> tags)
Tags that apply to the workflow resource.
tags
- Tags that apply to the workflow resource.public CreateWorkflowRequest addTagsEntry(String key, String value)
public CreateWorkflowRequest clearTagsEntries()
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.
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.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.
public CreateWorkflowRequest 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.
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.public void setType(String type)
The phase in the image build process for which the workflow resource is responsible.
type
- The phase in the image build process for which the workflow resource is responsible.WorkflowType
public String getType()
The phase in the image build process for which the workflow resource is responsible.
WorkflowType
public CreateWorkflowRequest withType(String type)
The phase in the image build process for which the workflow resource is responsible.
type
- The phase in the image build process for which the workflow resource is responsible.WorkflowType
public CreateWorkflowRequest withType(WorkflowType type)
The phase in the image build process for which the workflow resource is responsible.
type
- The phase in the image build process for which the workflow resource is responsible.WorkflowType
public String toString()
toString
in class Object
Object.toString()
public CreateWorkflowRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()