com.amazonaws.services.quicksight.model.Folder Maven / Gradle / Ivy
Show all versions of aws-java-sdk-quicksight Show documentation
/*
* 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.quicksight.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* A folder in Amazon QuickSight.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Folder implements Serializable, Cloneable, StructuredPojo {
/**
*
* The ID of the folder.
*
*/
private String folderId;
/**
*
* The Amazon Resource Name (ARN) for the folder.
*
*/
private String arn;
/**
*
* A display name for the folder.
*
*/
private String name;
/**
*
* The type of folder it is.
*
*/
private String folderType;
/**
*
* An array of ancestor ARN strings for the folder.
*
*/
private java.util.List folderPath;
/**
*
* The time that the folder was created.
*
*/
private java.util.Date createdTime;
/**
*
* The time that the folder was last updated.
*
*/
private java.util.Date lastUpdatedTime;
/**
*
* The sharing scope of the folder.
*
*/
private String sharingModel;
/**
*
* The ID of the folder.
*
*
* @param folderId
* The ID of the folder.
*/
public void setFolderId(String folderId) {
this.folderId = folderId;
}
/**
*
* The ID of the folder.
*
*
* @return The ID of the folder.
*/
public String getFolderId() {
return this.folderId;
}
/**
*
* The ID of the folder.
*
*
* @param folderId
* The ID of the folder.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Folder withFolderId(String folderId) {
setFolderId(folderId);
return this;
}
/**
*
* The Amazon Resource Name (ARN) for the folder.
*
*
* @param arn
* The Amazon Resource Name (ARN) for the folder.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) for the folder.
*
*
* @return The Amazon Resource Name (ARN) for the folder.
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) for the folder.
*
*
* @param arn
* The Amazon Resource Name (ARN) for the folder.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Folder withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* A display name for the folder.
*
*
* @param name
* A display name for the folder.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A display name for the folder.
*
*
* @return A display name for the folder.
*/
public String getName() {
return this.name;
}
/**
*
* A display name for the folder.
*
*
* @param name
* A display name for the folder.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Folder withName(String name) {
setName(name);
return this;
}
/**
*
* The type of folder it is.
*
*
* @param folderType
* The type of folder it is.
* @see FolderType
*/
public void setFolderType(String folderType) {
this.folderType = folderType;
}
/**
*
* The type of folder it is.
*
*
* @return The type of folder it is.
* @see FolderType
*/
public String getFolderType() {
return this.folderType;
}
/**
*
* The type of folder it is.
*
*
* @param folderType
* The type of folder it is.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FolderType
*/
public Folder withFolderType(String folderType) {
setFolderType(folderType);
return this;
}
/**
*
* The type of folder it is.
*
*
* @param folderType
* The type of folder it is.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FolderType
*/
public Folder withFolderType(FolderType folderType) {
this.folderType = folderType.toString();
return this;
}
/**
*
* An array of ancestor ARN strings for the folder.
*
*
* @return An array of ancestor ARN strings for the folder.
*/
public java.util.List getFolderPath() {
return folderPath;
}
/**
*
* An array of ancestor ARN strings for the folder.
*
*
* @param folderPath
* An array of ancestor ARN strings for the folder.
*/
public void setFolderPath(java.util.Collection folderPath) {
if (folderPath == null) {
this.folderPath = null;
return;
}
this.folderPath = new java.util.ArrayList(folderPath);
}
/**
*
* An array of ancestor ARN strings for the folder.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setFolderPath(java.util.Collection)} or {@link #withFolderPath(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param folderPath
* An array of ancestor ARN strings for the folder.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Folder withFolderPath(String... folderPath) {
if (this.folderPath == null) {
setFolderPath(new java.util.ArrayList(folderPath.length));
}
for (String ele : folderPath) {
this.folderPath.add(ele);
}
return this;
}
/**
*
* An array of ancestor ARN strings for the folder.
*
*
* @param folderPath
* An array of ancestor ARN strings for the folder.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Folder withFolderPath(java.util.Collection folderPath) {
setFolderPath(folderPath);
return this;
}
/**
*
* The time that the folder was created.
*
*
* @param createdTime
* The time that the folder was created.
*/
public void setCreatedTime(java.util.Date createdTime) {
this.createdTime = createdTime;
}
/**
*
* The time that the folder was created.
*
*
* @return The time that the folder was created.
*/
public java.util.Date getCreatedTime() {
return this.createdTime;
}
/**
*
* The time that the folder was created.
*
*
* @param createdTime
* The time that the folder was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Folder withCreatedTime(java.util.Date createdTime) {
setCreatedTime(createdTime);
return this;
}
/**
*
* The time that the folder was last updated.
*
*
* @param lastUpdatedTime
* The time that the folder was last updated.
*/
public void setLastUpdatedTime(java.util.Date lastUpdatedTime) {
this.lastUpdatedTime = lastUpdatedTime;
}
/**
*
* The time that the folder was last updated.
*
*
* @return The time that the folder was last updated.
*/
public java.util.Date getLastUpdatedTime() {
return this.lastUpdatedTime;
}
/**
*
* The time that the folder was last updated.
*
*
* @param lastUpdatedTime
* The time that the folder was last updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Folder withLastUpdatedTime(java.util.Date lastUpdatedTime) {
setLastUpdatedTime(lastUpdatedTime);
return this;
}
/**
*
* The sharing scope of the folder.
*
*
* @param sharingModel
* The sharing scope of the folder.
* @see SharingModel
*/
public void setSharingModel(String sharingModel) {
this.sharingModel = sharingModel;
}
/**
*
* The sharing scope of the folder.
*
*
* @return The sharing scope of the folder.
* @see SharingModel
*/
public String getSharingModel() {
return this.sharingModel;
}
/**
*
* The sharing scope of the folder.
*
*
* @param sharingModel
* The sharing scope of the folder.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SharingModel
*/
public Folder withSharingModel(String sharingModel) {
setSharingModel(sharingModel);
return this;
}
/**
*
* The sharing scope of the folder.
*
*
* @param sharingModel
* The sharing scope of the folder.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SharingModel
*/
public Folder withSharingModel(SharingModel sharingModel) {
this.sharingModel = sharingModel.toString();
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 (getFolderId() != null)
sb.append("FolderId: ").append(getFolderId()).append(",");
if (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getFolderType() != null)
sb.append("FolderType: ").append(getFolderType()).append(",");
if (getFolderPath() != null)
sb.append("FolderPath: ").append(getFolderPath()).append(",");
if (getCreatedTime() != null)
sb.append("CreatedTime: ").append(getCreatedTime()).append(",");
if (getLastUpdatedTime() != null)
sb.append("LastUpdatedTime: ").append(getLastUpdatedTime()).append(",");
if (getSharingModel() != null)
sb.append("SharingModel: ").append(getSharingModel());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Folder == false)
return false;
Folder other = (Folder) obj;
if (other.getFolderId() == null ^ this.getFolderId() == null)
return false;
if (other.getFolderId() != null && other.getFolderId().equals(this.getFolderId()) == false)
return false;
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.getFolderType() == null ^ this.getFolderType() == null)
return false;
if (other.getFolderType() != null && other.getFolderType().equals(this.getFolderType()) == false)
return false;
if (other.getFolderPath() == null ^ this.getFolderPath() == null)
return false;
if (other.getFolderPath() != null && other.getFolderPath().equals(this.getFolderPath()) == 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.getLastUpdatedTime() == null ^ this.getLastUpdatedTime() == null)
return false;
if (other.getLastUpdatedTime() != null && other.getLastUpdatedTime().equals(this.getLastUpdatedTime()) == false)
return false;
if (other.getSharingModel() == null ^ this.getSharingModel() == null)
return false;
if (other.getSharingModel() != null && other.getSharingModel().equals(this.getSharingModel()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFolderId() == null) ? 0 : getFolderId().hashCode());
hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getFolderType() == null) ? 0 : getFolderType().hashCode());
hashCode = prime * hashCode + ((getFolderPath() == null) ? 0 : getFolderPath().hashCode());
hashCode = prime * hashCode + ((getCreatedTime() == null) ? 0 : getCreatedTime().hashCode());
hashCode = prime * hashCode + ((getLastUpdatedTime() == null) ? 0 : getLastUpdatedTime().hashCode());
hashCode = prime * hashCode + ((getSharingModel() == null) ? 0 : getSharingModel().hashCode());
return hashCode;
}
@Override
public Folder clone() {
try {
return (Folder) 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.FolderMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}