Package com.basistech.rosette.apimodel.batch

Class BatchRequest

java.lang.Object
com.basistech.rosette.apimodel.batch.BatchRequest
public final class BatchRequest extends Object
Define a batch job. Serialize this object to json to create a file that requests a job.

  • Method Details

    • builder

      public static BatchRequest.BatchRequestBuilder builder()

    • getBatchId

      public String getBatchId()
      Returns:
      id an ID string.

    • getCompletionCallbackUrl

      public String getCompletionCallbackUrl()
      A URL for RosetteAPI to call to inform you the completion of the batch. It must be accessible on the Internet and can only be http: or https:. RosetteAPI will use the GET method so optional parameters need to be included as query parameters in the URL.
      Returns:
      completionCallbackUrl a URL for RosetteAPI to call when batch completes

    • getItems

      public List<BatchRequestItem> getItems()
      Returns:
      list of batch request items

    • getBatchOutputUrl

      public String getBatchOutputUrl()
      Specifies where the results should be stored. Only a valid AWS S3 URL is supported at this time. The S3 bucket needs to have a proper policy statement to grant read/write permission to RosetteAPI within the batch processing time window. RosetteAPI's AWS account number is 625892746452. Example policy statement: 
           
         {
            "Version": "2012-10-17",
            "Id": "Policy1462373421611",
            "Statement": [
                {
                    "Sid": "Stmt1462373415064",
                    "Effect": "Allow",
                    "Principal": {
                        "AWS": "arn:aws:iam::625892746452:root"
                    },
                    "Action": "s3:ListBucket",
                    "Resource": "arn:aws:s3:::your-bucket-name",
                    "Condition": {
                        "StringLike": {
                           "s3:prefix": [
                               "output-folder-name/*"
                           ]
                        }
                    }
                },
                {
                    "Sid": "Stmt1462373415064",
                    "Effect": "Allow",
                    "Principal": {
                        "AWS": "arn:aws:iam::625892746452:root"
                    },
                    "Action": [
                        "s3:GetObject",
                        "s3:PutObject",
                        "s3:DeleteObject"
                    ],
                    "Resource": "arn:aws:s3:::your-bucket-name/output-folder-name/*"
                }
            ]
        }
      Returns:
      batchOutputUrl AWS S3 URL where results will be saved

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object