software.amazon.awssdk.services.mturk.model

Class ListReviewPolicyResultsForHitRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.mturk.model.MTurkRequest

software.amazon.awssdk.services.mturk.model.ListReviewPolicyResultsForHitRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListReviewPolicyResultsForHitRequest.Builder,ListReviewPolicyResultsForHitRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListReviewPolicyResultsForHitRequest
extends MTurkRequest
implements ToCopyableBuilder<ListReviewPolicyResultsForHitRequest.Builder,ListReviewPolicyResultsForHitRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListReviewPolicyResultsForHitRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListReviewPolicyResultsForHitRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPolicyLevels() For responses, this returns true if the service returned a value for the PolicyLevels property.
String	hitId() The unique identifier of the HIT to retrieve review results for.
Integer	maxResults() Limit the number of results returned.
String	nextToken() Pagination token
List<ReviewPolicyLevel>	policyLevels() The Policy Level(s) to retrieve review results for - HIT or Assignment.
List<String>	policyLevelsAsStrings() The Policy Level(s) to retrieve review results for - HIT or Assignment.
Boolean	retrieveActions() Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes.
Boolean	retrieveResults() Specify if the operation should retrieve a list of the results computed by the Review Policies.
List<SdkField<?>>	sdkFields()
static Class<? extends ListReviewPolicyResultsForHitRequest.Builder>	serializableBuilderClass()
ListReviewPolicyResultsForHitRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

hitId

public final String hitId()

The unique identifier of the HIT to retrieve review results for.

Returns:

The unique identifier of the HIT to retrieve review results for.

policyLevels

public final List<ReviewPolicyLevel> policyLevels()

The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies.

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

Returns:

The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies.

hasPolicyLevels

public final boolean hasPolicyLevels()

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

policyLevelsAsStrings

public final List<String> policyLevelsAsStrings()

The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies.

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

Returns:

The Policy Level(s) to retrieve review results for - HIT or Assignment. If omitted, the default behavior is to retrieve all data for both policy levels. For a list of all the described policies, see Review Policies.

retrieveActions

public final Boolean retrieveActions()

Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes.

Returns:

Specify if the operation should retrieve a list of the actions taken executing the Review Policies and their outcomes.

retrieveResults

public final Boolean retrieveResults()

Specify if the operation should retrieve a list of the results computed by the Review Policies.

Returns:

Specify if the operation should retrieve a list of the results computed by the Review Policies.

nextToken

public final String nextToken()

Pagination token

Returns:

Pagination token

maxResults

public final Integer maxResults()

Limit the number of results returned.

Returns:

Limit the number of results returned.

toBuilder

public ListReviewPolicyResultsForHitRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListReviewPolicyResultsForHitRequest.Builder,ListReviewPolicyResultsForHitRequest>

Specified by:

toBuilder in class MTurkRequest

builder

public static ListReviewPolicyResultsForHitRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo