DocumentAiProcessor class

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

To get more information about Processor, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Documentai Processor

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const processor = new gcp.essentialcontacts.DocumentAiProcessor("processor", {
    location: "us",
    displayName: "test-processor",
    type: "OCR_PROCESSOR",
});

import pulumi
import pulumi_gcp as gcp

processor = gcp.essentialcontacts.DocumentAiProcessor("processor",
    location="us",
    display_name="test-processor",
    type="OCR_PROCESSOR")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var processor = new Gcp.EssentialContacts.DocumentAiProcessor("processor", new()
    {
        Location = "us",
        DisplayName = "test-processor",
        Type = "OCR_PROCESSOR",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/essentialcontacts"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := essentialcontacts.NewDocumentAiProcessor(ctx, "processor", &essentialcontacts.DocumentAiProcessorArgs{
			Location:    pulumi.String("us"),
			DisplayName: pulumi.String("test-processor"),
			Type:        pulumi.String("OCR_PROCESSOR"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_essentialcontacts_documentaiprocessor" "processor" {
  location     = "us"
  display_name = "test-processor"
  type         = "OCR_PROCESSOR"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.essentialcontacts.DocumentAiProcessor;
import com.pulumi.gcp.essentialcontacts.DocumentAiProcessorArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var processor = new DocumentAiProcessor("processor", DocumentAiProcessorArgs.builder()
            .location("us")
            .displayName("test-processor")
            .type("OCR_PROCESSOR")
            .build());

    }
}

resources:
  processor:
    type: gcp:essentialcontacts:DocumentAiProcessor
    properties:
      location: us
      displayName: test-processor
      type: OCR_PROCESSOR

Import

Processor can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/processors/{{name}}
• {{project}}/{{location}}/{{name}}
• {{location}}/{{name}}

When using the pulumi import command, Processor can be imported using one of the formats above. For example:

$ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default projects/{{project}}/locations/{{location}}/processors/{{name}}
$ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default {{location}}/{{name}}

Constructors

DocumentAiProcessor(String name, {DocumentAiProcessorArgs? args, CustomResourceOptions? options})

Creates a new DocumentAiProcessor. name The Pulumi resource name. args Arguments used to configure this DocumentAiProcessor. The set of arguments for DocumentAiProcessor. options Resource options controlling this resource's behavior.

DocumentAiProcessor.reference(String urn)

Creates a typed reference to an existing DocumentAiProcessor resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

displayName ↔ Output<String>

The display name. Must be unique.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

kmsKeyName ↔ Output<String?>

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

late, final

location ↔ Output<String>

The location of the resource.

late, final

name ↔ Output<String>

The resource name of the processor.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

type ↔ Output<String>

The type of processor. For possible types see the official list

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {DocumentAiProcessorState? state, CustomResourceOptions? options}) → DocumentAiProcessor

Gets an existing DocumentAiProcessor resource's state with the given name and id.