Package com.basistech.rosette.apimodel.batch

Class BatchRequest.BatchRequestBuilder

java.lang.Object
com.basistech.rosette.apimodel.batch.BatchRequest.BatchRequestBuilder
Enclosing class:
BatchRequest
public static class BatchRequest.BatchRequestBuilder extends Object

  • Method Details

    • batchId

      public BatchRequest.BatchRequestBuilder batchId(String batchId)
      Returns:
      this.

    • completionCallbackUrl

      public BatchRequest.BatchRequestBuilder completionCallbackUrl(String completionCallbackUrl)
      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:
      this.

    • items

      public BatchRequest.BatchRequestBuilder items(List<BatchRequestItem> items)
      Returns:
      this.

    • batchOutputUrl

      public BatchRequest.BatchRequestBuilder batchOutputUrl(String batchOutputUrl)
      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:
      this.

    • build

      public BatchRequest build()

    • toString

      public String toString()
      Overrides:
      toString in class Object