Class Folder

java.lang.Object
software.amazon.awssdk.services.quicksight.model.Folder
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Folder.Builder,Folder>
@Generated("software.amazon.awssdk:codegen") public final class Folder extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Folder.Builder,Folder>

A folder in Amazon QuickSight.

See Also:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public Folder.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Folder.Builder,Folder>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.