/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.imagebuilder.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateComponentRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The name of the component. *
*/ private String name; /** ** The semantic version of the component. 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. *
** Describes the contents of the component. *
*/ private String description; /** ** 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. *
*/ private String changeDescription; /** ** The operating system platform of the component. *
*/ private String platform; /** ** The operating system (OS) version supported by the component. If the OS information is available, a prefix match * is performed against the base image OS version during image recipe creation. *
*/ private java.util.List
* Component data
contains inline YAML document content for the component. Alternatively, you can
* specify the uri
of a YAML document file stored in Amazon S3. However, you cannot specify both
* properties.
*
* 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.
*
* The ID of the KMS key that is used to encrypt this component. *
*/ private String kmsKeyId; /** ** The tags that apply to the component. *
*/ private java.util.Map* The idempotency token of the component. *
*/ private String clientToken; /** ** The name of the component. *
* * @param name * The name of the component. */ public void setName(String name) { this.name = name; } /** ** The name of the component. *
* * @return The name of the component. */ public String getName() { return this.name; } /** ** The name of the component. *
* * @param name * The name of the component. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateComponentRequest withName(String name) { setName(name); return this; } /** ** The semantic version of the component. 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. *
** 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 setSemanticVersion(String semanticVersion) { this.semanticVersion = semanticVersion; } /** ** The semantic version of the component. 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. *
** 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() { return this.semanticVersion; } /** ** The semantic version of the component. 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. *
** 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. *
* @return Returns a reference to this object so that method calls can be chained together. */ public CreateComponentRequest withSemanticVersion(String semanticVersion) { setSemanticVersion(semanticVersion); return this; } /** ** Describes the contents of the component. *
* * @param description * Describes the contents of the component. */ public void setDescription(String description) { this.description = description; } /** ** Describes the contents of the component. *
* * @return Describes the contents of the component. */ public String getDescription() { return this.description; } /** ** Describes the contents of the component. *
* * @param description * Describes the contents of the component. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateComponentRequest withDescription(String description) { setDescription(description); return this; } /** ** 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. *
* * @param 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. */ public void setChangeDescription(String changeDescription) { this.changeDescription = 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. *
* * @return 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. */ public String getChangeDescription() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateComponentRequest withChangeDescription(String changeDescription) { setChangeDescription(changeDescription); return this; } /** ** The operating system platform of the component. *
* * @param platform * The operating system platform of the component. * @see Platform */ public void setPlatform(String platform) { this.platform = platform; } /** ** The operating system platform of the component. *
* * @return The operating system platform of the component. * @see Platform */ public String getPlatform() { return this.platform; } /** ** The operating system platform of the component. *
* * @param platform * The operating system platform of the component. * @return Returns a reference to this object so that method calls can be chained together. * @see Platform */ public CreateComponentRequest withPlatform(String platform) { setPlatform(platform); return this; } /** ** The operating system platform of the component. *
* * @param platform * The operating system platform of the component. * @return Returns a reference to this object so that method calls can be chained together. * @see Platform */ public CreateComponentRequest withPlatform(Platform platform) { this.platform = platform.toString(); return this; } /** ** The operating system (OS) version supported by the component. If the OS information is available, a prefix match * is performed against the base image OS version during image recipe creation. *
* * @return The operating system (OS) version supported by the component. If the OS information is available, a * prefix match is performed against the base image OS version during image recipe creation. */ public java.util.List* The operating system (OS) version supported by the component. If the OS information is available, a prefix match * is performed against the base image OS version during image recipe creation. *
* * @param supportedOsVersions * The operating system (OS) version supported by the component. If the OS information is available, a prefix * match is performed against the base image OS version during image recipe creation. */ public void setSupportedOsVersions(java.util.Collection* The operating system (OS) version supported by the component. If the OS information is available, a prefix match * is performed against the base image OS version during image recipe creation. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setSupportedOsVersions(java.util.Collection)} or {@link #withSupportedOsVersions(java.util.Collection)} * if you want to override the existing values. *
* * @param supportedOsVersions * The operating system (OS) version supported by the component. If the OS information is available, a prefix * match is performed against the base image OS version during image recipe creation. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateComponentRequest withSupportedOsVersions(String... supportedOsVersions) { if (this.supportedOsVersions == null) { setSupportedOsVersions(new java.util.ArrayList* The operating system (OS) version supported by the component. If the OS information is available, a prefix match * is performed against the base image OS version during image recipe creation. *
* * @param supportedOsVersions * The operating system (OS) version supported by the component. If the OS information is available, a prefix * match is performed against the base image OS version during image recipe creation. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateComponentRequest withSupportedOsVersions(java.util.Collection
* Component data
contains inline YAML document content for the component. Alternatively, you can
* specify the uri
of a YAML document file stored in Amazon S3. However, you cannot specify both
* properties.
*
data
contains inline YAML document content for the component. Alternatively, you
* can specify the uri
of a YAML document file stored in Amazon S3. However, you cannot specify
* both properties.
*/
public void setData(String data) {
this.data = data;
}
/**
*
* Component data
contains inline YAML document content for the component. Alternatively, you can
* specify the uri
of a YAML document file stored in Amazon S3. However, you cannot specify both
* properties.
*
data
contains inline YAML document content for the component. Alternatively, you
* can specify the uri
of a YAML document file stored in Amazon S3. However, you cannot specify
* both properties.
*/
public String getData() {
return this.data;
}
/**
*
* Component data
contains inline YAML document content for the component. Alternatively, you can
* specify the uri
of a YAML document file stored in Amazon S3. However, you cannot specify both
* properties.
*
data
contains inline YAML document content for the component. Alternatively, you
* can specify the uri
of a YAML document file stored in Amazon S3. However, you cannot specify
* both properties.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentRequest withData(String data) {
setData(data);
return this;
}
/**
*
* 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 void setUri(String uri) {
this.uri = 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
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() {
return this.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
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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentRequest withUri(String uri) {
setUri(uri);
return this;
}
/**
*
* The ID of the KMS key that is used to encrypt this component. *
* * @param kmsKeyId * The ID of the KMS key that is used to encrypt this component. */ public void setKmsKeyId(String kmsKeyId) { this.kmsKeyId = kmsKeyId; } /** ** The ID of the KMS key that is used to encrypt this component. *
* * @return The ID of the KMS key that is used to encrypt this component. */ public String getKmsKeyId() { return this.kmsKeyId; } /** ** The ID of the KMS key that is used to encrypt this component. *
* * @param kmsKeyId * The ID of the KMS key that is used to encrypt this component. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateComponentRequest withKmsKeyId(String kmsKeyId) { setKmsKeyId(kmsKeyId); return this; } /** ** The tags that apply to the component. *
* * @return The tags that apply to the component. */ public java.util.Map* The tags that apply to the component. *
* * @param tags * The tags that apply to the component. */ public void setTags(java.util.Map* The tags that apply to the component. *
* * @param tags * The tags that apply to the component. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateComponentRequest withTags(java.util.Map* The idempotency token of the component. *
* * @param clientToken * The idempotency token of the component. */ public void setClientToken(String clientToken) { this.clientToken = clientToken; } /** ** The idempotency token of the component. *
* * @return The idempotency token of the component. */ public String getClientToken() { return this.clientToken; } /** ** The idempotency token of the component. *
* * @param clientToken * The idempotency token of the component. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateComponentRequest withClientToken(String clientToken) { setClientToken(clientToken); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getSemanticVersion() != null) sb.append("SemanticVersion: ").append(getSemanticVersion()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getChangeDescription() != null) sb.append("ChangeDescription: ").append(getChangeDescription()).append(","); if (getPlatform() != null) sb.append("Platform: ").append(getPlatform()).append(","); if (getSupportedOsVersions() != null) sb.append("SupportedOsVersions: ").append(getSupportedOsVersions()).append(","); if (getData() != null) sb.append("Data: ").append(getData()).append(","); if (getUri() != null) sb.append("Uri: ").append(getUri()).append(","); if (getKmsKeyId() != null) sb.append("KmsKeyId: ").append(getKmsKeyId()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()).append(","); if (getClientToken() != null) sb.append("ClientToken: ").append(getClientToken()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreateComponentRequest == false) return false; CreateComponentRequest other = (CreateComponentRequest) obj; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == false) return false; if (other.getSemanticVersion() == null ^ this.getSemanticVersion() == null) return false; if (other.getSemanticVersion() != null && other.getSemanticVersion().equals(this.getSemanticVersion()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getChangeDescription() == null ^ this.getChangeDescription() == null) return false; if (other.getChangeDescription() != null && other.getChangeDescription().equals(this.getChangeDescription()) == false) return false; if (other.getPlatform() == null ^ this.getPlatform() == null) return false; if (other.getPlatform() != null && other.getPlatform().equals(this.getPlatform()) == false) return false; if (other.getSupportedOsVersions() == null ^ this.getSupportedOsVersions() == null) return false; if (other.getSupportedOsVersions() != null && other.getSupportedOsVersions().equals(this.getSupportedOsVersions()) == false) return false; if (other.getData() == null ^ this.getData() == null) return false; if (other.getData() != null && other.getData().equals(this.getData()) == false) return false; if (other.getUri() == null ^ this.getUri() == null) return false; if (other.getUri() != null && other.getUri().equals(this.getUri()) == false) return false; if (other.getKmsKeyId() == null ^ this.getKmsKeyId() == null) return false; if (other.getKmsKeyId() != null && other.getKmsKeyId().equals(this.getKmsKeyId()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; if (other.getClientToken() == null ^ this.getClientToken() == null) return false; if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getSemanticVersion() == null) ? 0 : getSemanticVersion().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getChangeDescription() == null) ? 0 : getChangeDescription().hashCode()); hashCode = prime * hashCode + ((getPlatform() == null) ? 0 : getPlatform().hashCode()); hashCode = prime * hashCode + ((getSupportedOsVersions() == null) ? 0 : getSupportedOsVersions().hashCode()); hashCode = prime * hashCode + ((getData() == null) ? 0 : getData().hashCode()); hashCode = prime * hashCode + ((getUri() == null) ? 0 : getUri().hashCode()); hashCode = prime * hashCode + ((getKmsKeyId() == null) ? 0 : getKmsKeyId().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode()); return hashCode; } @Override public CreateComponentRequest clone() { return (CreateComponentRequest) super.clone(); } }