com.amazonaws.services.quicksight.model.Template Maven / Gradle / Ivy
Show all versions of aws-java-sdk-quicksight Show documentation
/*
* Copyright 2014-2019 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.quicksight.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* A template object. A template is an entity in QuickSight which encapsulates the metadata required to create an
* analysis that can be used to create dashboard. It adds a layer of abstraction by replacing the dataset associated
* with the analysis with placeholders. Templates can be used to create dashboards by replacing dataset placeholders
* with datasets which follow the same schema that was used to create the source analysis and template.
*
*
* You can share templates across AWS accounts by allowing users in other AWS accounts to create a template or a
* dashboard from an existing template.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Template implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) of the template.
*
*/
private String arn;
/**
*
* The display name of the template.
*
*/
private String name;
/**
*
* A structure describing the versions of the template.
*
*/
private TemplateVersion version;
/**
*
* The ID for the template. This is unique per AWS Region for each AWS account.
*
*/
private String templateId;
/**
*
* Time when this was last updated.
*
*/
private java.util.Date lastUpdatedTime;
/**
*
* Time when this was created.
*
*/
private java.util.Date createdTime;
/**
*
* The Amazon Resource Name (ARN) of the template.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the template.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) of the template.
*
*
* @return The Amazon Resource Name (ARN) of the template.
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) of the template.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Template withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* The display name of the template.
*
*
* @param name
* The display name of the template.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The display name of the template.
*
*
* @return The display name of the template.
*/
public String getName() {
return this.name;
}
/**
*
* The display name of the template.
*
*
* @param name
* The display name of the template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Template withName(String name) {
setName(name);
return this;
}
/**
*
* A structure describing the versions of the template.
*
*
* @param version
* A structure describing the versions of the template.
*/
public void setVersion(TemplateVersion version) {
this.version = version;
}
/**
*
* A structure describing the versions of the template.
*
*
* @return A structure describing the versions of the template.
*/
public TemplateVersion getVersion() {
return this.version;
}
/**
*
* A structure describing the versions of the template.
*
*
* @param version
* A structure describing the versions of the template.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Template withVersion(TemplateVersion version) {
setVersion(version);
return this;
}
/**
*
* The ID for the template. This is unique per AWS Region for each AWS account.
*
*
* @param templateId
* The ID for the template. This is unique per AWS Region for each AWS account.
*/
public void setTemplateId(String templateId) {
this.templateId = templateId;
}
/**
*
* The ID for the template. This is unique per AWS Region for each AWS account.
*
*
* @return The ID for the template. This is unique per AWS Region for each AWS account.
*/
public String getTemplateId() {
return this.templateId;
}
/**
*
* The ID for the template. This is unique per AWS Region for each AWS account.
*
*
* @param templateId
* The ID for the template. This is unique per AWS Region for each AWS account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Template withTemplateId(String templateId) {
setTemplateId(templateId);
return this;
}
/**
*
* Time when this was last updated.
*
*
* @param lastUpdatedTime
* Time when this was last updated.
*/
public void setLastUpdatedTime(java.util.Date lastUpdatedTime) {
this.lastUpdatedTime = lastUpdatedTime;
}
/**
*
* Time when this was last updated.
*
*
* @return Time when this was last updated.
*/
public java.util.Date getLastUpdatedTime() {
return this.lastUpdatedTime;
}
/**
*
* Time when this was last updated.
*
*
* @param lastUpdatedTime
* Time when this was last updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Template withLastUpdatedTime(java.util.Date lastUpdatedTime) {
setLastUpdatedTime(lastUpdatedTime);
return this;
}
/**
*
* Time when this was created.
*
*
* @param createdTime
* Time when this was created.
*/
public void setCreatedTime(java.util.Date createdTime) {
this.createdTime = createdTime;
}
/**
*
* Time when this was created.
*
*
* @return Time when this was created.
*/
public java.util.Date getCreatedTime() {
return this.createdTime;
}
/**
*
* Time when this was created.
*
*
* @param createdTime
* Time when this was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Template withCreatedTime(java.util.Date createdTime) {
setCreatedTime(createdTime);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getVersion() != null)
sb.append("Version: ").append(getVersion()).append(",");
if (getTemplateId() != null)
sb.append("TemplateId: ").append(getTemplateId()).append(",");
if (getLastUpdatedTime() != null)
sb.append("LastUpdatedTime: ").append(getLastUpdatedTime()).append(",");
if (getCreatedTime() != null)
sb.append("CreatedTime: ").append(getCreatedTime());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Template == false)
return false;
Template other = (Template) 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.getTemplateId() == null ^ this.getTemplateId() == null)
return false;
if (other.getTemplateId() != null && other.getTemplateId().equals(this.getTemplateId()) == false)
return false;
if (other.getLastUpdatedTime() == null ^ this.getLastUpdatedTime() == null)
return false;
if (other.getLastUpdatedTime() != null && other.getLastUpdatedTime().equals(this.getLastUpdatedTime()) == false)
return false;
if (other.getCreatedTime() == null ^ this.getCreatedTime() == null)
return false;
if (other.getCreatedTime() != null && other.getCreatedTime().equals(this.getCreatedTime()) == 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 + ((getTemplateId() == null) ? 0 : getTemplateId().hashCode());
hashCode = prime * hashCode + ((getLastUpdatedTime() == null) ? 0 : getLastUpdatedTime().hashCode());
hashCode = prime * hashCode + ((getCreatedTime() == null) ? 0 : getCreatedTime().hashCode());
return hashCode;
}
@Override
public Template clone() {
try {
return (Template) 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.quicksight.model.transform.TemplateMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}