Constructor Detail

Method Detail

• body

   final V1ProcessParams.Builder body(V1ProcessParams.Body body)

  Sets the entire request body.

  This is generally only useful if you are already constructing the body separately. Otherwise, it's more convenient to use the top-level setters instead:

  • documentUrl

  • callbackUrl

  • documentId

  • engine

  • features

  • etc.

• documentUrl

   final V1ProcessParams.Builder documentUrl(String documentUrl)

  URL or S3 path to the document to process

• documentUrl

   final V1ProcessParams.Builder documentUrl(JsonField<String> documentUrl)

  Sets Builder.documentUrl to an arbitrary JSON value.

  You should usually call Builder.documentUrl with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• callbackUrl

   final V1ProcessParams.Builder callbackUrl(String callbackUrl)

  URL to receive completion webhook

• callbackUrl

   final V1ProcessParams.Builder callbackUrl(JsonField<String> callbackUrl)

  Sets Builder.callbackUrl to an arbitrary JSON value.

  You should usually call Builder.callbackUrl with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• documentId

   final V1ProcessParams.Builder documentId(String documentId)

  Optional custom document identifier

• documentId

   final V1ProcessParams.Builder documentId(JsonField<String> documentId)

  Sets Builder.documentId to an arbitrary JSON value.

  You should usually call Builder.documentId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• engine

   final V1ProcessParams.Builder engine(V1ProcessParams.Engine engine)

  OCR engine to use

• engine

   final V1ProcessParams.Builder engine(JsonField<V1ProcessParams.Engine> engine)

  Sets Builder.engine to an arbitrary JSON value.

  You should usually call Builder.engine with a well-typed Engine value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• features

   final V1ProcessParams.Builder features(V1ProcessParams.Features features)

  Additional processing options

• features

   final V1ProcessParams.Builder features(JsonField<V1ProcessParams.Features> features)

  Sets Builder.features to an arbitrary JSON value.

  You should usually call Builder.features with a well-typed Features value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• resultBucket

   final V1ProcessParams.Builder resultBucket(String resultBucket)

  S3 bucket to store results

• resultBucket

   final V1ProcessParams.Builder resultBucket(JsonField<String> resultBucket)

  Sets Builder.resultBucket to an arbitrary JSON value.

  You should usually call Builder.resultBucket with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• resultPrefix

   final V1ProcessParams.Builder resultPrefix(String resultPrefix)

  S3 key prefix for results

• resultPrefix

   final V1ProcessParams.Builder resultPrefix(JsonField<String> resultPrefix)

  Sets Builder.resultPrefix to an arbitrary JSON value.

  You should usually call Builder.resultPrefix with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalBodyProperties

   final V1ProcessParams.Builder additionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• putAdditionalBodyProperty

   final V1ProcessParams.Builder putAdditionalBodyProperty(String key, JsonValue value)

• putAllAdditionalBodyProperties

   final V1ProcessParams.Builder putAllAdditionalBodyProperties(Map<String, JsonValue> additionalBodyProperties)

• removeAdditionalBodyProperty

   final V1ProcessParams.Builder removeAdditionalBodyProperty(String key)

• removeAllAdditionalBodyProperties

   final V1ProcessParams.Builder removeAllAdditionalBodyProperties(Set<String> keys)

• additionalHeaders

   final V1ProcessParams.Builder additionalHeaders(Headers additionalHeaders)

• additionalHeaders

   final V1ProcessParams.Builder additionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• putAdditionalHeader

   final V1ProcessParams.Builder putAdditionalHeader(String name, String value)

• putAdditionalHeaders

   final V1ProcessParams.Builder putAdditionalHeaders(String name, Iterable<String> values)

• putAllAdditionalHeaders

   final V1ProcessParams.Builder putAllAdditionalHeaders(Headers additionalHeaders)

• putAllAdditionalHeaders

   final V1ProcessParams.Builder putAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• replaceAdditionalHeaders

   final V1ProcessParams.Builder replaceAdditionalHeaders(String name, String value)

• replaceAdditionalHeaders

   final V1ProcessParams.Builder replaceAdditionalHeaders(String name, Iterable<String> values)

• replaceAllAdditionalHeaders

   final V1ProcessParams.Builder replaceAllAdditionalHeaders(Headers additionalHeaders)

• replaceAllAdditionalHeaders

   final V1ProcessParams.Builder replaceAllAdditionalHeaders(Map<String, Iterable<String>> additionalHeaders)

• removeAdditionalHeaders

   final V1ProcessParams.Builder removeAdditionalHeaders(String name)

• removeAllAdditionalHeaders

   final V1ProcessParams.Builder removeAllAdditionalHeaders(Set<String> names)

• additionalQueryParams

   final V1ProcessParams.Builder additionalQueryParams(QueryParams additionalQueryParams)

• additionalQueryParams

   final V1ProcessParams.Builder additionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• putAdditionalQueryParam

   final V1ProcessParams.Builder putAdditionalQueryParam(String key, String value)

• putAdditionalQueryParams

   final V1ProcessParams.Builder putAdditionalQueryParams(String key, Iterable<String> values)

• putAllAdditionalQueryParams

   final V1ProcessParams.Builder putAllAdditionalQueryParams(QueryParams additionalQueryParams)

• putAllAdditionalQueryParams

   final V1ProcessParams.Builder putAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• replaceAdditionalQueryParams

   final V1ProcessParams.Builder replaceAdditionalQueryParams(String key, String value)

• replaceAdditionalQueryParams

   final V1ProcessParams.Builder replaceAdditionalQueryParams(String key, Iterable<String> values)

• replaceAllAdditionalQueryParams

   final V1ProcessParams.Builder replaceAllAdditionalQueryParams(QueryParams additionalQueryParams)

• replaceAllAdditionalQueryParams

   final V1ProcessParams.Builder replaceAllAdditionalQueryParams(Map<String, Iterable<String>> additionalQueryParams)

• removeAdditionalQueryParams

   final V1ProcessParams.Builder removeAdditionalQueryParams(String key)

• removeAllAdditionalQueryParams

   final V1ProcessParams.Builder removeAllAdditionalQueryParams(Set<String> keys)

• build

   final V1ProcessParams build()

  Returns an immutable instance of V1ProcessParams.

  Further updates to this Builder will not mutate the returned instance.

  The following fields are required:

  .documentUrl()