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) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
boolean	hasPolicyLevels() Returns true if the PolicyLevels property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() Take this object and create a builder that contains all of the current property values of this object.
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

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.

You can use hasPolicyLevels() to see if a value was sent in this field.

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()

Returns true if the PolicyLevels property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasPolicyLevels() to see if a value was sent in this field.

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()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListReviewPolicyResultsForHitRequest.Builder,ListReviewPolicyResultsForHitRequest>

Specified by:

toBuilder in class MTurkRequest

Returns:

a builder for type T

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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.