Package com.google.cloud.documentai.v1

Class Processor.Builder

  • All Implemented Interfaces:
    ProcessorOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Processor
    public static final class Processor.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Processor.Builder>
implements ProcessorOrBuilder
     The first-class citizen for Document AI. Each processor defines how to
 extract structural information from a document.
    Protobuf type google.cloud.documentai.v1.Processor

    • 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<Processor.Builder>

      • clear

        public Processor.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<Processor.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<Processor.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Processor.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<Processor.Builder>

      • setField

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

      • clearField

        public Processor.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<Processor.Builder>

      • clearOneof

        public Processor.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<Processor.Builder>

      • setRepeatedField

        public Processor.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<Processor.Builder>

      • addRepeatedField

        public Processor.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<Processor.Builder>

      • mergeFrom

        public Processor.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Processor.Builder>

      • isInitialized

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

      • mergeFrom

        public Processor.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<Processor.Builder>
        Throws:
        IOException

      • getName

        public String getName()
         Output only. Immutable. The resource name of the processor.
 Format: `projects/{project}/locations/{location}/processors/{processor}`
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface ProcessorOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Immutable. The resource name of the processor.
 Format: `projects/{project}/locations/{location}/processors/{processor}`
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface ProcessorOrBuilder
        Returns:
        The bytes for name.

      • setName

        public Processor.Builder setName​(String value)
         Output only. Immutable. The resource name of the processor.
 Format: `projects/{project}/locations/{location}/processors/{processor}`
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public Processor.Builder clearName()
         Output only. Immutable. The resource name of the processor.
 Format: `projects/{project}/locations/{location}/processors/{processor}`
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • setNameBytes

        public Processor.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Output only. Immutable. The resource name of the processor.
 Format: `projects/{project}/locations/{location}/processors/{processor}`
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • getType

        public String getType()
         The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
 To get a list of processor types, see
 [FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes].
        string type = 2;
        Specified by:
        getType in interface ProcessorOrBuilder
        Returns:
        The type.

      • getTypeBytes

        public com.google.protobuf.ByteString getTypeBytes()
         The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
 To get a list of processor types, see
 [FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes].
        string type = 2;
        Specified by:
        getTypeBytes in interface ProcessorOrBuilder
        Returns:
        The bytes for type.

      • setType

        public Processor.Builder setType​(String value)
         The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
 To get a list of processor types, see
 [FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes].
        string type = 2;
        Parameters:
        value - The type to set.
        Returns:
        This builder for chaining.

      • clearType

        public Processor.Builder clearType()
         The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
 To get a list of processor types, see
 [FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes].
        string type = 2;
        Returns:
        This builder for chaining.

      • setTypeBytes

        public Processor.Builder setTypeBytes​(com.google.protobuf.ByteString value)
         The processor type, such as: `OCR_PROCESSOR`, `INVOICE_PROCESSOR`.
 To get a list of processor types, see
 [FetchProcessorTypes][google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes].
        string type = 2;
        Parameters:
        value - The bytes for type to set.
        Returns:
        This builder for chaining.

      • getDisplayName

        public String getDisplayName()
         The display name of the processor.
        string display_name = 3;
        Specified by:
        getDisplayName in interface ProcessorOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public com.google.protobuf.ByteString getDisplayNameBytes()
         The display name of the processor.
        string display_name = 3;
        Specified by:
        getDisplayNameBytes in interface ProcessorOrBuilder
        Returns:
        The bytes for displayName.

      • setDisplayName

        public Processor.Builder setDisplayName​(String value)
         The display name of the processor.
        string display_name = 3;
        Parameters:
        value - The displayName to set.
        Returns:
        This builder for chaining.

      • clearDisplayName

        public Processor.Builder clearDisplayName()
         The display name of the processor.
        string display_name = 3;
        Returns:
        This builder for chaining.

      • setDisplayNameBytes

        public Processor.Builder setDisplayNameBytes​(com.google.protobuf.ByteString value)
         The display name of the processor.
        string display_name = 3;
        Parameters:
        value - The bytes for displayName to set.
        Returns:
        This builder for chaining.

      • getStateValue

        public int getStateValue()
         Output only. The state of the processor.
        .google.cloud.documentai.v1.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface ProcessorOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • setStateValue

        public Processor.Builder setStateValue​(int value)
         Output only. The state of the processor.
        .google.cloud.documentai.v1.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The enum numeric value on the wire for state to set.
        Returns:
        This builder for chaining.

      • getState

        public Processor.State getState()
         Output only. The state of the processor.
        .google.cloud.documentai.v1.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface ProcessorOrBuilder
        Returns:
        The state.

      • setState

        public Processor.Builder setState​(Processor.State value)
         Output only. The state of the processor.
        .google.cloud.documentai.v1.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Parameters:
        value - The state to set.
        Returns:
        This builder for chaining.

      • clearState

        public Processor.Builder clearState()
         Output only. The state of the processor.
        .google.cloud.documentai.v1.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        This builder for chaining.

      • getDefaultProcessorVersion

        public String getDefaultProcessorVersion()
         The default processor version.
        string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
        Specified by:
        getDefaultProcessorVersion in interface ProcessorOrBuilder
        Returns:
        The defaultProcessorVersion.

      • getDefaultProcessorVersionBytes

        public com.google.protobuf.ByteString getDefaultProcessorVersionBytes()
         The default processor version.
        string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
        Specified by:
        getDefaultProcessorVersionBytes in interface ProcessorOrBuilder
        Returns:
        The bytes for defaultProcessorVersion.

      • setDefaultProcessorVersion

        public Processor.Builder setDefaultProcessorVersion​(String value)
         The default processor version.
        string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The defaultProcessorVersion to set.
        Returns:
        This builder for chaining.

      • clearDefaultProcessorVersion

        public Processor.Builder clearDefaultProcessorVersion()
         The default processor version.
        string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
        Returns:
        This builder for chaining.

      • setDefaultProcessorVersionBytes

        public Processor.Builder setDefaultProcessorVersionBytes​(com.google.protobuf.ByteString value)
         The default processor version.
        string default_processor_version = 9 [(.google.api.resource_reference) = { ... }
        Parameters:
        value - The bytes for defaultProcessorVersion to set.
        Returns:
        This builder for chaining.

      • getProcessEndpoint

        public String getProcessEndpoint()
         Output only. Immutable. The http endpoint that can be called to invoke
 processing.
        string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getProcessEndpoint in interface ProcessorOrBuilder
        Returns:
        The processEndpoint.

      • getProcessEndpointBytes

        public com.google.protobuf.ByteString getProcessEndpointBytes()
         Output only. Immutable. The http endpoint that can be called to invoke
 processing.
        string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
        Specified by:
        getProcessEndpointBytes in interface ProcessorOrBuilder
        Returns:
        The bytes for processEndpoint.

      • setProcessEndpoint

        public Processor.Builder setProcessEndpoint​(String value)
         Output only. Immutable. The http endpoint that can be called to invoke
 processing.
        string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The processEndpoint to set.
        Returns:
        This builder for chaining.

      • clearProcessEndpoint

        public Processor.Builder clearProcessEndpoint()
         Output only. Immutable. The http endpoint that can be called to invoke
 processing.
        string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
        Returns:
        This builder for chaining.

      • setProcessEndpointBytes

        public Processor.Builder setProcessEndpointBytes​(com.google.protobuf.ByteString value)
         Output only. Immutable. The http endpoint that can be called to invoke
 processing.
        string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];
        Parameters:
        value - The bytes for processEndpoint to set.
        Returns:
        This builder for chaining.

      • hasCreateTime

        public boolean hasCreateTime()
         The time the processor was created.
        .google.protobuf.Timestamp create_time = 7;
        Specified by:
        hasCreateTime in interface ProcessorOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public com.google.protobuf.Timestamp getCreateTime()
         The time the processor was created.
        .google.protobuf.Timestamp create_time = 7;
        Specified by:
        getCreateTime in interface ProcessorOrBuilder
        Returns:
        The createTime.

      • setCreateTime

        public Processor.Builder setCreateTime​(com.google.protobuf.Timestamp value)
         The time the processor was created.
        .google.protobuf.Timestamp create_time = 7;

      • setCreateTime

        public Processor.Builder setCreateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         The time the processor was created.
        .google.protobuf.Timestamp create_time = 7;

      • mergeCreateTime

        public Processor.Builder mergeCreateTime​(com.google.protobuf.Timestamp value)
         The time the processor was created.
        .google.protobuf.Timestamp create_time = 7;

      • clearCreateTime

        public Processor.Builder clearCreateTime()
         The time the processor was created.
        .google.protobuf.Timestamp create_time = 7;

      • getCreateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreateTimeBuilder()
         The time the processor was created.
        .google.protobuf.Timestamp create_time = 7;

      • getCreateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         The time the processor was created.
        .google.protobuf.Timestamp create_time = 7;
        Specified by:
        getCreateTimeOrBuilder in interface ProcessorOrBuilder

      • getKmsKeyName

        public String getKmsKeyName()
         The [KMS key](https://cloud.google.com/security-key-management) used for
 encryption and decryption in CMEK scenarios.
        string kms_key_name = 8;
        Specified by:
        getKmsKeyName in interface ProcessorOrBuilder
        Returns:
        The kmsKeyName.

      • getKmsKeyNameBytes

        public com.google.protobuf.ByteString getKmsKeyNameBytes()
         The [KMS key](https://cloud.google.com/security-key-management) used for
 encryption and decryption in CMEK scenarios.
        string kms_key_name = 8;
        Specified by:
        getKmsKeyNameBytes in interface ProcessorOrBuilder
        Returns:
        The bytes for kmsKeyName.

      • setKmsKeyName

        public Processor.Builder setKmsKeyName​(String value)
         The [KMS key](https://cloud.google.com/security-key-management) used for
 encryption and decryption in CMEK scenarios.
        string kms_key_name = 8;
        Parameters:
        value - The kmsKeyName to set.
        Returns:
        This builder for chaining.

      • clearKmsKeyName

        public Processor.Builder clearKmsKeyName()
         The [KMS key](https://cloud.google.com/security-key-management) used for
 encryption and decryption in CMEK scenarios.
        string kms_key_name = 8;
        Returns:
        This builder for chaining.

      • setKmsKeyNameBytes

        public Processor.Builder setKmsKeyNameBytes​(com.google.protobuf.ByteString value)
         The [KMS key](https://cloud.google.com/security-key-management) used for
 encryption and decryption in CMEK scenarios.
        string kms_key_name = 8;
        Parameters:
        value - The bytes for kmsKeyName to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Processor.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<Processor.Builder>

      • mergeUnknownFields

        public final Processor.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<Processor.Builder>