Interface BatchProcessRequestOrBuilder (2.57.0) 

public interface BatchProcessRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getDocumentOutputConfig()

public abstract DocumentOutputConfig getDocumentOutputConfig()

The output configuration for the BatchProcessDocuments method.

.google.cloud.documentai.v1.DocumentOutputConfig document_output_config = 6;

Returns
Type Description
DocumentOutputConfig

The documentOutputConfig.

getDocumentOutputConfigOrBuilder()

public abstract DocumentOutputConfigOrBuilder getDocumentOutputConfigOrBuilder()

The output configuration for the BatchProcessDocuments method.

.google.cloud.documentai.v1.DocumentOutputConfig document_output_config = 6;

Returns
Type Description
DocumentOutputConfigOrBuilder

getInputDocuments()

public abstract BatchDocumentsInputConfig getInputDocuments()

The input documents for the BatchProcessDocuments method.

.google.cloud.documentai.v1.BatchDocumentsInputConfig input_documents = 5;

Returns
Type Description
BatchDocumentsInputConfig

The inputDocuments.

getInputDocumentsOrBuilder()

public abstract BatchDocumentsInputConfigOrBuilder getInputDocumentsOrBuilder()

The input documents for the BatchProcessDocuments method.

.google.cloud.documentai.v1.BatchDocumentsInputConfig input_documents = 5;

Returns
Type Description
BatchDocumentsInputConfigOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. The labels with user-defined metadata for the request.

Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public abstract String getName()

Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Required. The resource name of Processor or ProcessorVersion. Format: projects/{project}/locations/{location}/processors/{processor}, or projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processorVersion}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getProcessOptions()

public abstract ProcessOptions getProcessOptions()

Inference-time options for the process API

.google.cloud.documentai.v1.ProcessOptions process_options = 7;

Returns
Type Description
ProcessOptions

The processOptions.

getProcessOptionsOrBuilder()

public abstract ProcessOptionsOrBuilder getProcessOptionsOrBuilder()

Inference-time options for the process API

.google.cloud.documentai.v1.ProcessOptions process_options = 7;

Returns
Type Description
ProcessOptionsOrBuilder

getSkipHumanReview()

public abstract boolean getSkipHumanReview()

Whether human review should be skipped for this request. Default to false.

bool skip_human_review = 4;

Returns
Type Description
boolean

The skipHumanReview.

hasDocumentOutputConfig()

public abstract boolean hasDocumentOutputConfig()

The output configuration for the BatchProcessDocuments method.

.google.cloud.documentai.v1.DocumentOutputConfig document_output_config = 6;

Returns
Type Description
boolean

Whether the documentOutputConfig field is set.

hasInputDocuments()

public abstract boolean hasInputDocuments()

The input documents for the BatchProcessDocuments method.

.google.cloud.documentai.v1.BatchDocumentsInputConfig input_documents = 5;

Returns
Type Description
boolean

Whether the inputDocuments field is set.

hasProcessOptions()

public abstract boolean hasProcessOptions()

Inference-time options for the process API

.google.cloud.documentai.v1.ProcessOptions process_options = 7;

Returns
Type Description
boolean

Whether the processOptions field is set.