com.amazonaws.services.robomaker.model.DescribeWorldResult Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-robomaker Show documentation
The AWS Java SDK for AWS RoboMaker module holds the client classes that are used for communicating with AWS RoboMaker Service
The newest version!
/*
 * 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.robomaker.model;

import java.io.Serializable;
import javax.annotation.Generated;

/**
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeWorldResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {

    /**
     * 
     * The Amazon Resource Name (arn) of the world.
     * 
     */
    private String arn;
    /**
     * 
     * The Amazon Resource Name (arn) of the world generation job that generated the world.
     * 
     */
    private String generationJob;
    /**
     * 
     * The world template.
     * 
     */
    private String template;
    /**
     * 
     * The time, in milliseconds since the epoch, when the world was created.
     * 
     */
    private java.util.Date createdAt;
    /**
     * 
     * A map that contains tag keys and tag values that are attached to the world.
     * 
     */
    private java.util.Map tags;
    /**
     * 
     * Returns the JSON formatted string that describes the contents of your world.
     * 
     */
    private String worldDescriptionBody;

    /**
     * 
     * The Amazon Resource Name (arn) of the world.
     * 
     * 
     * @param arn
     *        The Amazon Resource Name (arn) of the world.
     */

    public void setArn(String arn) {
        this.arn = arn;
    }

    /**
     * 
     * The Amazon Resource Name (arn) of the world.
     * 
     * 
     * @return The Amazon Resource Name (arn) of the world.
     */

    public String getArn() {
        return this.arn;
    }

    /**
     * 
     * The Amazon Resource Name (arn) of the world.
     * 
     * 
     * @param arn
     *        The Amazon Resource Name (arn) of the world.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DescribeWorldResult withArn(String arn) {
        setArn(arn);
        return this;
    }

    /**
     * 
     * The Amazon Resource Name (arn) of the world generation job that generated the world.
     * 
     * 
     * @param generationJob
     *        The Amazon Resource Name (arn) of the world generation job that generated the world.
     */

    public void setGenerationJob(String generationJob) {
        this.generationJob = generationJob;
    }

    /**
     * 
     * The Amazon Resource Name (arn) of the world generation job that generated the world.
     * 
     * 
     * @return The Amazon Resource Name (arn) of the world generation job that generated the world.
     */

    public String getGenerationJob() {
        return this.generationJob;
    }

    /**
     * 
     * The Amazon Resource Name (arn) of the world generation job that generated the world.
     * 
     * 
     * @param generationJob
     *        The Amazon Resource Name (arn) of the world generation job that generated the world.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DescribeWorldResult withGenerationJob(String generationJob) {
        setGenerationJob(generationJob);
        return this;
    }

    /**
     * 
     * The world template.
     * 
     * 
     * @param template
     *        The world template.
     */

    public void setTemplate(String template) {
        this.template = template;
    }

    /**
     * 
     * The world template.
     * 
     * 
     * @return The world template.
     */

    public String getTemplate() {
        return this.template;
    }

    /**
     * 
     * The world template.
     * 
     * 
     * @param template
     *        The world template.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DescribeWorldResult withTemplate(String template) {
        setTemplate(template);
        return this;
    }

    /**
     * 
     * The time, in milliseconds since the epoch, when the world was created.
     * 
     * 
     * @param createdAt
     *        The time, in milliseconds since the epoch, when the world was created.
     */

    public void setCreatedAt(java.util.Date createdAt) {
        this.createdAt = createdAt;
    }

    /**
     * 
     * The time, in milliseconds since the epoch, when the world was created.
     * 
     * 
     * @return The time, in milliseconds since the epoch, when the world was created.
     */

    public java.util.Date getCreatedAt() {
        return this.createdAt;
    }

    /**
     * 
     * The time, in milliseconds since the epoch, when the world was created.
     * 
     * 
     * @param createdAt
     *        The time, in milliseconds since the epoch, when the world was created.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DescribeWorldResult withCreatedAt(java.util.Date createdAt) {
        setCreatedAt(createdAt);
        return this;
    }

    /**
     * 
     * A map that contains tag keys and tag values that are attached to the world.
     * 
     * 
     * @return A map that contains tag keys and tag values that are attached to the world.
     */

    public java.util.Map getTags() {
        return tags;
    }

    /**
     * 
     * A map that contains tag keys and tag values that are attached to the world.
     * 
     * 
     * @param tags
     *        A map that contains tag keys and tag values that are attached to the world.
     */

    public void setTags(java.util.Map tags) {
        this.tags = tags;
    }

    /**
     * 
     * A map that contains tag keys and tag values that are attached to the world.
     * 
     * 
     * @param tags
     *        A map that contains tag keys and tag values that are attached to the world.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DescribeWorldResult withTags(java.util.Map tags) {
        setTags(tags);
        return this;
    }

    /**
     * Add a single Tags entry
     *
     * @see DescribeWorldResult#withTags
     * @returns a reference to this object so that method calls can be chained together.
     */

    public DescribeWorldResult 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 DescribeWorldResult clearTagsEntries() {
        this.tags = null;
        return this;
    }

    /**
     * 
     * Returns the JSON formatted string that describes the contents of your world.
     * 
     * 
     * @param worldDescriptionBody
     *        Returns the JSON formatted string that describes the contents of your world.
     */

    public void setWorldDescriptionBody(String worldDescriptionBody) {
        this.worldDescriptionBody = worldDescriptionBody;
    }

    /**
     * 
     * Returns the JSON formatted string that describes the contents of your world.
     * 
     * 
     * @return Returns the JSON formatted string that describes the contents of your world.
     */

    public String getWorldDescriptionBody() {
        return this.worldDescriptionBody;
    }

    /**
     * 
     * Returns the JSON formatted string that describes the contents of your world.
     * 
     * 
     * @param worldDescriptionBody
     *        Returns the JSON formatted string that describes the contents of your world.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public DescribeWorldResult withWorldDescriptionBody(String worldDescriptionBody) {
        setWorldDescriptionBody(worldDescriptionBody);
        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 (getArn() != null)
            sb.append("Arn: ").append(getArn()).append(",");
        if (getGenerationJob() != null)
            sb.append("GenerationJob: ").append(getGenerationJob()).append(",");
        if (getTemplate() != null)
            sb.append("Template: ").append(getTemplate()).append(",");
        if (getCreatedAt() != null)
            sb.append("CreatedAt: ").append(getCreatedAt()).append(",");
        if (getTags() != null)
            sb.append("Tags: ").append(getTags()).append(",");
        if (getWorldDescriptionBody() != null)
            sb.append("WorldDescriptionBody: ").append(getWorldDescriptionBody());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof DescribeWorldResult == false)
            return false;
        DescribeWorldResult other = (DescribeWorldResult) obj;
        if (other.getArn() == null ^ this.getArn() == null)
            return false;
        if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
            return false;
        if (other.getGenerationJob() == null ^ this.getGenerationJob() == null)
            return false;
        if (other.getGenerationJob() != null && other.getGenerationJob().equals(this.getGenerationJob()) == false)
            return false;
        if (other.getTemplate() == null ^ this.getTemplate() == null)
            return false;
        if (other.getTemplate() != null && other.getTemplate().equals(this.getTemplate()) == false)
            return false;
        if (other.getCreatedAt() == null ^ this.getCreatedAt() == null)
            return false;
        if (other.getCreatedAt() != null && other.getCreatedAt().equals(this.getCreatedAt()) == 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.getWorldDescriptionBody() == null ^ this.getWorldDescriptionBody() == null)
            return false;
        if (other.getWorldDescriptionBody() != null && other.getWorldDescriptionBody().equals(this.getWorldDescriptionBody()) == 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 + ((getGenerationJob() == null) ? 0 : getGenerationJob().hashCode());
        hashCode = prime * hashCode + ((getTemplate() == null) ? 0 : getTemplate().hashCode());
        hashCode = prime * hashCode + ((getCreatedAt() == null) ? 0 : getCreatedAt().hashCode());
        hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
        hashCode = prime * hashCode + ((getWorldDescriptionBody() == null) ? 0 : getWorldDescriptionBody().hashCode());
        return hashCode;
    }

    @Override
    public DescribeWorldResult clone() {
        try {
            return (DescribeWorldResult) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

}