Package com.google.cloud.documentai.v1beta2

Class ProcessDocumentRequest.Builder

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessDocumentRequest.Builder>

      • clear

        public ProcessDocumentRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessDocumentRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessDocumentRequest.Builder>

      • getDefaultInstanceForType

        public ProcessDocumentRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public ProcessDocumentRequest build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public ProcessDocumentRequest buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public ProcessDocumentRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessDocumentRequest.Builder>

      • clearField

        public ProcessDocumentRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessDocumentRequest.Builder>

      • clearOneof

        public ProcessDocumentRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessDocumentRequest.Builder>

      • setRepeatedField

        public ProcessDocumentRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       int index,
                                                       Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessDocumentRequest.Builder>

      • addRepeatedField

        public ProcessDocumentRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                       Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessDocumentRequest.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessDocumentRequest.Builder>

      • mergeFrom

        public ProcessDocumentRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ProcessDocumentRequest.Builder>
        Throws:
        IOException

      • getParent

        public String getParent()
         Target project and location to make a call.

 Format: `projects/{project-id}/locations/{location-id}`.

 If no location is specified, a region will be chosen automatically.
 This field is only populated when used in ProcessDocument method.
        string parent = 9;
        Specified by:
        getParent in interface ProcessDocumentRequestOrBuilder
        Returns:
        The parent.

      • getParentBytes

        public com.google.protobuf.ByteString getParentBytes()
         Target project and location to make a call.

 Format: `projects/{project-id}/locations/{location-id}`.

 If no location is specified, a region will be chosen automatically.
 This field is only populated when used in ProcessDocument method.
        string parent = 9;
        Specified by:
        getParentBytes in interface ProcessDocumentRequestOrBuilder
        Returns:
        The bytes for parent.

      • setParent

        public ProcessDocumentRequest.Builder setParent​(String value)
         Target project and location to make a call.

 Format: `projects/{project-id}/locations/{location-id}`.

 If no location is specified, a region will be chosen automatically.
 This field is only populated when used in ProcessDocument method.
        string parent = 9;
        Parameters:
        value - The parent to set.
        Returns:
        This builder for chaining.

      • clearParent

        public ProcessDocumentRequest.Builder clearParent()
         Target project and location to make a call.

 Format: `projects/{project-id}/locations/{location-id}`.

 If no location is specified, a region will be chosen automatically.
 This field is only populated when used in ProcessDocument method.
        string parent = 9;
        Returns:
        This builder for chaining.

      • setParentBytes

        public ProcessDocumentRequest.Builder setParentBytes​(com.google.protobuf.ByteString value)
         Target project and location to make a call.

 Format: `projects/{project-id}/locations/{location-id}`.

 If no location is specified, a region will be chosen automatically.
 This field is only populated when used in ProcessDocument method.
        string parent = 9;
        Parameters:
        value - The bytes for parent to set.
        Returns:
        This builder for chaining.

      • hasInputConfig

        public boolean hasInputConfig()
         Required. Information about the input file.
        .google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasInputConfig in interface ProcessDocumentRequestOrBuilder
        Returns:
        Whether the inputConfig field is set.

      • getInputConfig

        public InputConfig getInputConfig()
         Required. Information about the input file.
        .google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getInputConfig in interface ProcessDocumentRequestOrBuilder
        Returns:
        The inputConfig.

      • setInputConfig

        public ProcessDocumentRequest.Builder setInputConfig​(InputConfig value)
         Required. Information about the input file.
        .google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];

      • setInputConfig

        public ProcessDocumentRequest.Builder setInputConfig​(InputConfig.Builder builderForValue)
         Required. Information about the input file.
        .google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];

      • mergeInputConfig

        public ProcessDocumentRequest.Builder mergeInputConfig​(InputConfig value)
         Required. Information about the input file.
        .google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];

      • clearInputConfig

        public ProcessDocumentRequest.Builder clearInputConfig()
         Required. Information about the input file.
        .google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];

      • getInputConfigBuilder

        public InputConfig.Builder getInputConfigBuilder()
         Required. Information about the input file.
        .google.cloud.documentai.v1beta2.InputConfig input_config = 1 [(.google.api.field_behavior) = REQUIRED];

      • hasOutputConfig

        public boolean hasOutputConfig()
         The desired output location. This field is only needed in
 BatchProcessDocumentsRequest.
        .google.cloud.documentai.v1beta2.OutputConfig output_config = 2;
        Specified by:
        hasOutputConfig in interface ProcessDocumentRequestOrBuilder
        Returns:
        Whether the outputConfig field is set.

      • getOutputConfig

        public OutputConfig getOutputConfig()
         The desired output location. This field is only needed in
 BatchProcessDocumentsRequest.
        .google.cloud.documentai.v1beta2.OutputConfig output_config = 2;
        Specified by:
        getOutputConfig in interface ProcessDocumentRequestOrBuilder
        Returns:
        The outputConfig.

      • setOutputConfig

        public ProcessDocumentRequest.Builder setOutputConfig​(OutputConfig value)
         The desired output location. This field is only needed in
 BatchProcessDocumentsRequest.
        .google.cloud.documentai.v1beta2.OutputConfig output_config = 2;

      • setOutputConfig

        public ProcessDocumentRequest.Builder setOutputConfig​(OutputConfig.Builder builderForValue)
         The desired output location. This field is only needed in
 BatchProcessDocumentsRequest.
        .google.cloud.documentai.v1beta2.OutputConfig output_config = 2;

      • mergeOutputConfig

        public ProcessDocumentRequest.Builder mergeOutputConfig​(OutputConfig value)
         The desired output location. This field is only needed in
 BatchProcessDocumentsRequest.
        .google.cloud.documentai.v1beta2.OutputConfig output_config = 2;

      • clearOutputConfig

        public ProcessDocumentRequest.Builder clearOutputConfig()
         The desired output location. This field is only needed in
 BatchProcessDocumentsRequest.
        .google.cloud.documentai.v1beta2.OutputConfig output_config = 2;

      • getOutputConfigBuilder

        public OutputConfig.Builder getOutputConfigBuilder()
         The desired output location. This field is only needed in
 BatchProcessDocumentsRequest.
        .google.cloud.documentai.v1beta2.OutputConfig output_config = 2;

      • getDocumentType

        public String getDocumentType()
         Specifies a known document type for deeper structure detection. Valid
 values are currently "general" and "invoice". If not provided, "general"\
 is used as default. If any other value is given, the request is rejected.
        string document_type = 3;
        Specified by:
        getDocumentType in interface ProcessDocumentRequestOrBuilder
        Returns:
        The documentType.

      • getDocumentTypeBytes

        public com.google.protobuf.ByteString getDocumentTypeBytes()
         Specifies a known document type for deeper structure detection. Valid
 values are currently "general" and "invoice". If not provided, "general"\
 is used as default. If any other value is given, the request is rejected.
        string document_type = 3;
        Specified by:
        getDocumentTypeBytes in interface ProcessDocumentRequestOrBuilder
        Returns:
        The bytes for documentType.

      • setDocumentType

        public ProcessDocumentRequest.Builder setDocumentType​(String value)
         Specifies a known document type for deeper structure detection. Valid
 values are currently "general" and "invoice". If not provided, "general"\
 is used as default. If any other value is given, the request is rejected.
        string document_type = 3;
        Parameters:
        value - The documentType to set.
        Returns:
        This builder for chaining.

      • clearDocumentType

        public ProcessDocumentRequest.Builder clearDocumentType()
         Specifies a known document type for deeper structure detection. Valid
 values are currently "general" and "invoice". If not provided, "general"\
 is used as default. If any other value is given, the request is rejected.
        string document_type = 3;
        Returns:
        This builder for chaining.

      • setDocumentTypeBytes

        public ProcessDocumentRequest.Builder setDocumentTypeBytes​(com.google.protobuf.ByteString value)
         Specifies a known document type for deeper structure detection. Valid
 values are currently "general" and "invoice". If not provided, "general"\
 is used as default. If any other value is given, the request is rejected.
        string document_type = 3;
        Parameters:
        value - The bytes for documentType to set.
        Returns:
        This builder for chaining.

      • hasTableExtractionParams

        public boolean hasTableExtractionParams()
         Controls table extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;
        Specified by:
        hasTableExtractionParams in interface ProcessDocumentRequestOrBuilder
        Returns:
        Whether the tableExtractionParams field is set.

      • getTableExtractionParams

        public TableExtractionParams getTableExtractionParams()
         Controls table extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;
        Specified by:
        getTableExtractionParams in interface ProcessDocumentRequestOrBuilder
        Returns:
        The tableExtractionParams.

      • setTableExtractionParams

        public ProcessDocumentRequest.Builder setTableExtractionParams​(TableExtractionParams value)
         Controls table extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;

      • setTableExtractionParams

        public ProcessDocumentRequest.Builder setTableExtractionParams​(TableExtractionParams.Builder builderForValue)
         Controls table extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;

      • mergeTableExtractionParams

        public ProcessDocumentRequest.Builder mergeTableExtractionParams​(TableExtractionParams value)
         Controls table extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;

      • clearTableExtractionParams

        public ProcessDocumentRequest.Builder clearTableExtractionParams()
         Controls table extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;

      • getTableExtractionParamsBuilder

        public TableExtractionParams.Builder getTableExtractionParamsBuilder()
         Controls table extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.TableExtractionParams table_extraction_params = 4;

      • hasFormExtractionParams

        public boolean hasFormExtractionParams()
         Controls form extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;
        Specified by:
        hasFormExtractionParams in interface ProcessDocumentRequestOrBuilder
        Returns:
        Whether the formExtractionParams field is set.

      • getFormExtractionParams

        public FormExtractionParams getFormExtractionParams()
         Controls form extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;
        Specified by:
        getFormExtractionParams in interface ProcessDocumentRequestOrBuilder
        Returns:
        The formExtractionParams.

      • setFormExtractionParams

        public ProcessDocumentRequest.Builder setFormExtractionParams​(FormExtractionParams value)
         Controls form extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;

      • setFormExtractionParams

        public ProcessDocumentRequest.Builder setFormExtractionParams​(FormExtractionParams.Builder builderForValue)
         Controls form extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;

      • mergeFormExtractionParams

        public ProcessDocumentRequest.Builder mergeFormExtractionParams​(FormExtractionParams value)
         Controls form extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;

      • clearFormExtractionParams

        public ProcessDocumentRequest.Builder clearFormExtractionParams()
         Controls form extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;

      • getFormExtractionParamsBuilder

        public FormExtractionParams.Builder getFormExtractionParamsBuilder()
         Controls form extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.FormExtractionParams form_extraction_params = 5;

      • hasEntityExtractionParams

        public boolean hasEntityExtractionParams()
         Controls entity extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;
        Specified by:
        hasEntityExtractionParams in interface ProcessDocumentRequestOrBuilder
        Returns:
        Whether the entityExtractionParams field is set.

      • getEntityExtractionParams

        public EntityExtractionParams getEntityExtractionParams()
         Controls entity extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;
        Specified by:
        getEntityExtractionParams in interface ProcessDocumentRequestOrBuilder
        Returns:
        The entityExtractionParams.

      • setEntityExtractionParams

        public ProcessDocumentRequest.Builder setEntityExtractionParams​(EntityExtractionParams value)
         Controls entity extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;

      • setEntityExtractionParams

        public ProcessDocumentRequest.Builder setEntityExtractionParams​(EntityExtractionParams.Builder builderForValue)
         Controls entity extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;

      • mergeEntityExtractionParams

        public ProcessDocumentRequest.Builder mergeEntityExtractionParams​(EntityExtractionParams value)
         Controls entity extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;

      • clearEntityExtractionParams

        public ProcessDocumentRequest.Builder clearEntityExtractionParams()
         Controls entity extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;

      • getEntityExtractionParamsBuilder

        public EntityExtractionParams.Builder getEntityExtractionParamsBuilder()
         Controls entity extraction behavior. If not specified, the system will
 decide reasonable defaults.
        .google.cloud.documentai.v1beta2.EntityExtractionParams entity_extraction_params = 6;

      • hasOcrParams

        public boolean hasOcrParams()
         Controls OCR behavior. If not specified, the system will decide reasonable
 defaults.
        .google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;
        Specified by:
        hasOcrParams in interface ProcessDocumentRequestOrBuilder
        Returns:
        Whether the ocrParams field is set.

      • getOcrParams

        public OcrParams getOcrParams()
         Controls OCR behavior. If not specified, the system will decide reasonable
 defaults.
        .google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;
        Specified by:
        getOcrParams in interface ProcessDocumentRequestOrBuilder
        Returns:
        The ocrParams.

      • setOcrParams

        public ProcessDocumentRequest.Builder setOcrParams​(OcrParams value)
         Controls OCR behavior. If not specified, the system will decide reasonable
 defaults.
        .google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;

      • setOcrParams

        public ProcessDocumentRequest.Builder setOcrParams​(OcrParams.Builder builderForValue)
         Controls OCR behavior. If not specified, the system will decide reasonable
 defaults.
        .google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;

      • mergeOcrParams

        public ProcessDocumentRequest.Builder mergeOcrParams​(OcrParams value)
         Controls OCR behavior. If not specified, the system will decide reasonable
 defaults.
        .google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;

      • clearOcrParams

        public ProcessDocumentRequest.Builder clearOcrParams()
         Controls OCR behavior. If not specified, the system will decide reasonable
 defaults.
        .google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;

      • getOcrParamsBuilder

        public OcrParams.Builder getOcrParamsBuilder()
         Controls OCR behavior. If not specified, the system will decide reasonable
 defaults.
        .google.cloud.documentai.v1beta2.OcrParams ocr_params = 7;

      • hasAutomlParams

        public boolean hasAutomlParams()
         Controls AutoML model prediction behavior. AutoMlParams cannot be used
 together with other Params.
        .google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;
        Specified by:
        hasAutomlParams in interface ProcessDocumentRequestOrBuilder
        Returns:
        Whether the automlParams field is set.

      • getAutomlParams

        public AutoMlParams getAutomlParams()
         Controls AutoML model prediction behavior. AutoMlParams cannot be used
 together with other Params.
        .google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;
        Specified by:
        getAutomlParams in interface ProcessDocumentRequestOrBuilder
        Returns:
        The automlParams.

      • setAutomlParams

        public ProcessDocumentRequest.Builder setAutomlParams​(AutoMlParams value)
         Controls AutoML model prediction behavior. AutoMlParams cannot be used
 together with other Params.
        .google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;

      • setAutomlParams

        public ProcessDocumentRequest.Builder setAutomlParams​(AutoMlParams.Builder builderForValue)
         Controls AutoML model prediction behavior. AutoMlParams cannot be used
 together with other Params.
        .google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;

      • mergeAutomlParams

        public ProcessDocumentRequest.Builder mergeAutomlParams​(AutoMlParams value)
         Controls AutoML model prediction behavior. AutoMlParams cannot be used
 together with other Params.
        .google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;

      • clearAutomlParams

        public ProcessDocumentRequest.Builder clearAutomlParams()
         Controls AutoML model prediction behavior. AutoMlParams cannot be used
 together with other Params.
        .google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;

      • getAutomlParamsBuilder

        public AutoMlParams.Builder getAutomlParamsBuilder()
         Controls AutoML model prediction behavior. AutoMlParams cannot be used
 together with other Params.
        .google.cloud.documentai.v1beta2.AutoMlParams automl_params = 8;

      • setUnknownFields

        public final ProcessDocumentRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessDocumentRequest.Builder>

      • mergeUnknownFields

        public final ProcessDocumentRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ProcessDocumentRequest.Builder>