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

Class ResponseItem

java.lang.Object

software.amazon.awssdk.services.workdocs.model.ResponseItem

All Implemented Interfaces:

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

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

List of Documents, Folders, Comments, and Document Versions matching the query.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ResponseItem.Builder

Method Summary

Modifier and Type	Method	Description
static ResponseItem.Builder	builder()
CommentMetadata	commentMetadata()	The comment that matches the query.
DocumentMetadata	documentMetadata()	The document that matches the query.
DocumentVersionMetadata	documentVersionMetadata()	The document version that matches the metadata.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FolderMetadata	folderMetadata()	The folder that matches the query.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ResponseItemType	resourceType()	The type of item being returned.
String	resourceTypeAsString()	The type of item being returned.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ResponseItem.Builder>	serializableBuilderClass()
ResponseItem.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	webUrl()	The webUrl of the item being returned.

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

resourceType

public final ResponseItemType resourceType()

The type of item being returned.

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

Returns:

The type of item being returned.

See Also:

ResponseItemType

resourceTypeAsString

public final String resourceTypeAsString()

The type of item being returned.

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

Returns:

The type of item being returned.

See Also:

ResponseItemType

webUrl

public final String webUrl()

The webUrl of the item being returned.

Returns:

The webUrl of the item being returned.

documentMetadata

public final DocumentMetadata documentMetadata()

The document that matches the query.

Returns:

The document that matches the query.

folderMetadata

public final FolderMetadata folderMetadata()

The folder that matches the query.

Returns:

The folder that matches the query.

commentMetadata

public final CommentMetadata commentMetadata()

The comment that matches the query.

Returns:

The comment that matches the query.

documentVersionMetadata

public final DocumentVersionMetadata documentVersionMetadata()

The document version that matches the metadata.

Returns:

The document version that matches the metadata.

toBuilder

public ResponseItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ResponseItem.Builder,ResponseItem>

builder

public static ResponseItem.Builder builder()

serializableBuilderClass

public static Class<? extends ResponseItem.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo