Class CreateFolderRequest

    • 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 is SHARED.

        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. By default, folderType is SHARED.
        See Also:
        FolderType
      • folderTypeAsString

        public final String folderTypeAsString()

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

        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. By default, folderType is SHARED.
        See Also:
        FolderType
      • parentFolderArn

        public final String parentFolderArn()

        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.

      • 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 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.
      • 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 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.
      • 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 return SharingModel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sharingModelAsString().

        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 return SharingModel.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sharingModelAsString().

        Returns:
        An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.
        See Also:
        SharingModel
      • 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