Schema class

NextSchema is a collection of SchemaVersions.

To get more information about Schema, see:

API documentation

Example Usage

Documentai Schema

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

const schema = new gcp.documentai.Schema("schema", {
    location: "us",
    displayName: "my-schema",
    labels: {
        env: "test",
    },
});

import pulumi
import pulumi_gcp as gcp

schema = gcp.documentai.Schema("schema",
    location="us",
    display_name="my-schema",
    labels={
        "env": "test",
    })

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

return await Deployment.RunAsync(() =>
{
    var schema = new Gcp.DocumentAi.Schema("schema", new()
    {
        Location = "us",
        DisplayName = "my-schema",
        Labels =
        {
            { "env", "test" },
        },
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := documentai.NewSchema(ctx, "schema", &documentai.SchemaArgs{
			Location:    pulumi.String("us"),
			DisplayName: pulumi.String("my-schema"),
			Labels: pulumi.StringMap{
				"env": pulumi.String("test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_documentai_schema" "schema" {
  location     = "us"
  display_name = "my-schema"
  labels = {
    "env" = "test"
  }
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.documentai.Schema;
import com.pulumi.gcp.documentai.SchemaArgs;
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 schema = new Schema("schema", SchemaArgs.builder()
            .location("us")
            .displayName("my-schema")
            .labels(Map.of("env", "test"))
            .build());

    }
}

resources:
  schema:
    type: gcp:documentai:Schema
    properties:
      location: us
      displayName: my-schema
      labels:
        env: test

Import

Schema can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/schemas/{{name}}
{{project}}/{{location}}/{{name}}
{{location}}/{{name}}

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

$ pulumi import gcp:documentai/schema:Schema default projects/{{project}}/locations/{{location}}/schemas/{{name}}
$ pulumi import gcp:documentai/schema:Schema default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:documentai/schema:Schema default {{location}}/{{name}}

Constructors

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

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
createTime ↔ Output<String>: The time when the Schema was created.
latefinal
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.
latefinal
displayName ↔ Output<String?>: The user-defined name of the Schema.
latefinal
effectiveLabels ↔ Output<Map<String, String>>: All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
latefinal
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
labels ↔ Output<Map<String, String>?>: The Google Cloud labels for the Schema.
latefinal
location ↔ Output<String>: The location of the resource.
latefinal
name ↔ Output<String>: The resource name of the Schema.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
pulumiLabels ↔ Output<Map<String, String>>: The combination of labels configured directly on the resource and default labels configured on the provider.
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
updateTime ↔ Output<String>: The time when the Schema was last updated.
latefinal
urn ↔ Output<String>: latefinalinherited

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