software.amazon.awssdk.services.ssm.model

Class DocumentReviews

java.lang.Object

software.amazon.awssdk.services.ssm.model.DocumentReviews

All Implemented Interfaces:

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

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

Information about a document approval review.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DocumentReviews.Builder

Method Summary

Modifier and Type	Method and Description
DocumentReviewAction	action() The action to take on a document approval review request.
String	actionAsString() The action to take on a document approval review request.
static DocumentReviews.Builder	builder()
List<DocumentReviewCommentSource>	comment() A comment entered by a user in your organization about the document review request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasComment() For responses, this returns true if the service returned a value for the Comment property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentReviews.Builder>	serializableBuilderClass()
DocumentReviews.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

action

public final DocumentReviewAction action()

The action to take on a document approval review request.

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

Returns:

The action to take on a document approval review request.

See Also:

DocumentReviewAction

actionAsString

public final String actionAsString()

The action to take on a document approval review request.

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

Returns:

The action to take on a document approval review request.

See Also:

DocumentReviewAction

hasComment

public final boolean hasComment()

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

comment

public final List<DocumentReviewCommentSource> comment()

A comment entered by a user in your organization about the document review request.

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

Returns:

A comment entered by a user in your organization about the document review request.

toBuilder

public DocumentReviews.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentReviews.Builder,DocumentReviews>

builder

public static DocumentReviews.Builder builder()

serializableBuilderClass

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