com.pulumi.gcp.essentialcontacts.kotlin.DocumentAiProcessorArgs.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-gcp-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 8.10.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.gcp.essentialcontacts.kotlin

import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.gcp.essentialcontacts.DocumentAiProcessorArgs.builder
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import kotlin.String
import kotlin.Suppress
import kotlin.jvm.JvmName

/**
 * 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
 * 
 * ```typescript
 * 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",
 * });
 * ```
 * ```python
 * import pulumi
 * import pulumi_gcp as gcp
 * processor = gcp.essentialcontacts.DocumentAiProcessor("processor",
 *     location="us",
 *     display_name="test-processor",
 *     type="OCR_PROCESSOR")
 * ```
 * ```csharp
 * 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",
 *     });
 * });
 * ```
 * ```go
 * package main
 * import (
 * 	"github.com/pulumi/pulumi-gcp/sdk/v7/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
 * 	})
 * }
 * ```
 * ```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()
 *             .location("us")
 *             .displayName("test-processor")
 *             .type("OCR_PROCESSOR")
 *             .build());
 *     }
 * }
 * ```
 * ```yaml
 * 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:
 * ```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}}
 * ```
 * @property displayName The display name. Must be unique.
 * @property kmsKeyName The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
 * @property location The location of the resource.
 * - - -
 * @property project The ID of the project in which the resource belongs.
 * If it is not provided, the provider project is used.
 * @property type 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)
 */
public data class DocumentAiProcessorArgs(
    public val displayName: Output? = null,
    public val kmsKeyName: Output? = null,
    public val location: Output? = null,
    public val project: Output? = null,
    public val type: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.gcp.essentialcontacts.DocumentAiProcessorArgs =
        com.pulumi.gcp.essentialcontacts.DocumentAiProcessorArgs.builder()
            .displayName(displayName?.applyValue({ args0 -> args0 }))
            .kmsKeyName(kmsKeyName?.applyValue({ args0 -> args0 }))
            .location(location?.applyValue({ args0 -> args0 }))
            .project(project?.applyValue({ args0 -> args0 }))
            .type(type?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [DocumentAiProcessorArgs].
 */
@PulumiTagMarker
public class DocumentAiProcessorArgsBuilder internal constructor() {
    private var displayName: Output? = null

    private var kmsKeyName: Output? = null

    private var location: Output? = null

    private var project: Output? = null

    private var type: Output? = null

    /**
     * @param value The display name. Must be unique.
     */
    @JvmName("mayjdavxtctrmjbs")
    public suspend fun displayName(`value`: Output) {
        this.displayName = value
    }

    /**
     * @param value The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
     */
    @JvmName("abfusfyubtugdlty")
    public suspend fun kmsKeyName(`value`: Output) {
        this.kmsKeyName = value
    }

    /**
     * @param value The location of the resource.
     * - - -
     */
    @JvmName("tkrlobfplqithtiq")
    public suspend fun location(`value`: Output) {
        this.location = value
    }

    /**
     * @param value The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    @JvmName("extwkcqovfeigglh")
    public suspend fun project(`value`: Output) {
        this.project = value
    }

    /**
     * @param value 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)
     */
    @JvmName("xeehgjqehcyyjcyv")
    public suspend fun type(`value`: Output) {
        this.type = value
    }

    /**
     * @param value The display name. Must be unique.
     */
    @JvmName("qcytwdyrofsmcglj")
    public suspend fun displayName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.displayName = mapped
    }

    /**
     * @param value The KMS key used for encryption/decryption in CMEK scenarios. See https://cloud.google.com/security-key-management.
     */
    @JvmName("mndnepriuxxmtmwc")
    public suspend fun kmsKeyName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.kmsKeyName = mapped
    }

    /**
     * @param value The location of the resource.
     * - - -
     */
    @JvmName("kfrahgwstwfagbyj")
    public suspend fun location(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.location = mapped
    }

    /**
     * @param value The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    @JvmName("qshqdhsieujckbyc")
    public suspend fun project(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.project = mapped
    }

    /**
     * @param value 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)
     */
    @JvmName("xsgokawgbxypweuo")
    public suspend fun type(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.type = mapped
    }

    internal fun build(): DocumentAiProcessorArgs = DocumentAiProcessorArgs(
        displayName = displayName,
        kmsKeyName = kmsKeyName,
        location = location,
        project = project,
        type = type,
    )
}