com.amazonaws.services.proton.model.CreateComponentRequest Maven / Gradle / Ivy
/*
* Copyright 2019-2024 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.proton.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 client token for the created component.
*
*/
private String clientToken;
/**
*
* An optional customer-provided description of the component.
*
*/
private String description;
/**
*
* The name of the Proton environment that you want to associate this component with. You must specify this when you
* don't specify serviceInstanceName and serviceName.
*
*/
private String environmentName;
/**
*
* A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering
* engine for infrastructure that a custom component provisions.
*
*/
private String manifest;
/**
*
* The customer-provided name of the component.
*
*/
private String name;
/**
*
* The name of the service instance that you want to attach this component to. If you don't specify this, the
* component isn't attached to any service instance. Specify both serviceInstanceName and
* serviceName or neither of them.
*
*/
private String serviceInstanceName;
/**
*
* The name of the service that serviceInstanceName is associated with. If you don't specify this, the
* component isn't attached to any service instance. Specify both serviceInstanceName and
* serviceName or neither of them.
*
*/
private String serviceName;
/**
*
* The service spec that you want the component to use to access service inputs. Set this only when you attach the
* component to a service instance.
*
*/
private String serviceSpec;
/**
*
* An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
*
*
* For more information, see Proton
* resources and tagging in the Proton User Guide.
*
*/
private java.util.List tags;
/**
*
* A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
*
*
*
* Components support a single IaC file, even if you use Terraform as your template language.
*
*
*/
private String templateFile;
/**
*
* The client token for the created component.
*
*
* @param clientToken
* The client token for the created component.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* The client token for the created component.
*
*
* @return The client token for the created component.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* The client token for the created component.
*
*
* @param clientToken
* The client token for the created 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;
}
/**
*
* An optional customer-provided description of the component.
*
*
* @param description
* An optional customer-provided description of the component.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* An optional customer-provided description of the component.
*
*
* @return An optional customer-provided description of the component.
*/
public String getDescription() {
return this.description;
}
/**
*
* An optional customer-provided description of the component.
*
*
* @param description
* An optional customer-provided description 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 name of the Proton environment that you want to associate this component with. You must specify this when you
* don't specify serviceInstanceName and serviceName.
*
*
* @param environmentName
* The name of the Proton environment that you want to associate this component with. You must specify this
* when you don't specify serviceInstanceName and serviceName.
*/
public void setEnvironmentName(String environmentName) {
this.environmentName = environmentName;
}
/**
*
* The name of the Proton environment that you want to associate this component with. You must specify this when you
* don't specify serviceInstanceName and serviceName.
*
*
* @return The name of the Proton environment that you want to associate this component with. You must specify this
* when you don't specify serviceInstanceName and serviceName.
*/
public String getEnvironmentName() {
return this.environmentName;
}
/**
*
* The name of the Proton environment that you want to associate this component with. You must specify this when you
* don't specify serviceInstanceName and serviceName.
*
*
* @param environmentName
* The name of the Proton environment that you want to associate this component with. You must specify this
* when you don't specify serviceInstanceName and serviceName.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentRequest withEnvironmentName(String environmentName) {
setEnvironmentName(environmentName);
return this;
}
/**
*
* A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering
* engine for infrastructure that a custom component provisions.
*
*
* @param manifest
* A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and
* rendering engine for infrastructure that a custom component provisions.
*/
public void setManifest(String manifest) {
this.manifest = manifest;
}
/**
*
* A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering
* engine for infrastructure that a custom component provisions.
*
*
* @return A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and
* rendering engine for infrastructure that a custom component provisions.
*/
public String getManifest() {
return this.manifest;
}
/**
*
* A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and rendering
* engine for infrastructure that a custom component provisions.
*
*
* @param manifest
* A path to a manifest file that lists the Infrastructure as Code (IaC) file, template language, and
* rendering engine for infrastructure that a custom component provisions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentRequest withManifest(String manifest) {
setManifest(manifest);
return this;
}
/**
*
* The customer-provided name of the component.
*
*
* @param name
* The customer-provided name of the component.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The customer-provided name of the component.
*
*
* @return The customer-provided name of the component.
*/
public String getName() {
return this.name;
}
/**
*
* The customer-provided name of the component.
*
*
* @param name
* The customer-provided 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 name of the service instance that you want to attach this component to. If you don't specify this, the
* component isn't attached to any service instance. Specify both serviceInstanceName and
* serviceName or neither of them.
*
*
* @param serviceInstanceName
* The name of the service instance that you want to attach this component to. If you don't specify this, the
* component isn't attached to any service instance. Specify both serviceInstanceName and
* serviceName or neither of them.
*/
public void setServiceInstanceName(String serviceInstanceName) {
this.serviceInstanceName = serviceInstanceName;
}
/**
*
* The name of the service instance that you want to attach this component to. If you don't specify this, the
* component isn't attached to any service instance. Specify both serviceInstanceName and
* serviceName or neither of them.
*
*
* @return The name of the service instance that you want to attach this component to. If you don't specify this,
* the component isn't attached to any service instance. Specify both serviceInstanceName and
* serviceName or neither of them.
*/
public String getServiceInstanceName() {
return this.serviceInstanceName;
}
/**
*
* The name of the service instance that you want to attach this component to. If you don't specify this, the
* component isn't attached to any service instance. Specify both serviceInstanceName and
* serviceName or neither of them.
*
*
* @param serviceInstanceName
* The name of the service instance that you want to attach this component to. If you don't specify this, the
* component isn't attached to any service instance. Specify both serviceInstanceName and
* serviceName or neither of them.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentRequest withServiceInstanceName(String serviceInstanceName) {
setServiceInstanceName(serviceInstanceName);
return this;
}
/**
*
* The name of the service that serviceInstanceName is associated with. If you don't specify this, the
* component isn't attached to any service instance. Specify both serviceInstanceName and
* serviceName or neither of them.
*
*
* @param serviceName
* The name of the service that serviceInstanceName is associated with. If you don't specify
* this, the component isn't attached to any service instance. Specify both serviceInstanceName
* and serviceName or neither of them.
*/
public void setServiceName(String serviceName) {
this.serviceName = serviceName;
}
/**
*
* The name of the service that serviceInstanceName is associated with. If you don't specify this, the
* component isn't attached to any service instance. Specify both serviceInstanceName and
* serviceName or neither of them.
*
*
* @return The name of the service that serviceInstanceName is associated with. If you don't specify
* this, the component isn't attached to any service instance. Specify both serviceInstanceName
* and serviceName or neither of them.
*/
public String getServiceName() {
return this.serviceName;
}
/**
*
* The name of the service that serviceInstanceName is associated with. If you don't specify this, the
* component isn't attached to any service instance. Specify both serviceInstanceName and
* serviceName or neither of them.
*
*
* @param serviceName
* The name of the service that serviceInstanceName is associated with. If you don't specify
* this, the component isn't attached to any service instance. Specify both serviceInstanceName
* and serviceName or neither of them.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentRequest withServiceName(String serviceName) {
setServiceName(serviceName);
return this;
}
/**
*
* The service spec that you want the component to use to access service inputs. Set this only when you attach the
* component to a service instance.
*
*
* @param serviceSpec
* The service spec that you want the component to use to access service inputs. Set this only when you
* attach the component to a service instance.
*/
public void setServiceSpec(String serviceSpec) {
this.serviceSpec = serviceSpec;
}
/**
*
* The service spec that you want the component to use to access service inputs. Set this only when you attach the
* component to a service instance.
*
*
* @return The service spec that you want the component to use to access service inputs. Set this only when you
* attach the component to a service instance.
*/
public String getServiceSpec() {
return this.serviceSpec;
}
/**
*
* The service spec that you want the component to use to access service inputs. Set this only when you attach the
* component to a service instance.
*
*
* @param serviceSpec
* The service spec that you want the component to use to access service inputs. Set this only when you
* attach the component to a service instance.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentRequest withServiceSpec(String serviceSpec) {
setServiceSpec(serviceSpec);
return this;
}
/**
*
* An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
*
*
* For more information, see Proton
* resources and tagging in the Proton User Guide.
*
*
* @return An optional list of metadata items that you can associate with the Proton component. A tag is a key-value
* pair.
*
* For more information, see Proton resources and
* tagging in the Proton User Guide.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
*
*
* For more information, see Proton
* resources and tagging in the Proton User Guide.
*
*
* @param tags
* An optional list of metadata items that you can associate with the Proton component. A tag is a key-value
* pair.
*
* For more information, see Proton resources and tagging
* in the Proton User Guide.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
*
*
* For more information, see Proton
* resources and tagging in the Proton User Guide.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* An optional list of metadata items that you can associate with the Proton component. A tag is a key-value
* pair.
*
* For more information, see Proton resources and tagging
* in the Proton User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* An optional list of metadata items that you can associate with the Proton component. A tag is a key-value pair.
*
*
* For more information, see Proton
* resources and tagging in the Proton User Guide.
*
*
* @param tags
* An optional list of metadata items that you can associate with the Proton component. A tag is a key-value
* pair.
*
* For more information, see Proton resources and tagging
* in the Proton User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
*
*
*
* Components support a single IaC file, even if you use Terraform as your template language.
*
*
*
* @param templateFile
* A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component
* provisions.
*
* Components support a single IaC file, even if you use Terraform as your template language.
*
*/
public void setTemplateFile(String templateFile) {
this.templateFile = templateFile;
}
/**
*
* A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
*
*
*
* Components support a single IaC file, even if you use Terraform as your template language.
*
*
*
* @return A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component
* provisions.
*
* Components support a single IaC file, even if you use Terraform as your template language.
*
*/
public String getTemplateFile() {
return this.templateFile;
}
/**
*
* A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
*
*
*
* Components support a single IaC file, even if you use Terraform as your template language.
*
*
*
* @param templateFile
* A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component
* provisions.
*
* Components support a single IaC file, even if you use Terraform as your template language.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateComponentRequest withTemplateFile(String templateFile) {
setTemplateFile(templateFile);
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 (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getDescription() != null)
sb.append("Description: ").append("***Sensitive Data Redacted***").append(",");
if (getEnvironmentName() != null)
sb.append("EnvironmentName: ").append(getEnvironmentName()).append(",");
if (getManifest() != null)
sb.append("Manifest: ").append("***Sensitive Data Redacted***").append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getServiceInstanceName() != null)
sb.append("ServiceInstanceName: ").append(getServiceInstanceName()).append(",");
if (getServiceName() != null)
sb.append("ServiceName: ").append(getServiceName()).append(",");
if (getServiceSpec() != null)
sb.append("ServiceSpec: ").append("***Sensitive Data Redacted***").append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getTemplateFile() != null)
sb.append("TemplateFile: ").append("***Sensitive Data Redacted***");
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.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == 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.getEnvironmentName() == null ^ this.getEnvironmentName() == null)
return false;
if (other.getEnvironmentName() != null && other.getEnvironmentName().equals(this.getEnvironmentName()) == false)
return false;
if (other.getManifest() == null ^ this.getManifest() == null)
return false;
if (other.getManifest() != null && other.getManifest().equals(this.getManifest()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getServiceInstanceName() == null ^ this.getServiceInstanceName() == null)
return false;
if (other.getServiceInstanceName() != null && other.getServiceInstanceName().equals(this.getServiceInstanceName()) == false)
return false;
if (other.getServiceName() == null ^ this.getServiceName() == null)
return false;
if (other.getServiceName() != null && other.getServiceName().equals(this.getServiceName()) == false)
return false;
if (other.getServiceSpec() == null ^ this.getServiceSpec() == null)
return false;
if (other.getServiceSpec() != null && other.getServiceSpec().equals(this.getServiceSpec()) == 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.getTemplateFile() == null ^ this.getTemplateFile() == null)
return false;
if (other.getTemplateFile() != null && other.getTemplateFile().equals(this.getTemplateFile()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getEnvironmentName() == null) ? 0 : getEnvironmentName().hashCode());
hashCode = prime * hashCode + ((getManifest() == null) ? 0 : getManifest().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getServiceInstanceName() == null) ? 0 : getServiceInstanceName().hashCode());
hashCode = prime * hashCode + ((getServiceName() == null) ? 0 : getServiceName().hashCode());
hashCode = prime * hashCode + ((getServiceSpec() == null) ? 0 : getServiceSpec().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getTemplateFile() == null) ? 0 : getTemplateFile().hashCode());
return hashCode;
}
@Override
public CreateComponentRequest clone() {
return (CreateComponentRequest) super.clone();
}
}