com.amazonaws.services.quicksight.model.CreateFolderRequest 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.quicksight.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateFolderRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The ID for the Amazon Web Services account where you want to create the folder.
*
*/
private String awsAccountId;
/**
*
* The ID of the folder.
*
*/
private String folderId;
/**
*
* The name of the folder.
*
*/
private String name;
/**
*
* The type of folder. By default, folderType is SHARED.
*
*/
private String folderType;
/**
*
* The Amazon Resource Name (ARN) for the parent folder.
*
*
* ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
*
*/
private String parentFolderArn;
/**
*
* A structure that describes the principals and the resource-level permissions of a folder.
*
*
* To specify no permissions, omit Permissions.
*
*/
private java.util.List permissions;
/**
*
* Tags for the folder.
*
*/
private java.util.List tags;
/**
*
* An optional parameter that determines the sharing scope of the folder. The default value for this parameter is
* ACCOUNT.
*
*/
private String sharingModel;
/**
*
* The ID for the Amazon Web Services account where you want to create the folder.
*
*
* @param awsAccountId
* The ID for the Amazon Web Services account where you want to create the folder.
*/
public void setAwsAccountId(String awsAccountId) {
this.awsAccountId = awsAccountId;
}
/**
*
* The ID for the Amazon Web Services account where you want to create the folder.
*
*
* @return The ID for the Amazon Web Services account where you want to create the folder.
*/
public String getAwsAccountId() {
return this.awsAccountId;
}
/**
*
* The ID for the Amazon Web Services account where you want to create the folder.
*
*
* @param awsAccountId
* The ID for the Amazon Web Services account where you want to create the folder.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFolderRequest withAwsAccountId(String awsAccountId) {
setAwsAccountId(awsAccountId);
return this;
}
/**
*
* 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 CreateFolderRequest withFolderId(String folderId) {
setFolderId(folderId);
return this;
}
/**
*
* The name of the folder.
*
*
* @param name
* The name of the folder.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the folder.
*
*
* @return The name of the folder.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the folder.
*
*
* @param name
* The name of the folder.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFolderRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The type of folder. By default, folderType is SHARED.
*
*
* @param folderType
* The type of folder. By default, folderType is SHARED.
* @see FolderType
*/
public void setFolderType(String folderType) {
this.folderType = folderType;
}
/**
*
* The type of folder. By default, folderType is SHARED.
*
*
* @return The type of folder. By default, folderType is SHARED.
* @see FolderType
*/
public String getFolderType() {
return this.folderType;
}
/**
*
* The type of folder. By default, folderType is SHARED.
*
*
* @param folderType
* The type of folder. By default, folderType is SHARED.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FolderType
*/
public CreateFolderRequest withFolderType(String folderType) {
setFolderType(folderType);
return this;
}
/**
*
* The type of folder. By default, folderType is SHARED.
*
*
* @param folderType
* The type of folder. By default, folderType is SHARED.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FolderType
*/
public CreateFolderRequest withFolderType(FolderType folderType) {
this.folderType = folderType.toString();
return this;
}
/**
*
* The Amazon Resource Name (ARN) for the parent folder.
*
*
* ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
*
*
* @param parentFolderArn
* The Amazon Resource Name (ARN) for the parent folder.
*
* ParentFolderArn can be null. An empty parentFolderArn creates a root-level
* folder.
*/
public void setParentFolderArn(String parentFolderArn) {
this.parentFolderArn = parentFolderArn;
}
/**
*
* The Amazon Resource Name (ARN) for the parent folder.
*
*
* ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
*
*
* @return The Amazon Resource Name (ARN) for the parent folder.
*
* ParentFolderArn can be null. An empty parentFolderArn creates a root-level
* folder.
*/
public String getParentFolderArn() {
return this.parentFolderArn;
}
/**
*
* The Amazon Resource Name (ARN) for the parent folder.
*
*
* ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
*
*
* @param parentFolderArn
* The Amazon Resource Name (ARN) for the parent folder.
*
* ParentFolderArn can be null. An empty parentFolderArn creates a root-level
* folder.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFolderRequest withParentFolderArn(String parentFolderArn) {
setParentFolderArn(parentFolderArn);
return this;
}
/**
*
* A structure that describes the principals and the resource-level permissions of a folder.
*
*
* To specify no permissions, omit Permissions.
*
*
* @return A structure that describes the principals and the resource-level permissions of a folder.
*
* To specify no permissions, omit Permissions.
*/
public java.util.List getPermissions() {
return permissions;
}
/**
*
* A structure that describes the principals and the resource-level permissions of a folder.
*
*
* To specify no permissions, omit Permissions.
*
*
* @param permissions
* A structure that describes the principals and the resource-level permissions of a folder.
*
* To specify no permissions, omit Permissions.
*/
public void setPermissions(java.util.Collection permissions) {
if (permissions == null) {
this.permissions = null;
return;
}
this.permissions = new java.util.ArrayList(permissions);
}
/**
*
* A structure that describes the principals and the resource-level permissions of a folder.
*
*
* To specify no permissions, omit Permissions.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setPermissions(java.util.Collection)} or {@link #withPermissions(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param permissions
* A structure that describes the principals and the resource-level permissions of a folder.
*
* To specify no permissions, omit Permissions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFolderRequest withPermissions(ResourcePermission... permissions) {
if (this.permissions == null) {
setPermissions(new java.util.ArrayList(permissions.length));
}
for (ResourcePermission ele : permissions) {
this.permissions.add(ele);
}
return this;
}
/**
*
* A structure that describes the principals and the resource-level permissions of a folder.
*
*
* To specify no permissions, omit Permissions.
*
*
* @param permissions
* A structure that describes the principals and the resource-level permissions of a folder.
*
* To specify no permissions, omit Permissions.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFolderRequest withPermissions(java.util.Collection permissions) {
setPermissions(permissions);
return this;
}
/**
*
* Tags for the folder.
*
*
* @return Tags for the folder.
*/
public java.util.List getTags() {
return tags;
}
/**
*
* Tags for the folder.
*
*
* @param tags
* Tags for the folder.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new java.util.ArrayList(tags);
}
/**
*
* Tags for the folder.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* Tags for the folder.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFolderRequest withTags(Tag... tags) {
if (this.tags == null) {
setTags(new java.util.ArrayList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* Tags for the folder.
*
*
* @param tags
* Tags for the folder.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateFolderRequest withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* An optional parameter that determines the sharing scope of the folder. The default value for this parameter is
* ACCOUNT.
*
*
* @param sharingModel
* An optional parameter that determines the sharing scope of the folder. The default value for this
* parameter is ACCOUNT.
* @see SharingModel
*/
public void setSharingModel(String sharingModel) {
this.sharingModel = sharingModel;
}
/**
*
* An optional parameter that determines the sharing scope of the folder. The default value for this parameter is
* ACCOUNT.
*
*
* @return An optional parameter that determines the sharing scope of the folder. The default value for this
* parameter is ACCOUNT.
* @see SharingModel
*/
public String getSharingModel() {
return this.sharingModel;
}
/**
*
* An optional parameter that determines the sharing scope of the folder. The default value for this parameter is
* ACCOUNT.
*
*
* @param sharingModel
* An optional parameter that determines the sharing scope of the folder. The default value for this
* parameter is ACCOUNT.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SharingModel
*/
public CreateFolderRequest withSharingModel(String sharingModel) {
setSharingModel(sharingModel);
return this;
}
/**
*
* An optional parameter that determines the sharing scope of the folder. The default value for this parameter is
* ACCOUNT.
*
*
* @param sharingModel
* An optional parameter that determines the sharing scope of the folder. The default value for this
* parameter is ACCOUNT.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SharingModel
*/
public CreateFolderRequest 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 (getAwsAccountId() != null)
sb.append("AwsAccountId: ").append(getAwsAccountId()).append(",");
if (getFolderId() != null)
sb.append("FolderId: ").append(getFolderId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getFolderType() != null)
sb.append("FolderType: ").append(getFolderType()).append(",");
if (getParentFolderArn() != null)
sb.append("ParentFolderArn: ").append(getParentFolderArn()).append(",");
if (getPermissions() != null)
sb.append("Permissions: ").append(getPermissions()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).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 CreateFolderRequest == false)
return false;
CreateFolderRequest other = (CreateFolderRequest) obj;
if (other.getAwsAccountId() == null ^ this.getAwsAccountId() == null)
return false;
if (other.getAwsAccountId() != null && other.getAwsAccountId().equals(this.getAwsAccountId()) == false)
return false;
if (other.getFolderId() == null ^ this.getFolderId() == null)
return false;
if (other.getFolderId() != null && other.getFolderId().equals(this.getFolderId()) == 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.getParentFolderArn() == null ^ this.getParentFolderArn() == null)
return false;
if (other.getParentFolderArn() != null && other.getParentFolderArn().equals(this.getParentFolderArn()) == false)
return false;
if (other.getPermissions() == null ^ this.getPermissions() == null)
return false;
if (other.getPermissions() != null && other.getPermissions().equals(this.getPermissions()) == 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.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 + ((getAwsAccountId() == null) ? 0 : getAwsAccountId().hashCode());
hashCode = prime * hashCode + ((getFolderId() == null) ? 0 : getFolderId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getFolderType() == null) ? 0 : getFolderType().hashCode());
hashCode = prime * hashCode + ((getParentFolderArn() == null) ? 0 : getParentFolderArn().hashCode());
hashCode = prime * hashCode + ((getPermissions() == null) ? 0 : getPermissions().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getSharingModel() == null) ? 0 : getSharingModel().hashCode());
return hashCode;
}
@Override
public CreateFolderRequest clone() {
return (CreateFolderRequest) super.clone();
}
}