software.amazon.awssdk.services.quicksight.model

Class Folder

java.lang.Object

software.amazon.awssdk.services.quicksight.model.Folder

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Folder.Builder,Folder>

@Generated(value="software.amazon.awssdk:codegen")
public final class Folder
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Folder.Builder,Folder>

A folder in Amazon QuickSight.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Folder.Builder

Method Summary

Modifier and Type	Method and Description
String	arn() The Amazon Resource Name (ARN) for the folder.
static Folder.Builder	builder()
Instant	createdTime() The time that the folder was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	folderId() The ID of the folder.
List<String>	folderPath() An array of ancestor ARN strings for the folder.
FolderType	folderType() The type of folder it is.
String	folderTypeAsString() The type of folder it is.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFolderPath() For responses, this returns true if the service returned a value for the FolderPath property.
int	hashCode()
Instant	lastUpdatedTime() The time that the folder was last updated.
String	name() A display name for the folder.
List<SdkField<?>>	sdkFields()
static Class<? extends Folder.Builder>	serializableBuilderClass()
SharingModel	sharingModel() The sharing scope of the folder.
String	sharingModelAsString() The sharing scope of the folder.
Folder.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

folderId

public final String folderId()

The ID of the folder.

Returns:

The ID of the folder.

arn

public final String arn()

The Amazon Resource Name (ARN) for the folder.

Returns:

The Amazon Resource Name (ARN) for the folder.

name

public final String name()

A display name for the folder.

Returns:

A display name for the folder.

folderType

public final FolderType folderType()

The type of folder it is.

If the service returns an enum value that is not available in the current SDK version, folderType will return FolderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from folderTypeAsString().

Returns:

The type of folder it is.

See Also:

FolderType

folderTypeAsString

public final String folderTypeAsString()

The type of folder it is.

If the service returns an enum value that is not available in the current SDK version, folderType will return FolderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from folderTypeAsString().

Returns:

The type of folder it is.

See Also:

FolderType

hasFolderPath

public final boolean hasFolderPath()

For responses, this returns true if the service returned a value for the FolderPath property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

folderPath

public final List<String> folderPath()

An array of ancestor ARN strings 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 hasFolderPath() method.

Returns:

An array of ancestor ARN strings for the folder.

createdTime

public final Instant createdTime()

The time that the folder was created.

Returns:

The time that the folder was created.

lastUpdatedTime

public final Instant lastUpdatedTime()

The time that the folder was last updated.

Returns:

The time that the folder was last updated.

sharingModel

public final SharingModel sharingModel()

The sharing scope of the folder.

If the service returns an enum value that is not available in the current SDK version, sharingModel will return SharingModel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sharingModelAsString().

Returns:

The sharing scope of the folder.

See Also:

SharingModel

sharingModelAsString

public final String sharingModelAsString()

The sharing scope of the folder.

If the service returns an enum value that is not available in the current SDK version, sharingModel will return SharingModel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sharingModelAsString().

Returns:

The sharing scope of the folder.

See Also:

SharingModel

toBuilder

public Folder.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Folder.Builder,Folder>

builder

public static Folder.Builder builder()

serializableBuilderClass

public static Class<? extends Folder.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo