Console
    Start free

    Google Cloud Document Ai V1 Client - Class Processor (1.0.1)

    Reference documentation and code samples for the Google Cloud Document Ai V1 Client class Processor.

    The first-class citizen for Document AI. Each processor defines how to extract structural information from a document.

    Generated from protobuf message google.cloud.documentai.v1.Processor

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    Output only. Immutable. The resource name of the processor. Format: projects/{project}/locations/{location}/processors/{processor}

    ↳ type
    string

    The processor type, e.g., OCR_PROCESSOR , INVOICE_PROCESSOR , etc. To get a list of processors types, see FetchProcessorTypes .

    ↳ display_name
    string

    The display name of the processor.

    ↳ state
    int

    Output only. The state of the processor.

    ↳ default_processor_version
    string

    The default processor version.

    ↳ process_endpoint
    string

    Output only. Immutable. The http endpoint that can be called to invoke processing.

    ↳ create_time
    Google\Protobuf\Timestamp

    The time the processor was created.

    ↳ kms_key_name
    string

    The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management .

    getName

    Output only. Immutable. The resource name of the processor.

    Format: projects/{project}/locations/{location}/processors/{processor}

    Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    string

    setName

    Output only. Immutable. The resource name of the processor.

    Format: projects/{project}/locations/{location}/processors/{processor}

    Generated from protobuf field string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getType

    The processor type, e.g., OCR_PROCESSOR , INVOICE_PROCESSOR , etc.

    To get a list of processors types, see FetchProcessorTypes .

    Generated from protobuf field string type = 2;

    Returns
    Type
    Description
    string

    setType

    The processor type, e.g., OCR_PROCESSOR , INVOICE_PROCESSOR , etc.

    To get a list of processors types, see FetchProcessorTypes .

    Generated from protobuf field string type = 2;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getDisplayName

    The display name of the processor.

    Generated from protobuf field string display_name = 3;

    Returns
    Type
    Description
    string

    setDisplayName

    The display name of the processor.

    Generated from protobuf field string display_name = 3;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getState

    Output only. The state of the processor.

    Generated from protobuf field .google.cloud.documentai.v1.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Returns
    Type
    Description
    int

    setState

    Output only. The state of the processor.

    Generated from protobuf field .google.cloud.documentai.v1.Processor.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getDefaultProcessorVersion

    The default processor version.

    Generated from protobuf field string default_processor_version = 9 [(.google.api.resource_reference) = {

    Returns
    Type
    Description
    string

    setDefaultProcessorVersion

    The default processor version.

    Generated from protobuf field string default_processor_version = 9 [(.google.api.resource_reference) = {

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getProcessEndpoint

    Output only. Immutable. The http endpoint that can be called to invoke processing.

    Generated from protobuf field string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

    Returns
    Type
    Description
    string

    setProcessEndpoint

    Output only. Immutable. The http endpoint that can be called to invoke processing.

    Generated from protobuf field string process_endpoint = 6 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IMMUTABLE];

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getCreateTime

    The time the processor was created.

    Generated from protobuf field .google.protobuf.Timestamp create_time = 7;

    Returns
    Type
    Description
    Google\Protobuf\Timestamp|null

    hasCreateTime

    clearCreateTime

    setCreateTime

    The time the processor was created.

    Generated from protobuf field .google.protobuf.Timestamp create_time = 7;

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getKmsKeyName

    The KMS key used for encryption/decryption in CMEK scenarios.

    See https://cloud.google.com/security-key-management .

    Generated from protobuf field string kms_key_name = 8;

    Returns
    Type
    Description
    string

    setKmsKeyName

    The KMS key used for encryption/decryption in CMEK scenarios.

    See https://cloud.google.com/security-key-management .

    Generated from protobuf field string kms_key_name = 8;

    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: