DocumentAiProcessorDefaultVersion class

The default version for the processor. Deleting this resource is a no-op, and does not unset the default version.

Example Usage

Documentai Default Version

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",
});
const processorDocumentAiProcessorDefaultVersion = new gcp.essentialcontacts.DocumentAiProcessorDefaultVersion("processor", {
    processor: processor.id,
    version: pulumi.interpolate`${processor.id}/processorVersions/stable`,
});

import pulumi
import pulumi_gcp as gcp

processor = gcp.essentialcontacts.DocumentAiProcessor("processor",
    location="us",
    display_name="test-processor",
    type="OCR_PROCESSOR")
processor_document_ai_processor_default_version = gcp.essentialcontacts.DocumentAiProcessorDefaultVersion("processor",
    processor=processor.id,
    version=processor.id.apply(lambda id: f"{id}/processorVersions/stable"))

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",
    });

    var processorDocumentAiProcessorDefaultVersion = new Gcp.EssentialContacts.DocumentAiProcessorDefaultVersion("processor", new()
    {
        Processor = processor.Id,
        Version = processor.Id.Apply(id => $"{id}/processorVersions/stable"),
    });

});

package main

import (
	"fmt"

	"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 {
		processor, 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
		}
		_, err = essentialcontacts.NewDocumentAiProcessorDefaultVersion(ctx, "processor", &essentialcontacts.DocumentAiProcessorDefaultVersionArgs{
			Processor: processor.ID().ToIDOutput().ToStringOutput(),
			Version: processor.ID().ApplyT(func(id pulumi.ID) (string, error) {
				return fmt.Sprintf("%v/processorVersions/stable", id), nil
			}).(pulumi.StringOutput),
		})
		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"
}
resource "gcp_essentialcontacts_documentaiprocessordefaultversion" "processor" {
  processor = gcp_essentialcontacts_documentaiprocessor.processor.id
  version   ="${gcp_essentialcontacts_documentaiprocessor.processor.id}/processorVersions/stable"
}

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 com.pulumi.gcp.essentialcontacts.DocumentAiProcessorDefaultVersion;
import com.pulumi.gcp.essentialcontacts.DocumentAiProcessorDefaultVersionArgs;
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());

        var processorDocumentAiProcessorDefaultVersion = new DocumentAiProcessorDefaultVersion("processorDocumentAiProcessorDefaultVersion", DocumentAiProcessorDefaultVersionArgs.builder()
            .processor(processor.id())
            .version(processor.id().applyValue(_id -> String.format("%s/processorVersions/stable", _id)))
            .build());

    }
}

resources:
  processor:
    type: gcp:essentialcontacts:DocumentAiProcessor
    properties:
      location: us
      displayName: test-processor
      type: OCR_PROCESSOR
  processorDocumentAiProcessorDefaultVersion:
    type: gcp:essentialcontacts:DocumentAiProcessorDefaultVersion
    name: processor
    properties:
      processor: ${processor.id}
      version: ${processor.id}/processorVersions/stable

Import

ProcessorDefaultVersion can be imported using any of these accepted formats:

{{processor}}

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

$ pulumi import gcp:essentialcontacts/documentAiProcessorDefaultVersion:DocumentAiProcessorDefaultVersion default {{processor}}

Constructors

DocumentAiProcessorDefaultVersion(String name, {DocumentAiProcessorDefaultVersionArgs? args, CustomResourceOptions? options}): Creates a new DocumentAiProcessorDefaultVersion. name The Pulumi resource name. args Arguments used to configure this DocumentAiProcessorDefaultVersion. The set of arguments for DocumentAiProcessorDefaultVersion. options Resource options controlling this resource's behavior.
DocumentAiProcessorDefaultVersion.reference(String urn): Creates a typed reference to an existing DocumentAiProcessorDefaultVersion resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
processor ↔ Output<String>: The processor to set the version on.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited
version ↔ Output<String>: The version to set. Using stable or rc will cause the API to return the latest version in that release channel. Apply lifecycle.ignore_changes to the version field to suppress this diff.
latefinal

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, {DocumentAiProcessorDefaultVersionState? state, CustomResourceOptions? options}) → DocumentAiProcessorDefaultVersion: Gets an existing DocumentAiProcessorDefaultVersion resource's state with the given name and id.