com.amazonaws.services.quicksight.model

Class CreateFolderRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.quicksight.model.CreateFolderRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateFolderRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateFolderRequest()

Method Summary

Modifier and Type	Method and Description
CreateFolderRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAwsAccountId() The ID for the Amazon Web Services account where you want to create the folder.
String	getFolderId() The ID of the folder.
String	getFolderType() The type of folder.
String	getName() The name of the folder.
String	getParentFolderArn() The Amazon Resource Name (ARN) for the parent folder.
List<ResourcePermission>	getPermissions() A structure that describes the principals and the resource-level permissions of a folder.
String	getSharingModel() An optional parameter that determines the sharing scope of the folder.
List<Tag>	getTags() Tags for the folder.
int	hashCode()
void	setAwsAccountId(String awsAccountId) The ID for the Amazon Web Services account where you want to create the folder.
void	setFolderId(String folderId) The ID of the folder.
void	setFolderType(String folderType) The type of folder.
void	setName(String name) The name of the folder.
void	setParentFolderArn(String parentFolderArn) The Amazon Resource Name (ARN) for the parent folder.
void	setPermissions(Collection<ResourcePermission> permissions) A structure that describes the principals and the resource-level permissions of a folder.
void	setSharingModel(String sharingModel) An optional parameter that determines the sharing scope of the folder.
void	setTags(Collection<Tag> tags) Tags for the folder.
String	toString() Returns a string representation of this object.
CreateFolderRequest	withAwsAccountId(String awsAccountId) The ID for the Amazon Web Services account where you want to create the folder.
CreateFolderRequest	withFolderId(String folderId) The ID of the folder.
CreateFolderRequest	withFolderType(FolderType folderType) The type of folder.
CreateFolderRequest	withFolderType(String folderType) The type of folder.
CreateFolderRequest	withName(String name) The name of the folder.
CreateFolderRequest	withParentFolderArn(String parentFolderArn) The Amazon Resource Name (ARN) for the parent folder.
CreateFolderRequest	withPermissions(Collection<ResourcePermission> permissions) A structure that describes the principals and the resource-level permissions of a folder.
CreateFolderRequest	withPermissions(ResourcePermission... permissions) A structure that describes the principals and the resource-level permissions of a folder.
CreateFolderRequest	withSharingModel(SharingModel sharingModel) An optional parameter that determines the sharing scope of the folder.
CreateFolderRequest	withSharingModel(String sharingModel) An optional parameter that determines the sharing scope of the folder.
CreateFolderRequest	withTags(Collection<Tag> tags) Tags for the folder.
CreateFolderRequest	withTags(Tag... tags) Tags for the folder.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateFolderRequest

public CreateFolderRequest()

Method Detail

setAwsAccountId

public void setAwsAccountId(String awsAccountId)

The ID for the Amazon Web Services account where you want to create the folder.

Parameters:

awsAccountId - The ID for the Amazon Web Services account where you want to create the folder.

getAwsAccountId

public String getAwsAccountId()

The ID for the Amazon Web Services account where you want to create the folder.

Returns:

The ID for the Amazon Web Services account where you want to create the folder.

withAwsAccountId

public CreateFolderRequest withAwsAccountId(String awsAccountId)

The ID for the Amazon Web Services account where you want to create the folder.

Parameters:

awsAccountId - The ID for the Amazon Web Services account where you want to create the folder.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFolderId

public void setFolderId(String folderId)

The ID of the folder.

Parameters:

folderId - The ID of the folder.

getFolderId

public String getFolderId()

The ID of the folder.

Returns:

The ID of the folder.

withFolderId

public CreateFolderRequest withFolderId(String folderId)

The ID of the folder.

Parameters:

folderId - The ID of the folder.

Returns:

Returns a reference to this object so that method calls can be chained together.

setName

public void setName(String name)

The name of the folder.

Parameters:

name - The name of the folder.

getName

public String getName()

The name of the folder.

Returns:

The name of the folder.

withName

public CreateFolderRequest withName(String name)

The name of the folder.

Parameters:

name - The name of the folder.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFolderType

public void setFolderType(String folderType)

The type of folder. By default, folderType is SHARED.

Parameters:

folderType - The type of folder. By default, folderType is SHARED.

See Also:

FolderType

getFolderType

public String getFolderType()

The type of folder. By default, folderType is SHARED.

Returns:

The type of folder. By default, folderType is SHARED.

See Also:

FolderType

withFolderType

public CreateFolderRequest withFolderType(String folderType)

The type of folder. By default, folderType is SHARED.

Parameters:

folderType - The type of folder. By default, folderType is SHARED.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FolderType

withFolderType

public CreateFolderRequest withFolderType(FolderType folderType)

The type of folder. By default, folderType is SHARED.

Parameters:

folderType - The type of folder. By default, folderType is SHARED.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

FolderType

setParentFolderArn

public void setParentFolderArn(String parentFolderArn)

The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

Parameters:

parentFolderArn - The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

getParentFolderArn

public String getParentFolderArn()

The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

Returns:

The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

withParentFolderArn

public CreateFolderRequest withParentFolderArn(String parentFolderArn)

The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

Parameters:

parentFolderArn - The Amazon Resource Name (ARN) for the parent folder.

ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.

Returns:

Returns a reference to this object so that method calls can be chained together.

getPermissions

public List<ResourcePermission> getPermissions()

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions.

Returns:

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions.

setPermissions

public void setPermissions(Collection<ResourcePermission> permissions)

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions.

Parameters:

permissions - A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions.

withPermissions

public CreateFolderRequest withPermissions(ResourcePermission... 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 setPermissions(java.util.Collection) or withPermissions(java.util.Collection) if you want to override the existing values.

Parameters:

permissions - A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions.

Returns:

Returns a reference to this object so that method calls can be chained together.

withPermissions

public CreateFolderRequest withPermissions(Collection<ResourcePermission> permissions)

A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions.

Parameters:

permissions - A structure that describes the principals and the resource-level permissions of a folder.

To specify no permissions, omit Permissions.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

Tags for the folder.

Returns:

Tags for the folder.

setTags

public void setTags(Collection<Tag> tags)

Tags for the folder.

Parameters:

tags - Tags for the folder.

withTags

public CreateFolderRequest withTags(Tag... tags)

Tags for the folder.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Tags for the folder.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateFolderRequest withTags(Collection<Tag> tags)

Tags for the folder.

Parameters:

tags - Tags for the folder.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSharingModel

public void setSharingModel(String sharingModel)

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

Parameters:

sharingModel - An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

See Also:

SharingModel

getSharingModel

public String getSharingModel()

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

Returns:

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

See Also:

SharingModel

withSharingModel

public CreateFolderRequest withSharingModel(String sharingModel)

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

Parameters:

sharingModel - An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SharingModel

withSharingModel

public CreateFolderRequest withSharingModel(SharingModel sharingModel)

An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

Parameters:

sharingModel - An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SharingModel

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateFolderRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()