Package software.amazon.awssdk.services.mturk.model

Class CreateHitRequest

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.CreateHitRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateHitRequest.Builder,CreateHitRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateHitRequest extends MTurkRequest implements ToCopyableBuilder<CreateHitRequest.Builder,CreateHitRequest>

  • Method Details

    • maxAssignments

      public final Integer maxAssignments()

      The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

      Returns:
      The number of times the HIT can be accepted and completed before the HIT becomes unavailable.

    • autoApprovalDelayInSeconds

      public final Long autoApprovalDelayInSeconds()

      The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.

      Returns:
      The number of seconds after an assignment for the HIT has been submitted, after which the assignment is considered Approved automatically unless the Requester explicitly rejects it.

    • lifetimeInSeconds

      public final Long lifetimeInSeconds()

      An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted.

      Returns:
      An amount of time, in seconds, after which the HIT is no longer available for users to accept. After the lifetime of the HIT elapses, the HIT no longer appears in HIT searches, even if not all of the assignments for the HIT have been accepted.

    • assignmentDurationInSeconds

      public final Long assignmentDurationInSeconds()

      The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept.

      Returns:
      The amount of time, in seconds, that a Worker has to complete the HIT after accepting it. If a Worker does not complete the assignment within the specified duration, the assignment is considered abandoned. If the HIT is still active (that is, its lifetime has not elapsed), the assignment becomes available for other users to find and accept.

    • reward

      public final String reward()

      The amount of money the Requester will pay a Worker for successfully completing the HIT.

      Returns:
      The amount of money the Requester will pay a Worker for successfully completing the HIT.

    • title

      public final String title()

      The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

      Returns:
      The title of the HIT. A title should be short and descriptive about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT title appears in search results, and everywhere the HIT is mentioned.

    • keywords

      public final String keywords()

      One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.

      Returns:
      One or more words or phrases that describe the HIT, separated by commas. These words are used in searches to find HITs.

    • description

      public final String description()

      A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

      Returns:
      A general description of the HIT. A description includes detailed information about the kind of task the HIT contains. On the Amazon Mechanical Turk web site, the HIT description appears in the expanded view of search results, and in the HIT and assignment screens. A good description gives the user enough information to evaluate the HIT before accepting it.

    • question

      public final String question()

      The data the person completing the HIT uses to produce the results.

      Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

      Either a Question parameter or a HITLayoutId parameter must be provided.

      Returns:
      The data the person completing the HIT uses to produce the results.

      Constraints: Must be a QuestionForm data structure, an ExternalQuestion data structure, or an HTMLQuestion data structure. The XML question data must not be larger than 64 kilobytes (65,535 bytes) in size, including whitespace.

      Either a Question parameter or a HITLayoutId parameter must be provided.

    • requesterAnnotation

      public final String requesterAnnotation()

      An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

      The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

      The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

      Returns:
      An arbitrary data field. The RequesterAnnotation parameter lets your application attach arbitrary data to the HIT for tracking purposes. For example, this parameter could be an identifier internal to the Requester's application that corresponds with the HIT.

      The RequesterAnnotation parameter for a HIT is only visible to the Requester who created the HIT. It is not shown to the Worker, or any other Requester.

      The RequesterAnnotation parameter may be different for each HIT you submit. It does not affect how your HITs are grouped.

    • hasQualificationRequirements

      public final boolean hasQualificationRequirements()
      For responses, this returns true if the service returned a value for the QualificationRequirements 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.

    • qualificationRequirements

      public final List<QualificationRequirement> qualificationRequirements()

      Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

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

      Returns:
      Conditions that a Worker's Qualifications must meet in order to accept the HIT. A HIT can have between zero and ten Qualification requirements. All requirements must be met in order for a Worker to accept the HIT. Additionally, other actions can be restricted using the ActionsGuarded field on each QualificationRequirement structure.

    • uniqueRequestToken

      public final String uniqueRequestToken()

      A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

      Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

      Returns:
      A unique identifier for this request which allows you to retry the call on error without creating duplicate HITs. This is useful in cases such as network timeouts where it is unclear whether or not the call succeeded on the server. If the HIT already exists in the system from a previous call using the same UniqueRequestToken, subsequent calls will return a AWS.MechanicalTurk.HitAlreadyExists error with a message containing the HITId.

      Note: It is your responsibility to ensure uniqueness of the token. The unique token expires after 24 hours. Subsequent calls using the same UniqueRequestToken made after the 24 hour limit could create duplicate HITs.

    • assignmentReviewPolicy

      public final ReviewPolicy assignmentReviewPolicy()

      The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

      Returns:
      The Assignment-level Review Policy applies to the assignments under the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

    • hitReviewPolicy

      public final ReviewPolicy hitReviewPolicy()

      The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

      Returns:
      The HIT-level Review Policy applies to the HIT. You can specify for Mechanical Turk to take various actions based on the policy.

    • hitLayoutId

      public final String hitLayoutId()

      The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

      Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

      Returns:
      The HITLayoutId allows you to use a pre-existing HIT design with placeholder values and create an additional HIT by providing those values as HITLayoutParameters.

      Constraints: Either a Question parameter or a HITLayoutId parameter must be provided.

    • hasHitLayoutParameters

      public final boolean hasHitLayoutParameters()
      For responses, this returns true if the service returned a value for the HITLayoutParameters 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.

    • hitLayoutParameters

      public final List<HITLayoutParameter> hitLayoutParameters()

      If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

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

      Returns:
      If the HITLayoutId is provided, any placeholder values must be filled in with values using the HITLayoutParameter structure. For more information, see HITLayout.

    • toBuilder

      public CreateHitRequest.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<CreateHitRequest.Builder,CreateHitRequest>
      Specified by:
      toBuilder in class MTurkRequest
      Returns:
      a builder for type T

    • builder

      public static CreateHitRequest.Builder builder()

    • serializableBuilderClass

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