Class CreateBatchOptions

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.watson.compare_comply.v1.model.CreateBatchOptions
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel

public class CreateBatchOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel
The createBatch options.
  • Method Details

    • newBuilder

      public CreateBatchOptions.Builder newBuilder()
      New builder.
      Returns:
      a CreateBatchOptions builder
    • function

      public String function()
      Gets the function.

      The Compare and Comply method to run across the submitted input documents.

      Returns:
      the function
    • inputCredentialsFile

      public InputStream inputCredentialsFile()
      Gets the inputCredentialsFile.

      A JSON file containing the input Cloud Object Storage credentials. At a minimum, the credentials must enable `READ` permissions on the bucket defined by the `input_bucket_name` parameter.

      Returns:
      the inputCredentialsFile
    • inputBucketLocation

      public String inputBucketLocation()
      Gets the inputBucketLocation.

      The geographical location of the Cloud Object Storage input bucket as listed on the **Endpoint** tab of your Cloud Object Storage instance; for example, `us-geo`, `eu-geo`, or `ap-geo`.

      Returns:
      the inputBucketLocation
    • inputBucketName

      public String inputBucketName()
      Gets the inputBucketName.

      The name of the Cloud Object Storage input bucket.

      Returns:
      the inputBucketName
    • outputCredentialsFile

      public InputStream outputCredentialsFile()
      Gets the outputCredentialsFile.

      A JSON file that lists the Cloud Object Storage output credentials. At a minimum, the credentials must enable `READ` and `WRITE` permissions on the bucket defined by the `output_bucket_name` parameter.

      Returns:
      the outputCredentialsFile
    • outputBucketLocation

      public String outputBucketLocation()
      Gets the outputBucketLocation.

      The geographical location of the Cloud Object Storage output bucket as listed on the **Endpoint** tab of your Cloud Object Storage instance; for example, `us-geo`, `eu-geo`, or `ap-geo`.

      Returns:
      the outputBucketLocation
    • outputBucketName

      public String outputBucketName()
      Gets the outputBucketName.

      The name of the Cloud Object Storage output bucket.

      Returns:
      the outputBucketName
    • model

      public String model()
      Gets the model.

      The analysis model to be used by the service. For the **Element classification** and **Compare two documents** methods, the default is `contracts`. For the **Extract tables** method, the default is `tables`. These defaults apply to the standalone methods as well as to the methods' use in batch-processing requests.

      Returns:
      the model