
com.amazonaws.services.servicecatalog.model.ProvisioningArtifactDetail Maven / Gradle / Ivy
Show all versions of aws-java-sdk-servicecatalog Show documentation
/*
* Copyright 2020-2025 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.servicecatalog.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Information about a provisioning artifact (also known as a version) for a product.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ProvisioningArtifactDetail implements Serializable, Cloneable, StructuredPojo {
/**
*
* The identifier of the provisioning artifact.
*
*/
private String id;
/**
*
* The name of the provisioning artifact.
*
*/
private String name;
/**
*
* The description of the provisioning artifact.
*
*/
private String description;
/**
*
* The type of provisioning artifact.
*
*
* -
*
* CLOUD_FORMATION_TEMPLATE
- CloudFormation template
*
*
* -
*
* TERRAFORM_OPEN_SOURCE
- Terraform Open Source configuration file
*
*
* -
*
* TERRAFORM_CLOUD
- Terraform Cloud configuration file
*
*
* -
*
* EXTERNAL
- External configuration file
*
*
*
*/
private String type;
/**
*
* The UTC time stamp of the creation time.
*
*/
private java.util.Date createdTime;
/**
*
* Indicates whether the product version is active.
*
*/
private Boolean active;
/**
*
* Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
*
*/
private String guidance;
/**
*
* Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product
* and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to
* the existing ProvisioningArtifactDetail
type, which is returned as part of the response for
* CreateProduct
, UpdateProduct
, DescribeProductAsAdmin
,
* DescribeProvisioningArtifact
, ListProvisioningArtifact
, and
* UpdateProvisioningArticat
APIs.
*
*
* This field only exists for Repo-Synced products.
*
*/
private String sourceRevision;
/**
*
* The identifier of the provisioning artifact.
*
*
* @param id
* The identifier of the provisioning artifact.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* The identifier of the provisioning artifact.
*
*
* @return The identifier of the provisioning artifact.
*/
public String getId() {
return this.id;
}
/**
*
* The identifier of the provisioning artifact.
*
*
* @param id
* The identifier of the provisioning artifact.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProvisioningArtifactDetail withId(String id) {
setId(id);
return this;
}
/**
*
* The name of the provisioning artifact.
*
*
* @param name
* The name of the provisioning artifact.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the provisioning artifact.
*
*
* @return The name of the provisioning artifact.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the provisioning artifact.
*
*
* @param name
* The name of the provisioning artifact.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProvisioningArtifactDetail withName(String name) {
setName(name);
return this;
}
/**
*
* The description of the provisioning artifact.
*
*
* @param description
* The description of the provisioning artifact.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the provisioning artifact.
*
*
* @return The description of the provisioning artifact.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the provisioning artifact.
*
*
* @param description
* The description of the provisioning artifact.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProvisioningArtifactDetail withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The type of provisioning artifact.
*
*
* -
*
* CLOUD_FORMATION_TEMPLATE
- CloudFormation template
*
*
* -
*
* TERRAFORM_OPEN_SOURCE
- Terraform Open Source configuration file
*
*
* -
*
* TERRAFORM_CLOUD
- Terraform Cloud configuration file
*
*
* -
*
* EXTERNAL
- External configuration file
*
*
*
*
* @param type
* The type of provisioning artifact.
*
* -
*
* CLOUD_FORMATION_TEMPLATE
- CloudFormation template
*
*
* -
*
* TERRAFORM_OPEN_SOURCE
- Terraform Open Source configuration file
*
*
* -
*
* TERRAFORM_CLOUD
- Terraform Cloud configuration file
*
*
* -
*
* EXTERNAL
- External configuration file
*
*
* @see ProvisioningArtifactType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of provisioning artifact.
*
*
* -
*
* CLOUD_FORMATION_TEMPLATE
- CloudFormation template
*
*
* -
*
* TERRAFORM_OPEN_SOURCE
- Terraform Open Source configuration file
*
*
* -
*
* TERRAFORM_CLOUD
- Terraform Cloud configuration file
*
*
* -
*
* EXTERNAL
- External configuration file
*
*
*
*
* @return The type of provisioning artifact.
*
* -
*
* CLOUD_FORMATION_TEMPLATE
- CloudFormation template
*
*
* -
*
* TERRAFORM_OPEN_SOURCE
- Terraform Open Source configuration file
*
*
* -
*
* TERRAFORM_CLOUD
- Terraform Cloud configuration file
*
*
* -
*
* EXTERNAL
- External configuration file
*
*
* @see ProvisioningArtifactType
*/
public String getType() {
return this.type;
}
/**
*
* The type of provisioning artifact.
*
*
* -
*
* CLOUD_FORMATION_TEMPLATE
- CloudFormation template
*
*
* -
*
* TERRAFORM_OPEN_SOURCE
- Terraform Open Source configuration file
*
*
* -
*
* TERRAFORM_CLOUD
- Terraform Cloud configuration file
*
*
* -
*
* EXTERNAL
- External configuration file
*
*
*
*
* @param type
* The type of provisioning artifact.
*
* -
*
* CLOUD_FORMATION_TEMPLATE
- CloudFormation template
*
*
* -
*
* TERRAFORM_OPEN_SOURCE
- Terraform Open Source configuration file
*
*
* -
*
* TERRAFORM_CLOUD
- Terraform Cloud configuration file
*
*
* -
*
* EXTERNAL
- External configuration file
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProvisioningArtifactType
*/
public ProvisioningArtifactDetail withType(String type) {
setType(type);
return this;
}
/**
*
* The type of provisioning artifact.
*
*
* -
*
* CLOUD_FORMATION_TEMPLATE
- CloudFormation template
*
*
* -
*
* TERRAFORM_OPEN_SOURCE
- Terraform Open Source configuration file
*
*
* -
*
* TERRAFORM_CLOUD
- Terraform Cloud configuration file
*
*
* -
*
* EXTERNAL
- External configuration file
*
*
*
*
* @param type
* The type of provisioning artifact.
*
* -
*
* CLOUD_FORMATION_TEMPLATE
- CloudFormation template
*
*
* -
*
* TERRAFORM_OPEN_SOURCE
- Terraform Open Source configuration file
*
*
* -
*
* TERRAFORM_CLOUD
- Terraform Cloud configuration file
*
*
* -
*
* EXTERNAL
- External configuration file
*
*
* @see ProvisioningArtifactType
*/
public void setType(ProvisioningArtifactType type) {
withType(type);
}
/**
*
* The type of provisioning artifact.
*
*
* -
*
* CLOUD_FORMATION_TEMPLATE
- CloudFormation template
*
*
* -
*
* TERRAFORM_OPEN_SOURCE
- Terraform Open Source configuration file
*
*
* -
*
* TERRAFORM_CLOUD
- Terraform Cloud configuration file
*
*
* -
*
* EXTERNAL
- External configuration file
*
*
*
*
* @param type
* The type of provisioning artifact.
*
* -
*
* CLOUD_FORMATION_TEMPLATE
- CloudFormation template
*
*
* -
*
* TERRAFORM_OPEN_SOURCE
- Terraform Open Source configuration file
*
*
* -
*
* TERRAFORM_CLOUD
- Terraform Cloud configuration file
*
*
* -
*
* EXTERNAL
- External configuration file
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProvisioningArtifactType
*/
public ProvisioningArtifactDetail withType(ProvisioningArtifactType type) {
this.type = type.toString();
return this;
}
/**
*
* The UTC time stamp of the creation time.
*
*
* @param createdTime
* The UTC time stamp of the creation time.
*/
public void setCreatedTime(java.util.Date createdTime) {
this.createdTime = createdTime;
}
/**
*
* The UTC time stamp of the creation time.
*
*
* @return The UTC time stamp of the creation time.
*/
public java.util.Date getCreatedTime() {
return this.createdTime;
}
/**
*
* The UTC time stamp of the creation time.
*
*
* @param createdTime
* The UTC time stamp of the creation time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProvisioningArtifactDetail withCreatedTime(java.util.Date createdTime) {
setCreatedTime(createdTime);
return this;
}
/**
*
* Indicates whether the product version is active.
*
*
* @param active
* Indicates whether the product version is active.
*/
public void setActive(Boolean active) {
this.active = active;
}
/**
*
* Indicates whether the product version is active.
*
*
* @return Indicates whether the product version is active.
*/
public Boolean getActive() {
return this.active;
}
/**
*
* Indicates whether the product version is active.
*
*
* @param active
* Indicates whether the product version is active.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProvisioningArtifactDetail withActive(Boolean active) {
setActive(active);
return this;
}
/**
*
* Indicates whether the product version is active.
*
*
* @return Indicates whether the product version is active.
*/
public Boolean isActive() {
return this.active;
}
/**
*
* Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
*
*
* @param guidance
* Information set by the administrator to provide guidance to end users about which provisioning artifacts
* to use.
* @see ProvisioningArtifactGuidance
*/
public void setGuidance(String guidance) {
this.guidance = guidance;
}
/**
*
* Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
*
*
* @return Information set by the administrator to provide guidance to end users about which provisioning artifacts
* to use.
* @see ProvisioningArtifactGuidance
*/
public String getGuidance() {
return this.guidance;
}
/**
*
* Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
*
*
* @param guidance
* Information set by the administrator to provide guidance to end users about which provisioning artifacts
* to use.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProvisioningArtifactGuidance
*/
public ProvisioningArtifactDetail withGuidance(String guidance) {
setGuidance(guidance);
return this;
}
/**
*
* Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
*
*
* @param guidance
* Information set by the administrator to provide guidance to end users about which provisioning artifacts
* to use.
* @see ProvisioningArtifactGuidance
*/
public void setGuidance(ProvisioningArtifactGuidance guidance) {
withGuidance(guidance);
}
/**
*
* Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
*
*
* @param guidance
* Information set by the administrator to provide guidance to end users about which provisioning artifacts
* to use.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ProvisioningArtifactGuidance
*/
public ProvisioningArtifactDetail withGuidance(ProvisioningArtifactGuidance guidance) {
this.guidance = guidance.toString();
return this;
}
/**
*
* Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product
* and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to
* the existing ProvisioningArtifactDetail
type, which is returned as part of the response for
* CreateProduct
, UpdateProduct
, DescribeProductAsAdmin
,
* DescribeProvisioningArtifact
, ListProvisioningArtifact
, and
* UpdateProvisioningArticat
APIs.
*
*
* This field only exists for Repo-Synced products.
*
*
* @param sourceRevision
* Specifies the revision of the external artifact that was used to automatically sync the Service Catalog
* product and create the provisioning artifact. Service Catalog includes this response parameter as a high
* level field to the existing ProvisioningArtifactDetail
type, which is returned as part of the
* response for CreateProduct
, UpdateProduct
, DescribeProductAsAdmin
,
* DescribeProvisioningArtifact
, ListProvisioningArtifact
, and
* UpdateProvisioningArticat
APIs.
*
* This field only exists for Repo-Synced products.
*/
public void setSourceRevision(String sourceRevision) {
this.sourceRevision = sourceRevision;
}
/**
*
* Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product
* and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to
* the existing ProvisioningArtifactDetail
type, which is returned as part of the response for
* CreateProduct
, UpdateProduct
, DescribeProductAsAdmin
,
* DescribeProvisioningArtifact
, ListProvisioningArtifact
, and
* UpdateProvisioningArticat
APIs.
*
*
* This field only exists for Repo-Synced products.
*
*
* @return Specifies the revision of the external artifact that was used to automatically sync the Service Catalog
* product and create the provisioning artifact. Service Catalog includes this response parameter as a high
* level field to the existing ProvisioningArtifactDetail
type, which is returned as part of
* the response for CreateProduct
, UpdateProduct
,
* DescribeProductAsAdmin
, DescribeProvisioningArtifact
,
* ListProvisioningArtifact
, and UpdateProvisioningArticat
APIs.
*
* This field only exists for Repo-Synced products.
*/
public String getSourceRevision() {
return this.sourceRevision;
}
/**
*
* Specifies the revision of the external artifact that was used to automatically sync the Service Catalog product
* and create the provisioning artifact. Service Catalog includes this response parameter as a high level field to
* the existing ProvisioningArtifactDetail
type, which is returned as part of the response for
* CreateProduct
, UpdateProduct
, DescribeProductAsAdmin
,
* DescribeProvisioningArtifact
, ListProvisioningArtifact
, and
* UpdateProvisioningArticat
APIs.
*
*
* This field only exists for Repo-Synced products.
*
*
* @param sourceRevision
* Specifies the revision of the external artifact that was used to automatically sync the Service Catalog
* product and create the provisioning artifact. Service Catalog includes this response parameter as a high
* level field to the existing ProvisioningArtifactDetail
type, which is returned as part of the
* response for CreateProduct
, UpdateProduct
, DescribeProductAsAdmin
,
* DescribeProvisioningArtifact
, ListProvisioningArtifact
, and
* UpdateProvisioningArticat
APIs.
*
* This field only exists for Repo-Synced products.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ProvisioningArtifactDetail withSourceRevision(String sourceRevision) {
setSourceRevision(sourceRevision);
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 (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getCreatedTime() != null)
sb.append("CreatedTime: ").append(getCreatedTime()).append(",");
if (getActive() != null)
sb.append("Active: ").append(getActive()).append(",");
if (getGuidance() != null)
sb.append("Guidance: ").append(getGuidance()).append(",");
if (getSourceRevision() != null)
sb.append("SourceRevision: ").append(getSourceRevision());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ProvisioningArtifactDetail == false)
return false;
ProvisioningArtifactDetail other = (ProvisioningArtifactDetail) obj;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == 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.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getCreatedTime() == null ^ this.getCreatedTime() == null)
return false;
if (other.getCreatedTime() != null && other.getCreatedTime().equals(this.getCreatedTime()) == false)
return false;
if (other.getActive() == null ^ this.getActive() == null)
return false;
if (other.getActive() != null && other.getActive().equals(this.getActive()) == false)
return false;
if (other.getGuidance() == null ^ this.getGuidance() == null)
return false;
if (other.getGuidance() != null && other.getGuidance().equals(this.getGuidance()) == false)
return false;
if (other.getSourceRevision() == null ^ this.getSourceRevision() == null)
return false;
if (other.getSourceRevision() != null && other.getSourceRevision().equals(this.getSourceRevision()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getCreatedTime() == null) ? 0 : getCreatedTime().hashCode());
hashCode = prime * hashCode + ((getActive() == null) ? 0 : getActive().hashCode());
hashCode = prime * hashCode + ((getGuidance() == null) ? 0 : getGuidance().hashCode());
hashCode = prime * hashCode + ((getSourceRevision() == null) ? 0 : getSourceRevision().hashCode());
return hashCode;
}
@Override
public ProvisioningArtifactDetail clone() {
try {
return (ProvisioningArtifactDetail) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.servicecatalog.model.transform.ProvisioningArtifactDetailMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}