com.amazonaws.services.imagebuilder.model.ComponentSummary 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.imagebuilder.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* A high-level summary of a component.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ComponentSummary implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) of the component.
*
*/
private String arn;
/**
*
* The name of the component.
*
*/
private String name;
/**
*
* The version of the component.
*
*/
private String version;
/**
*
* The operating system platform of the component.
*
*/
private String platform;
/**
*
* The operating system (OS) version that the component supports. If the OS information is available, Image Builder
* performs a prefix match against the base image OS version during image recipe creation.
*
*/
private java.util.List supportedOsVersions;
/**
*
* Describes the current status of the component.
*
*/
private ComponentState state;
/**
*
* The component type specifies whether Image Builder uses the component to build the image or only to test it.
*
*/
private String type;
/**
*
* The owner of the component.
*
*/
private String owner;
/**
*
* The description of the component.
*
*/
private String description;
/**
*
* The change description for the current version of the component.
*
*/
private String changeDescription;
/**
*
* The original creation date of the component.
*
*/
private String dateCreated;
/**
*
* The tags that apply to the component.
*
*/
private java.util.Map tags;
/**
*
* Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
*
*/
private String publisher;
/**
*
* Indicates whether component source is hidden from view in the console, and from component detail results for API,
* CLI, or SDK operations.
*
*/
private Boolean obfuscate;
/**
*
* The Amazon Resource Name (ARN) of the component.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the component.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) of the component.
*
*
* @return The Amazon Resource Name (ARN) of the component.
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) of the component.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the component.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ComponentSummary withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* 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 ComponentSummary withName(String name) {
setName(name);
return this;
}
/**
*
* The version of the component.
*
*
* @param version
* The version of the component.
*/
public void setVersion(String version) {
this.version = version;
}
/**
*
* The version of the component.
*
*
* @return The version of the component.
*/
public String getVersion() {
return this.version;
}
/**
*
* The version of the component.
*
*
* @param version
* The version of the component.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ComponentSummary withVersion(String version) {
setVersion(version);
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 ComponentSummary 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 ComponentSummary withPlatform(Platform platform) {
this.platform = platform.toString();
return this;
}
/**
*
* The operating system (OS) version that the component supports. If the OS information is available, Image Builder
* performs a prefix match against the base image OS version during image recipe creation.
*
*
* @return The operating system (OS) version that the component supports. If the OS information is available, Image
* Builder performs a prefix match against the base image OS version during image recipe creation.
*/
public java.util.List getSupportedOsVersions() {
return supportedOsVersions;
}
/**
*
* The operating system (OS) version that the component supports. If the OS information is available, Image Builder
* performs a prefix match against the base image OS version during image recipe creation.
*
*
* @param supportedOsVersions
* The operating system (OS) version that the component supports. If the OS information is available, Image
* Builder performs a prefix match against the base image OS version during image recipe creation.
*/
public void setSupportedOsVersions(java.util.Collection supportedOsVersions) {
if (supportedOsVersions == null) {
this.supportedOsVersions = null;
return;
}
this.supportedOsVersions = new java.util.ArrayList(supportedOsVersions);
}
/**
*
* The operating system (OS) version that the component supports. If the OS information is available, Image Builder
* performs a prefix match 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 that the component supports. If the OS information is available, Image
* Builder performs a prefix match 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 ComponentSummary withSupportedOsVersions(String... supportedOsVersions) {
if (this.supportedOsVersions == null) {
setSupportedOsVersions(new java.util.ArrayList(supportedOsVersions.length));
}
for (String ele : supportedOsVersions) {
this.supportedOsVersions.add(ele);
}
return this;
}
/**
*
* The operating system (OS) version that the component supports. If the OS information is available, Image Builder
* performs a prefix match against the base image OS version during image recipe creation.
*
*
* @param supportedOsVersions
* The operating system (OS) version that the component supports. If the OS information is available, Image
* Builder performs a prefix match 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 ComponentSummary withSupportedOsVersions(java.util.Collection supportedOsVersions) {
setSupportedOsVersions(supportedOsVersions);
return this;
}
/**
*
* Describes the current status of the component.
*
*
* @param state
* Describes the current status of the component.
*/
public void setState(ComponentState state) {
this.state = state;
}
/**
*
* Describes the current status of the component.
*
*
* @return Describes the current status of the component.
*/
public ComponentState getState() {
return this.state;
}
/**
*
* Describes the current status of the component.
*
*
* @param state
* Describes the current status of the component.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ComponentSummary withState(ComponentState state) {
setState(state);
return this;
}
/**
*
* The component type specifies whether Image Builder uses the component to build the image or only to test it.
*
*
* @param type
* The component type specifies whether Image Builder uses the component to build the image or only to test
* it.
* @see ComponentType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The component type specifies whether Image Builder uses the component to build the image or only to test it.
*
*
* @return The component type specifies whether Image Builder uses the component to build the image or only to test
* it.
* @see ComponentType
*/
public String getType() {
return this.type;
}
/**
*
* The component type specifies whether Image Builder uses the component to build the image or only to test it.
*
*
* @param type
* The component type specifies whether Image Builder uses the component to build the image or only to test
* it.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ComponentType
*/
public ComponentSummary withType(String type) {
setType(type);
return this;
}
/**
*
* The component type specifies whether Image Builder uses the component to build the image or only to test it.
*
*
* @param type
* The component type specifies whether Image Builder uses the component to build the image or only to test
* it.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ComponentType
*/
public ComponentSummary withType(ComponentType type) {
this.type = type.toString();
return this;
}
/**
*
* The owner of the component.
*
*
* @param owner
* The owner of the component.
*/
public void setOwner(String owner) {
this.owner = owner;
}
/**
*
* The owner of the component.
*
*
* @return The owner of the component.
*/
public String getOwner() {
return this.owner;
}
/**
*
* The owner of the component.
*
*
* @param owner
* The owner of the component.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ComponentSummary withOwner(String owner) {
setOwner(owner);
return this;
}
/**
*
* The description of the component.
*
*
* @param description
* The description of the component.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The description of the component.
*
*
* @return The description of the component.
*/
public String getDescription() {
return this.description;
}
/**
*
* The description of the component.
*
*
* @param description
* The description of the component.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ComponentSummary withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The change description for the current version of the component.
*
*
* @param changeDescription
* The change description for the current version of the component.
*/
public void setChangeDescription(String changeDescription) {
this.changeDescription = changeDescription;
}
/**
*
* The change description for the current version of the component.
*
*
* @return The change description for the current version of the component.
*/
public String getChangeDescription() {
return this.changeDescription;
}
/**
*
* The change description for the current version of the component.
*
*
* @param changeDescription
* The change description for the current version of the component.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ComponentSummary withChangeDescription(String changeDescription) {
setChangeDescription(changeDescription);
return this;
}
/**
*
* The original creation date of the component.
*
*
* @param dateCreated
* The original creation date of the component.
*/
public void setDateCreated(String dateCreated) {
this.dateCreated = dateCreated;
}
/**
*
* The original creation date of the component.
*
*
* @return The original creation date of the component.
*/
public String getDateCreated() {
return this.dateCreated;
}
/**
*
* The original creation date of the component.
*
*
* @param dateCreated
* The original creation date of the component.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ComponentSummary withDateCreated(String dateCreated) {
setDateCreated(dateCreated);
return this;
}
/**
*
* The tags that apply to the component.
*
*
* @return The tags that apply to the component.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* The tags that apply to the component.
*
*
* @param tags
* The tags that apply to the component.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* 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 ComponentSummary withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see ComponentSummary#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public ComponentSummary addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ComponentSummary clearTagsEntries() {
this.tags = null;
return this;
}
/**
*
* Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
*
*
* @param publisher
* Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
*/
public void setPublisher(String publisher) {
this.publisher = publisher;
}
/**
*
* Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
*
*
* @return Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
*/
public String getPublisher() {
return this.publisher;
}
/**
*
* Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
*
*
* @param publisher
* Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ComponentSummary withPublisher(String publisher) {
setPublisher(publisher);
return this;
}
/**
*
* Indicates whether component source is hidden from view in the console, and from component detail results for API,
* CLI, or SDK operations.
*
*
* @param obfuscate
* Indicates whether component source is hidden from view in the console, and from component detail results
* for API, CLI, or SDK operations.
*/
public void setObfuscate(Boolean obfuscate) {
this.obfuscate = obfuscate;
}
/**
*
* Indicates whether component source is hidden from view in the console, and from component detail results for API,
* CLI, or SDK operations.
*
*
* @return Indicates whether component source is hidden from view in the console, and from component detail results
* for API, CLI, or SDK operations.
*/
public Boolean getObfuscate() {
return this.obfuscate;
}
/**
*
* Indicates whether component source is hidden from view in the console, and from component detail results for API,
* CLI, or SDK operations.
*
*
* @param obfuscate
* Indicates whether component source is hidden from view in the console, and from component detail results
* for API, CLI, or SDK operations.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ComponentSummary withObfuscate(Boolean obfuscate) {
setObfuscate(obfuscate);
return this;
}
/**
*
* Indicates whether component source is hidden from view in the console, and from component detail results for API,
* CLI, or SDK operations.
*
*
* @return Indicates whether component source is hidden from view in the console, and from component detail results
* for API, CLI, or SDK operations.
*/
public Boolean isObfuscate() {
return this.obfuscate;
}
/**
* 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 (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getVersion() != null)
sb.append("Version: ").append(getVersion()).append(",");
if (getPlatform() != null)
sb.append("Platform: ").append(getPlatform()).append(",");
if (getSupportedOsVersions() != null)
sb.append("SupportedOsVersions: ").append(getSupportedOsVersions()).append(",");
if (getState() != null)
sb.append("State: ").append(getState()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getOwner() != null)
sb.append("Owner: ").append(getOwner()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getChangeDescription() != null)
sb.append("ChangeDescription: ").append(getChangeDescription()).append(",");
if (getDateCreated() != null)
sb.append("DateCreated: ").append(getDateCreated()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getPublisher() != null)
sb.append("Publisher: ").append(getPublisher()).append(",");
if (getObfuscate() != null)
sb.append("Obfuscate: ").append(getObfuscate());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ComponentSummary == false)
return false;
ComponentSummary other = (ComponentSummary) obj;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == 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.getVersion() == null ^ this.getVersion() == null)
return false;
if (other.getVersion() != null && other.getVersion().equals(this.getVersion()) == 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.getState() == null ^ this.getState() == null)
return false;
if (other.getState() != null && other.getState().equals(this.getState()) == 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.getOwner() == null ^ this.getOwner() == null)
return false;
if (other.getOwner() != null && other.getOwner().equals(this.getOwner()) == 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.getDateCreated() == null ^ this.getDateCreated() == null)
return false;
if (other.getDateCreated() != null && other.getDateCreated().equals(this.getDateCreated()) == 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.getPublisher() == null ^ this.getPublisher() == null)
return false;
if (other.getPublisher() != null && other.getPublisher().equals(this.getPublisher()) == false)
return false;
if (other.getObfuscate() == null ^ this.getObfuscate() == null)
return false;
if (other.getObfuscate() != null && other.getObfuscate().equals(this.getObfuscate()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getVersion() == null) ? 0 : getVersion().hashCode());
hashCode = prime * hashCode + ((getPlatform() == null) ? 0 : getPlatform().hashCode());
hashCode = prime * hashCode + ((getSupportedOsVersions() == null) ? 0 : getSupportedOsVersions().hashCode());
hashCode = prime * hashCode + ((getState() == null) ? 0 : getState().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getOwner() == null) ? 0 : getOwner().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getChangeDescription() == null) ? 0 : getChangeDescription().hashCode());
hashCode = prime * hashCode + ((getDateCreated() == null) ? 0 : getDateCreated().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getPublisher() == null) ? 0 : getPublisher().hashCode());
hashCode = prime * hashCode + ((getObfuscate() == null) ? 0 : getObfuscate().hashCode());
return hashCode;
}
@Override
public ComponentSummary clone() {
try {
return (ComponentSummary) 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.imagebuilder.model.transform.ComponentSummaryMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}