Package software.amazon.awssdk.services.workdocs.model

Class DescribeFolderContentsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.workdocs.model.WorkDocsResponse

software.amazon.awssdk.services.workdocs.model.DescribeFolderContentsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeFolderContentsResponse.Builder,DescribeFolderContentsResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeFolderContentsResponse
extends WorkDocsResponse
implements ToCopyableBuilder<DescribeFolderContentsResponse.Builder,DescribeFolderContentsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeFolderContentsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeFolderContentsResponse.Builder	builder()
List<DocumentMetadata>	documents()	The documents in the specified folder.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<FolderMetadata>	folders()	The subfolders in the specified folder.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDocuments()	For responses, this returns true if the service returned a value for the Documents property.
boolean	hasFolders()	For responses, this returns true if the service returned a value for the Folders property.
int	hashCode()
String	marker()	The marker to use when requesting the next set of results.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeFolderContentsResponse.Builder>	serializableBuilderClass()
DescribeFolderContentsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.workdocs.model.WorkDocsResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasFolders

public final boolean hasFolders()

For responses, this returns true if the service returned a value for the Folders 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.

folders

public final List<FolderMetadata> folders()

The subfolders in the specified 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 hasFolders() method.

Returns:

The subfolders in the specified folder.

hasDocuments

public final boolean hasDocuments()

For responses, this returns true if the service returned a value for the Documents 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.

documents

public final List<DocumentMetadata> documents()

The documents in the specified 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 hasDocuments() method.

Returns:

The documents in the specified folder.

marker

public final String marker()

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

Returns:

The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

toBuilder

public DescribeFolderContentsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeFolderContentsResponse.Builder,DescribeFolderContentsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static DescribeFolderContentsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo