Class CreateFolderRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.quicksight.model.QuickSightRequest
-
- software.amazon.awssdk.services.quicksight.model.CreateFolderRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateFolderRequest.Builder,CreateFolderRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateFolderRequest extends QuickSightRequest implements ToCopyableBuilder<CreateFolderRequest.Builder,CreateFolderRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateFolderRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
awsAccountId()
The ID for the Amazon Web Services account where you want to create the folder.static CreateFolderRequest.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
folderId()
The ID of the folder.FolderType
folderType()
The type of folder.String
folderTypeAsString()
The type of folder.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasPermissions()
For responses, this returns true if the service returned a value for the Permissions property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.String
name()
The name of the folder.String
parentFolderArn()
The Amazon Resource Name (ARN) for the parent folder.List<ResourcePermission>
permissions()
A structure that describes the principals and the resource-level permissions of a folder.List<SdkField<?>>
sdkFields()
static Class<? extends CreateFolderRequest.Builder>
serializableBuilderClass()
SharingModel
sharingModel()
An optional parameter that determines the sharing scope of the folder.String
sharingModelAsString()
An optional parameter that determines the sharing scope of the folder.List<Tag>
tags()
Tags for the folder.CreateFolderRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
awsAccountId
public final String awsAccountId()
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.
-
folderId
public final String folderId()
The ID of the folder.
- Returns:
- The ID of the folder.
-
name
public final String name()
The name of the folder.
- Returns:
- The name of the folder.
-
folderType
public final FolderType folderType()
The type of folder. By default,
folderType
isSHARED
.If the service returns an enum value that is not available in the current SDK version,
folderType
will returnFolderType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfolderTypeAsString()
.- Returns:
- The type of folder. By default,
folderType
isSHARED
. - See Also:
FolderType
-
folderTypeAsString
public final String folderTypeAsString()
The type of folder. By default,
folderType
isSHARED
.If the service returns an enum value that is not available in the current SDK version,
folderType
will returnFolderType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromfolderTypeAsString()
.- Returns:
- The type of folder. By default,
folderType
isSHARED
. - See Also:
FolderType
-
parentFolderArn
public final String parentFolderArn()
The Amazon Resource Name (ARN) for the parent folder.
ParentFolderArn
can be null. An emptyparentFolderArn
creates a root-level folder.- Returns:
- The Amazon Resource Name (ARN) for the parent folder.
ParentFolderArn
can be null. An emptyparentFolderArn
creates a root-level folder.
-
hasPermissions
public final boolean hasPermissions()
For responses, this returns true if the service returned a value for the Permissions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
permissions
public final List<ResourcePermission> permissions()
A structure that describes the principals and the resource-level permissions of a folder.
To specify no permissions, omit
Permissions
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPermissions()
method.- Returns:
- A structure that describes the principals and the resource-level permissions of a folder.
To specify no permissions, omit
Permissions
.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final List<Tag> tags()
Tags for the folder.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- Tags for the folder.
-
sharingModel
public final SharingModel sharingModel()
An optional parameter that determines the sharing scope of the folder. The default value for this parameter is
ACCOUNT
.If the service returns an enum value that is not available in the current SDK version,
sharingModel
will returnSharingModel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsharingModelAsString()
.- Returns:
- An optional parameter that determines the sharing scope of the folder. The default value for this
parameter is
ACCOUNT
. - See Also:
SharingModel
-
sharingModelAsString
public final String sharingModelAsString()
An optional parameter that determines the sharing scope of the folder. The default value for this parameter is
ACCOUNT
.If the service returns an enum value that is not available in the current SDK version,
sharingModel
will returnSharingModel.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsharingModelAsString()
.- Returns:
- An optional parameter that determines the sharing scope of the folder. The default value for this
parameter is
ACCOUNT
. - See Also:
SharingModel
-
toBuilder
public CreateFolderRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateFolderRequest.Builder,CreateFolderRequest>
- Specified by:
toBuilder
in classQuickSightRequest
-
builder
public static CreateFolderRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateFolderRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-