Package com.pulumi.gcp.essentialcontacts

Class DocumentAiProcessor

  • public class DocumentAiProcessor
extends com.pulumi.resources.CustomResource
    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](https://cloud.google.com/document-ai/docs/reference/rest/v1/projects.locations.processors) * How-to Guides * [Official Documentation](https://cloud.google.com/document-ai/docs/overview) ## Example Usage ### Documentai Processor ```java 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.List; import java.util.ArrayList; 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() .displayName("test-processor") .location("us") .type("OCR_PROCESSOR") .build()); } } ``` ## Import Processor can be imported using any of these accepted formats* `projects/{{project}}/locations/{{location}}/processors/{{name}}` * `{{project}}/{{location}}/{{name}}` * `{{location}}/{{name}}` In Terraform v1.5.0 and later, use an [`import` block](https://developer.hashicorp.com/terraform/language/import) to import Processor using one of the formats above. For exampletf import { id = "projects/{{project}}/locations/{{location}}/processors/{{name}}" to = google_document_ai_processor.default } ```sh $ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), Processor can be imported using one of the formats above. For example ``` ```sh $ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default projects/{{project}}/locations/{{location}}/processors/{{name}} ``` ```sh $ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default {{project}}/{{location}}/{{name}} ``` ```sh $ pulumi import gcp:essentialcontacts/documentAiProcessor:DocumentAiProcessor default {{location}}/{{name}} ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> displayName()  
      static DocumentAiProcessor get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DocumentAiProcessorState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyName()  
      com.pulumi.core.Output<java.lang.String> location()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> project()  
      com.pulumi.core.Output<java.lang.String> type()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • DocumentAiProcessor

        public DocumentAiProcessor​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • DocumentAiProcessor

        public DocumentAiProcessor​(java.lang.String name,
                           DocumentAiProcessorArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • DocumentAiProcessor

        public DocumentAiProcessor​(java.lang.String name,
                           DocumentAiProcessorArgs args,
                           @Nullable
                           com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • displayName

        public com.pulumi.core.Output<java.lang.String> displayName()
        Returns:
        The display name. Must be unique.

      • kmsKeyName

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyName()
        Returns:
        The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.

      • location

        public com.pulumi.core.Output<java.lang.String> location()
        Returns:
        The location of the resource. ***

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The resource name of the processor.

      • project

        public com.pulumi.core.Output<java.lang.String> project()
        Returns:
        The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

      • type

        public com.pulumi.core.Output<java.lang.String> type()
        Returns:
        The type of processor. For possible types see the [official list](https://cloud.google.com/document-ai/docs/reference/rest/v1/projects.locations/fetchProcessorTypes#google.cloud.documentai.v1.DocumentProcessorService.FetchProcessorTypes)

      • get

        public static DocumentAiProcessor get​(java.lang.String name,
                                      com.pulumi.core.Output<java.lang.String> id,
                                      @Nullable
                                      DocumentAiProcessorState state,
                                      @Nullable
                                      com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.