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

Class GetDocumentResponse

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.GetDocumentResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDocumentResponse.Builder,GetDocumentResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetDocumentResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetDocumentResponse.Builder	builder()
Map<String,String>	customMetadata()	The custom metadata on the document.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCustomMetadata()	For responses, this returns true if the service returned a value for the CustomMetadata property.
int	hashCode()
DocumentMetadata	metadata()	The metadata details of the document.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDocumentResponse.Builder>	serializableBuilderClass()
GetDocumentResponse.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

metadata

public final DocumentMetadata metadata()

The metadata details of the document.

Returns:

The metadata details of the document.

hasCustomMetadata

public final boolean hasCustomMetadata()

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

customMetadata

public final Map<String,String> customMetadata()

The custom metadata on the document.

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 hasCustomMetadata() method.

Returns:

The custom metadata on the document.

toBuilder

public GetDocumentResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDocumentResponse.Builder,GetDocumentResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetDocumentResponse.Builder builder()

serializableBuilderClass

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