FolderMetadata (AWS Java SDK :: Services :: Amazon WorkDocs 2.20.111 API)

java.lang.Object
- software.amazon.awssdk.services.workdocs.model.FolderMetadata

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<FolderMetadata.Builder,FolderMetadata>

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

Describes a folder.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface FolderMetadata.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`FolderMetadata.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static FolderMetadata.Builder`	`builder()`
`Instant`	`createdTimestamp()` The time when the folder was created.
`String`	`creatorId()` The ID of the creator.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasLabels()` For responses, this returns true if the service returned a value for the Labels property.
`String`	`id()` The ID of the folder.
`List<String>`	`labels()` List of labels on the folder.
`Long`	`latestVersionSize()` The size of the latest version of the folder metadata.
`Instant`	`modifiedTimestamp()` The time when the folder was updated.
`String`	`name()` The name of the folder.
`String`	`parentFolderId()` The ID of the parent folder.
`ResourceStateType`	`resourceState()` The resource state of the folder.
`String`	`resourceStateAsString()` The resource state of the folder.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends FolderMetadata.Builder>`	`serializableBuilderClass()`
`String`	`signature()` The unique identifier created from the subfolders and documents of the folder.
`Long`	`size()` The size of the folder metadata.
`FolderMetadata.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
  - id
```
public final String id()
```
    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.
  - creatorId
```
public final String creatorId()
```
    The ID of the creator.
    
    Returns:
    
    The ID of the creator.
  - parentFolderId
```
public final String parentFolderId()
```
    The ID of the parent folder.
    
    Returns:
    
    The ID of the parent folder.
  - createdTimestamp
```
public final Instant createdTimestamp()
```
    The time when the folder was created.
    
    Returns:
    
    The time when the folder was created.
  - modifiedTimestamp
```
public final Instant modifiedTimestamp()
```
    The time when the folder was updated.
    
    Returns:
    
    The time when the folder was updated.
  - resourceState
```
public final ResourceStateType resourceState()
```
    The resource state of the folder.
    
    If the service returns an enum value that is not available in the current SDK version, resourceState will return ResourceStateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceStateAsString().
    
    Returns:
    
    The resource state of the folder.
    
    See Also:
    
    ResourceStateType
  - resourceStateAsString
```
public final String resourceStateAsString()
```
    The resource state of the folder.
    
    If the service returns an enum value that is not available in the current SDK version, resourceState will return ResourceStateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceStateAsString().
    
    Returns:
    
    The resource state of the folder.
    
    See Also:
    
    ResourceStateType
  - signature
```
public final String signature()
```
    The unique identifier created from the subfolders and documents of the folder.
    
    Returns:
    
    The unique identifier created from the subfolders and documents of the folder.
  - hasLabels
```
public final boolean hasLabels()
```
    For responses, this returns true if the service returned a value for the Labels 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.
  - labels
```
public final List<String> labels()
```
    List of labels on 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 hasLabels() method.
    
    Returns:
    
    List of labels on the folder.
  - size
```
public final Long size()
```
    The size of the folder metadata.
    
    Returns:
    
    The size of the folder metadata.
  - latestVersionSize
```
public final Long latestVersionSize()
```
    The size of the latest version of the folder metadata.
    
    Returns:
    
    The size of the latest version of the folder metadata.
  - toBuilder
```
public FolderMetadata.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<FolderMetadata.Builder,FolderMetadata>
  - builder
```
public static FolderMetadata.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends FolderMetadata.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

Class FolderMetadata

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

name

creatorId

parentFolderId

createdTimestamp

modifiedTimestamp

resourceState

resourceStateAsString

signature

hasLabels

labels

size

latestVersionSize

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields