Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. essentialcontacts
  5. DocumentAiWarehouseDocumentSchema
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.essentialcontacts.DocumentAiWarehouseDocumentSchema

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
pulumi/pulumi-gcp

    A document schema is used to define document structure.

    To get more information about DocumentSchema, see:

    Example Usage

    Document Ai Warehouse Document Schema Text

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

const project = gcp.organizations.getProject({});
const exampleText = new gcp.essentialcontacts.DocumentAiWarehouseDocumentSchema("example_text", {
    projectNumber: project.then(project => project.number),
    displayName: "test-property-text",
    location: "us",
    documentIsFolder: false,
    propertyDefinitions: [{
        name: "prop3",
        displayName: "propdisp3",
        isRepeatable: false,
        isFilterable: true,
        isSearchable: true,
        isMetadata: false,
        isRequired: false,
        retrievalImportance: "HIGHEST",
        schemaSources: [{
            name: "dummy_source",
            processorType: "dummy_processor",
        }],
        textTypeOptions: {},
    }],
});

    import pulumi
import pulumi_gcp as gcp

project = gcp.organizations.get_project()
example_text = gcp.essentialcontacts.DocumentAiWarehouseDocumentSchema("example_text",
    project_number=project.number,
    display_name="test-property-text",
    location="us",
    document_is_folder=False,
    property_definitions=[{
        "name": "prop3",
        "display_name": "propdisp3",
        "is_repeatable": False,
        "is_filterable": True,
        "is_searchable": True,
        "is_metadata": False,
        "is_required": False,
        "retrieval_importance": "HIGHEST",
        "schema_sources": [{
            "name": "dummy_source",
            "processor_type": "dummy_processor",
        }],
        "text_type_options": {},
    }])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		project, err := organizations.LookupProject(ctx, nil, nil)
		if err != nil {
			return err
		}
		_, err = essentialcontacts.NewDocumentAiWarehouseDocumentSchema(ctx, "example_text", &essentialcontacts.DocumentAiWarehouseDocumentSchemaArgs{
			ProjectNumber:    pulumi.String(project.Number),
			DisplayName:      pulumi.String("test-property-text"),
			Location:         pulumi.String("us"),
			DocumentIsFolder: pulumi.Bool(false),
			PropertyDefinitions: essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionArray{
				&essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs{
					Name:                pulumi.String("prop3"),
					DisplayName:         pulumi.String("propdisp3"),
					IsRepeatable:        pulumi.Bool(false),
					IsFilterable:        pulumi.Bool(true),
					IsSearchable:        pulumi.Bool(true),
					IsMetadata:          pulumi.Bool(false),
					IsRequired:          pulumi.Bool(false),
					RetrievalImportance: pulumi.String("HIGHEST"),
					SchemaSources: essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArray{
						&essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs{
							Name:          pulumi.String("dummy_source"),
							ProcessorType: pulumi.String("dummy_processor"),
						},
					},
					TextTypeOptions: nil,
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var project = Gcp.Organizations.GetProject.Invoke();

    var exampleText = new Gcp.EssentialContacts.DocumentAiWarehouseDocumentSchema("example_text", new()
    {
        ProjectNumber = project.Apply(getProjectResult => getProjectResult.Number),
        DisplayName = "test-property-text",
        Location = "us",
        DocumentIsFolder = false,
        PropertyDefinitions = new[]
        {
            new Gcp.EssentialContacts.Inputs.DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs
            {
                Name = "prop3",
                DisplayName = "propdisp3",
                IsRepeatable = false,
                IsFilterable = true,
                IsSearchable = true,
                IsMetadata = false,
                IsRequired = false,
                RetrievalImportance = "HIGHEST",
                SchemaSources = new[]
                {
                    new Gcp.EssentialContacts.Inputs.DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs
                    {
                        Name = "dummy_source",
                        ProcessorType = "dummy_processor",
                    },
                },
                TextTypeOptions = null,
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.OrganizationsFunctions;
import com.pulumi.gcp.organizations.inputs.GetProjectArgs;
import com.pulumi.gcp.essentialcontacts.DocumentAiWarehouseDocumentSchema;
import com.pulumi.gcp.essentialcontacts.DocumentAiWarehouseDocumentSchemaArgs;
import com.pulumi.gcp.essentialcontacts.inputs.DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs;
import com.pulumi.gcp.essentialcontacts.inputs.DocumentAiWarehouseDocumentSchemaPropertyDefinitionTextTypeOptionsArgs;
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) {
        final var project = OrganizationsFunctions.getProject();

        var exampleText = new DocumentAiWarehouseDocumentSchema("exampleText", DocumentAiWarehouseDocumentSchemaArgs.builder()
            .projectNumber(project.applyValue(getProjectResult -> getProjectResult.number()))
            .displayName("test-property-text")
            .location("us")
            .documentIsFolder(false)
            .propertyDefinitions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs.builder()
                .name("prop3")
                .displayName("propdisp3")
                .isRepeatable(false)
                .isFilterable(true)
                .isSearchable(true)
                .isMetadata(false)
                .isRequired(false)
                .retrievalImportance("HIGHEST")
                .schemaSources(DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs.builder()
                    .name("dummy_source")
                    .processorType("dummy_processor")
                    .build())
                .textTypeOptions()
                .build())
            .build());

    }
}

    resources:
  exampleText:
    type: gcp:essentialcontacts:DocumentAiWarehouseDocumentSchema
    name: example_text
    properties:
      projectNumber: ${project.number}
      displayName: test-property-text
      location: us
      documentIsFolder: false
      propertyDefinitions:
        - name: prop3
          displayName: propdisp3
          isRepeatable: false
          isFilterable: true
          isSearchable: true
          isMetadata: false
          isRequired: false
          retrievalImportance: HIGHEST
          schemaSources:
            - name: dummy_source
              processorType: dummy_processor
          textTypeOptions: {}
variables:
  project:
    fn::invoke:
      Function: gcp:organizations:getProject
      Arguments: {}

    Create DocumentAiWarehouseDocumentSchema Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DocumentAiWarehouseDocumentSchema(name: string, args: DocumentAiWarehouseDocumentSchemaArgs, opts?: CustomResourceOptions);
    @overload
def DocumentAiWarehouseDocumentSchema(resource_name: str,
                                      args: DocumentAiWarehouseDocumentSchemaArgs,
                                      opts: Optional[ResourceOptions] = None)

@overload
def DocumentAiWarehouseDocumentSchema(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      display_name: Optional[str] = None,
                                      location: Optional[str] = None,
                                      project_number: Optional[str] = None,
                                      property_definitions: Optional[Sequence[DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs]] = None,
                                      document_is_folder: Optional[bool] = None)
    func NewDocumentAiWarehouseDocumentSchema(ctx *Context, name string, args DocumentAiWarehouseDocumentSchemaArgs, opts ...ResourceOption) (*DocumentAiWarehouseDocumentSchema, error)
    public DocumentAiWarehouseDocumentSchema(string name, DocumentAiWarehouseDocumentSchemaArgs args, CustomResourceOptions? opts = null)
    public DocumentAiWarehouseDocumentSchema(String name, DocumentAiWarehouseDocumentSchemaArgs args)
public DocumentAiWarehouseDocumentSchema(String name, DocumentAiWarehouseDocumentSchemaArgs args, CustomResourceOptions options)

    type: gcp:essentialcontacts:DocumentAiWarehouseDocumentSchema
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DocumentAiWarehouseDocumentSchemaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DocumentAiWarehouseDocumentSchemaArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DocumentAiWarehouseDocumentSchemaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DocumentAiWarehouseDocumentSchemaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DocumentAiWarehouseDocumentSchemaArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var documentAiWarehouseDocumentSchemaResource = new Gcp.EssentialContacts.DocumentAiWarehouseDocumentSchema("documentAiWarehouseDocumentSchemaResource", new()
{
    DisplayName = "string",
    Location = "string",
    ProjectNumber = "string",
    PropertyDefinitions = new[]
    {
        new Gcp.EssentialContacts.Inputs.DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs
        {
            Name = "string",
            IsRequired = false,
            IsRepeatable = false,
            FloatTypeOptions = null,
            IntegerTypeOptions = null,
            IsSearchable = false,
            IsMetadata = false,
            EnumTypeOptions = new Gcp.EssentialContacts.Inputs.DocumentAiWarehouseDocumentSchemaPropertyDefinitionEnumTypeOptionsArgs
            {
                PossibleValues = new[]
                {
                    "string",
                },
                ValidationCheckDisabled = false,
            },
            DateTimeTypeOptions = null,
            IsFilterable = false,
            MapTypeOptions = null,
            DisplayName = "string",
            PropertyTypeOptions = new Gcp.EssentialContacts.Inputs.DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsArgs
            {
                PropertyDefinitions = new[]
                {
                    new Gcp.EssentialContacts.Inputs.DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionArgs
                    {
                        Name = "string",
                        IsRequired = false,
                        IsSearchable = false,
                        FloatTypeOptions = null,
                        IntegerTypeOptions = null,
                        IsFilterable = false,
                        IsMetadata = false,
                        EnumTypeOptions = new Gcp.EssentialContacts.Inputs.DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionEnumTypeOptionsArgs
                        {
                            PossibleValues = new[]
                            {
                                "string",
                            },
                            ValidationCheckDisabled = false,
                        },
                        DateTimeTypeOptions = null,
                        IsRepeatable = false,
                        MapTypeOptions = null,
                        DisplayName = "string",
                        RetrievalImportance = "string",
                        SchemaSources = new[]
                        {
                            new Gcp.EssentialContacts.Inputs.DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionSchemaSourceArgs
                            {
                                Name = "string",
                                ProcessorType = "string",
                            },
                        },
                        TextTypeOptions = null,
                        TimestampTypeOptions = null,
                    },
                },
            },
            RetrievalImportance = "string",
            SchemaSources = new[]
            {
                new Gcp.EssentialContacts.Inputs.DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs
                {
                    Name = "string",
                    ProcessorType = "string",
                },
            },
            TextTypeOptions = null,
            TimestampTypeOptions = null,
        },
    },
    DocumentIsFolder = false,
});

    example, err := essentialcontacts.NewDocumentAiWarehouseDocumentSchema(ctx, "documentAiWarehouseDocumentSchemaResource", &essentialcontacts.DocumentAiWarehouseDocumentSchemaArgs{
	DisplayName:   pulumi.String("string"),
	Location:      pulumi.String("string"),
	ProjectNumber: pulumi.String("string"),
	PropertyDefinitions: essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionArray{
		&essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs{
			Name:               pulumi.String("string"),
			IsRequired:         pulumi.Bool(false),
			IsRepeatable:       pulumi.Bool(false),
			FloatTypeOptions:   nil,
			IntegerTypeOptions: nil,
			IsSearchable:       pulumi.Bool(false),
			IsMetadata:         pulumi.Bool(false),
			EnumTypeOptions: &essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionEnumTypeOptionsArgs{
				PossibleValues: pulumi.StringArray{
					pulumi.String("string"),
				},
				ValidationCheckDisabled: pulumi.Bool(false),
			},
			DateTimeTypeOptions: nil,
			IsFilterable:        pulumi.Bool(false),
			MapTypeOptions:      nil,
			DisplayName:         pulumi.String("string"),
			PropertyTypeOptions: &essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsArgs{
				PropertyDefinitions: essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionArray{
					&essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionArgs{
						Name:               pulumi.String("string"),
						IsRequired:         pulumi.Bool(false),
						IsSearchable:       pulumi.Bool(false),
						FloatTypeOptions:   nil,
						IntegerTypeOptions: nil,
						IsFilterable:       pulumi.Bool(false),
						IsMetadata:         pulumi.Bool(false),
						EnumTypeOptions: &essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionEnumTypeOptionsArgs{
							PossibleValues: pulumi.StringArray{
								pulumi.String("string"),
							},
							ValidationCheckDisabled: pulumi.Bool(false),
						},
						DateTimeTypeOptions: nil,
						IsRepeatable:        pulumi.Bool(false),
						MapTypeOptions:      nil,
						DisplayName:         pulumi.String("string"),
						RetrievalImportance: pulumi.String("string"),
						SchemaSources: essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionSchemaSourceArray{
							&essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionSchemaSourceArgs{
								Name:          pulumi.String("string"),
								ProcessorType: pulumi.String("string"),
							},
						},
						TextTypeOptions:      nil,
						TimestampTypeOptions: nil,
					},
				},
			},
			RetrievalImportance: pulumi.String("string"),
			SchemaSources: essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArray{
				&essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs{
					Name:          pulumi.String("string"),
					ProcessorType: pulumi.String("string"),
				},
			},
			TextTypeOptions:      nil,
			TimestampTypeOptions: nil,
		},
	},
	DocumentIsFolder: pulumi.Bool(false),
})

    var documentAiWarehouseDocumentSchemaResource = new DocumentAiWarehouseDocumentSchema("documentAiWarehouseDocumentSchemaResource", DocumentAiWarehouseDocumentSchemaArgs.builder()
    .displayName("string")
    .location("string")
    .projectNumber("string")
    .propertyDefinitions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs.builder()
        .name("string")
        .isRequired(false)
        .isRepeatable(false)
        .floatTypeOptions()
        .integerTypeOptions()
        .isSearchable(false)
        .isMetadata(false)
        .enumTypeOptions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionEnumTypeOptionsArgs.builder()
            .possibleValues("string")
            .validationCheckDisabled(false)
            .build())
        .dateTimeTypeOptions()
        .isFilterable(false)
        .mapTypeOptions()
        .displayName("string")
        .propertyTypeOptions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsArgs.builder()
            .propertyDefinitions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionArgs.builder()
                .name("string")
                .isRequired(false)
                .isSearchable(false)
                .floatTypeOptions()
                .integerTypeOptions()
                .isFilterable(false)
                .isMetadata(false)
                .enumTypeOptions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionEnumTypeOptionsArgs.builder()
                    .possibleValues("string")
                    .validationCheckDisabled(false)
                    .build())
                .dateTimeTypeOptions()
                .isRepeatable(false)
                .mapTypeOptions()
                .displayName("string")
                .retrievalImportance("string")
                .schemaSources(DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionSchemaSourceArgs.builder()
                    .name("string")
                    .processorType("string")
                    .build())
                .textTypeOptions()
                .timestampTypeOptions()
                .build())
            .build())
        .retrievalImportance("string")
        .schemaSources(DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs.builder()
            .name("string")
            .processorType("string")
            .build())
        .textTypeOptions()
        .timestampTypeOptions()
        .build())
    .documentIsFolder(false)
    .build());

    document_ai_warehouse_document_schema_resource = gcp.essentialcontacts.DocumentAiWarehouseDocumentSchema("documentAiWarehouseDocumentSchemaResource",
    display_name="string",
    location="string",
    project_number="string",
    property_definitions=[{
        "name": "string",
        "isRequired": False,
        "isRepeatable": False,
        "floatTypeOptions": {},
        "integerTypeOptions": {},
        "isSearchable": False,
        "isMetadata": False,
        "enumTypeOptions": {
            "possibleValues": ["string"],
            "validationCheckDisabled": False,
        },
        "dateTimeTypeOptions": {},
        "isFilterable": False,
        "mapTypeOptions": {},
        "displayName": "string",
        "propertyTypeOptions": {
            "propertyDefinitions": [{
                "name": "string",
                "isRequired": False,
                "isSearchable": False,
                "floatTypeOptions": {},
                "integerTypeOptions": {},
                "isFilterable": False,
                "isMetadata": False,
                "enumTypeOptions": {
                    "possibleValues": ["string"],
                    "validationCheckDisabled": False,
                },
                "dateTimeTypeOptions": {},
                "isRepeatable": False,
                "mapTypeOptions": {},
                "displayName": "string",
                "retrievalImportance": "string",
                "schemaSources": [{
                    "name": "string",
                    "processorType": "string",
                }],
                "textTypeOptions": {},
                "timestampTypeOptions": {},
            }],
        },
        "retrievalImportance": "string",
        "schemaSources": [{
            "name": "string",
            "processorType": "string",
        }],
        "textTypeOptions": {},
        "timestampTypeOptions": {},
    }],
    document_is_folder=False)

    const documentAiWarehouseDocumentSchemaResource = new gcp.essentialcontacts.DocumentAiWarehouseDocumentSchema("documentAiWarehouseDocumentSchemaResource", {
    displayName: "string",
    location: "string",
    projectNumber: "string",
    propertyDefinitions: [{
        name: "string",
        isRequired: false,
        isRepeatable: false,
        floatTypeOptions: {},
        integerTypeOptions: {},
        isSearchable: false,
        isMetadata: false,
        enumTypeOptions: {
            possibleValues: ["string"],
            validationCheckDisabled: false,
        },
        dateTimeTypeOptions: {},
        isFilterable: false,
        mapTypeOptions: {},
        displayName: "string",
        propertyTypeOptions: {
            propertyDefinitions: [{
                name: "string",
                isRequired: false,
                isSearchable: false,
                floatTypeOptions: {},
                integerTypeOptions: {},
                isFilterable: false,
                isMetadata: false,
                enumTypeOptions: {
                    possibleValues: ["string"],
                    validationCheckDisabled: false,
                },
                dateTimeTypeOptions: {},
                isRepeatable: false,
                mapTypeOptions: {},
                displayName: "string",
                retrievalImportance: "string",
                schemaSources: [{
                    name: "string",
                    processorType: "string",
                }],
                textTypeOptions: {},
                timestampTypeOptions: {},
            }],
        },
        retrievalImportance: "string",
        schemaSources: [{
            name: "string",
            processorType: "string",
        }],
        textTypeOptions: {},
        timestampTypeOptions: {},
    }],
    documentIsFolder: false,
});

    type: gcp:essentialcontacts:DocumentAiWarehouseDocumentSchema
properties:
    displayName: string
    documentIsFolder: false
    location: string
    projectNumber: string
    propertyDefinitions:
        - dateTimeTypeOptions: {}
          displayName: string
          enumTypeOptions:
            possibleValues:
                - string
            validationCheckDisabled: false
          floatTypeOptions: {}
          integerTypeOptions: {}
          isFilterable: false
          isMetadata: false
          isRepeatable: false
          isRequired: false
          isSearchable: false
          mapTypeOptions: {}
          name: string
          propertyTypeOptions:
            propertyDefinitions:
                - dateTimeTypeOptions: {}
                  displayName: string
                  enumTypeOptions:
                    possibleValues:
                        - string
                    validationCheckDisabled: false
                  floatTypeOptions: {}
                  integerTypeOptions: {}
                  isFilterable: false
                  isMetadata: false
                  isRepeatable: false
                  isRequired: false
                  isSearchable: false
                  mapTypeOptions: {}
                  name: string
                  retrievalImportance: string
                  schemaSources:
                    - name: string
                      processorType: string
                  textTypeOptions: {}
                  timestampTypeOptions: {}
          retrievalImportance: string
          schemaSources:
            - name: string
              processorType: string
          textTypeOptions: {}
          timestampTypeOptions: {}

    DocumentAiWarehouseDocumentSchema Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DocumentAiWarehouseDocumentSchema resource accepts the following input properties:

    DisplayName string
    Name of the schema given by the user.
    Location string
    The location of the resource.
    ProjectNumber string
    The unique identifier of the project.
    PropertyDefinitions List<DocumentAiWarehouseDocumentSchemaPropertyDefinition>
    Defines the metadata for a schema property. Structure is documented below.
    DocumentIsFolder bool
    Tells whether the document is a folder or a typical document.
    DisplayName string
    Name of the schema given by the user.
    Location string
    The location of the resource.
    ProjectNumber string
    The unique identifier of the project.
    PropertyDefinitions []DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs
    Defines the metadata for a schema property. Structure is documented below.
    DocumentIsFolder bool
    Tells whether the document is a folder or a typical document.
    displayName String
    Name of the schema given by the user.
    location String
    The location of the resource.
    projectNumber String
    The unique identifier of the project.
    propertyDefinitions List<DocumentAiWarehouseDocumentSchemaPropertyDefinition>
    Defines the metadata for a schema property. Structure is documented below.
    documentIsFolder Boolean
    Tells whether the document is a folder or a typical document.
    displayName string
    Name of the schema given by the user.
    location string
    The location of the resource.
    projectNumber string
    The unique identifier of the project.
    propertyDefinitions DocumentAiWarehouseDocumentSchemaPropertyDefinition[]
    Defines the metadata for a schema property. Structure is documented below.
    documentIsFolder boolean
    Tells whether the document is a folder or a typical document.
    display_name str
    Name of the schema given by the user.
    location str
    The location of the resource.
    project_number str
    The unique identifier of the project.
    property_definitions Sequence[DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs]
    Defines the metadata for a schema property. Structure is documented below.
    document_is_folder bool
    Tells whether the document is a folder or a typical document.
    displayName String
    Name of the schema given by the user.
    location String
    The location of the resource.
    projectNumber String
    The unique identifier of the project.
    propertyDefinitions List<Property Map>
    Defines the metadata for a schema property. Structure is documented below.
    documentIsFolder Boolean
    Tells whether the document is a folder or a typical document.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DocumentAiWarehouseDocumentSchema resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the document schema.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name of the document schema.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the document schema.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name of the document schema.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name of the document schema.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name of the document schema.

    Look up Existing DocumentAiWarehouseDocumentSchema Resource

    Get an existing DocumentAiWarehouseDocumentSchema resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DocumentAiWarehouseDocumentSchemaState, opts?: CustomResourceOptions): DocumentAiWarehouseDocumentSchema
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        display_name: Optional[str] = None,
        document_is_folder: Optional[bool] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        project_number: Optional[str] = None,
        property_definitions: Optional[Sequence[DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs]] = None) -> DocumentAiWarehouseDocumentSchema
    func GetDocumentAiWarehouseDocumentSchema(ctx *Context, name string, id IDInput, state *DocumentAiWarehouseDocumentSchemaState, opts ...ResourceOption) (*DocumentAiWarehouseDocumentSchema, error)
    public static DocumentAiWarehouseDocumentSchema Get(string name, Input<string> id, DocumentAiWarehouseDocumentSchemaState? state, CustomResourceOptions? opts = null)
    public static DocumentAiWarehouseDocumentSchema get(String name, Output<String> id, DocumentAiWarehouseDocumentSchemaState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DisplayName string
    Name of the schema given by the user.
    DocumentIsFolder bool
    Tells whether the document is a folder or a typical document.
    Location string
    The location of the resource.
    Name string
    The resource name of the document schema.
    ProjectNumber string
    The unique identifier of the project.
    PropertyDefinitions List<DocumentAiWarehouseDocumentSchemaPropertyDefinition>
    Defines the metadata for a schema property. Structure is documented below.
    DisplayName string
    Name of the schema given by the user.
    DocumentIsFolder bool
    Tells whether the document is a folder or a typical document.
    Location string
    The location of the resource.
    Name string
    The resource name of the document schema.
    ProjectNumber string
    The unique identifier of the project.
    PropertyDefinitions []DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs
    Defines the metadata for a schema property. Structure is documented below.
    displayName String
    Name of the schema given by the user.
    documentIsFolder Boolean
    Tells whether the document is a folder or a typical document.
    location String
    The location of the resource.
    name String
    The resource name of the document schema.
    projectNumber String
    The unique identifier of the project.
    propertyDefinitions List<DocumentAiWarehouseDocumentSchemaPropertyDefinition>
    Defines the metadata for a schema property. Structure is documented below.
    displayName string
    Name of the schema given by the user.
    documentIsFolder boolean
    Tells whether the document is a folder or a typical document.
    location string
    The location of the resource.
    name string
    The resource name of the document schema.
    projectNumber string
    The unique identifier of the project.
    propertyDefinitions DocumentAiWarehouseDocumentSchemaPropertyDefinition[]
    Defines the metadata for a schema property. Structure is documented below.
    display_name str
    Name of the schema given by the user.
    document_is_folder bool
    Tells whether the document is a folder or a typical document.
    location str
    The location of the resource.
    name str
    The resource name of the document schema.
    project_number str
    The unique identifier of the project.
    property_definitions Sequence[DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs]
    Defines the metadata for a schema property. Structure is documented below.
    displayName String
    Name of the schema given by the user.
    documentIsFolder Boolean
    Tells whether the document is a folder or a typical document.
    location String
    The location of the resource.
    name String
    The resource name of the document schema.
    projectNumber String
    The unique identifier of the project.
    propertyDefinitions List<Property Map>
    Defines the metadata for a schema property. Structure is documented below.

    Supporting Types

    DocumentAiWarehouseDocumentSchemaPropertyDefinition, DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs

    Name string
    The name of the metadata property.
    DateTimeTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionDateTimeTypeOptions
    Date time property. Not supported by CMEK compliant deployment.
    DisplayName string
    The display-name for the property, used for front-end.
    EnumTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionEnumTypeOptions
    Enum/categorical property. Structure is documented below.
    FloatTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionFloatTypeOptions
    Float property.
    IntegerTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionIntegerTypeOptions
    Integer property.
    IsFilterable bool
    Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
    IsMetadata bool
    Whether the property is user supplied metadata.
    IsRepeatable bool
    Whether the property can have multiple values.
    IsRequired bool
    Whether the property is mandatory.
    IsSearchable bool
    Indicates that the property should be included in a global search.
    MapTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionMapTypeOptions
    Map property.
    PropertyTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptions
    Nested structured data property. Structure is documented below.
    RetrievalImportance string
    Stores the retrieval importance. Possible values are: HIGHEST, HIGHER, HIGH, MEDIUM, LOW, LOWEST.
    SchemaSources List<DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSource>
    The schema source information. Structure is documented below.
    TextTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionTextTypeOptions
    Text property.
    TimestampTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionTimestampTypeOptions
    Timestamp property. Not supported by CMEK compliant deployment.
    Name string
    The name of the metadata property.
    DateTimeTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionDateTimeTypeOptions
    Date time property. Not supported by CMEK compliant deployment.
    DisplayName string
    The display-name for the property, used for front-end.
    EnumTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionEnumTypeOptions
    Enum/categorical property. Structure is documented below.
    FloatTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionFloatTypeOptions
    Float property.
    IntegerTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionIntegerTypeOptions
    Integer property.
    IsFilterable bool
    Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
    IsMetadata bool
    Whether the property is user supplied metadata.
    IsRepeatable bool
    Whether the property can have multiple values.
    IsRequired bool
    Whether the property is mandatory.
    IsSearchable bool
    Indicates that the property should be included in a global search.
    MapTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionMapTypeOptions
    Map property.
    PropertyTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptions
    Nested structured data property. Structure is documented below.
    RetrievalImportance string
    Stores the retrieval importance. Possible values are: HIGHEST, HIGHER, HIGH, MEDIUM, LOW, LOWEST.
    SchemaSources []DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSource
    The schema source information. Structure is documented below.
    TextTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionTextTypeOptions
    Text property.
    TimestampTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionTimestampTypeOptions
    Timestamp property. Not supported by CMEK compliant deployment.
    name String
    The name of the metadata property.
    dateTimeTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionDateTimeTypeOptions
    Date time property. Not supported by CMEK compliant deployment.
    displayName String
    The display-name for the property, used for front-end.
    enumTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionEnumTypeOptions
    Enum/categorical property. Structure is documented below.
    floatTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionFloatTypeOptions
    Float property.
    integerTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionIntegerTypeOptions
    Integer property.
    isFilterable Boolean
    Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
    isMetadata Boolean
    Whether the property is user supplied metadata.
    isRepeatable Boolean
    Whether the property can have multiple values.
    isRequired Boolean
    Whether the property is mandatory.
    isSearchable Boolean
    Indicates that the property should be included in a global search.
    mapTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionMapTypeOptions
    Map property.
    propertyTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptions
    Nested structured data property. Structure is documented below.
    retrievalImportance String
    Stores the retrieval importance. Possible values are: HIGHEST, HIGHER, HIGH, MEDIUM, LOW, LOWEST.
    schemaSources List<DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSource>
    The schema source information. Structure is documented below.
    textTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionTextTypeOptions
    Text property.
    timestampTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionTimestampTypeOptions
    Timestamp property. Not supported by CMEK compliant deployment.
    name string
    The name of the metadata property.
    dateTimeTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionDateTimeTypeOptions
    Date time property. Not supported by CMEK compliant deployment.
    displayName string
    The display-name for the property, used for front-end.
    enumTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionEnumTypeOptions
    Enum/categorical property. Structure is documented below.
    floatTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionFloatTypeOptions
    Float property.
    integerTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionIntegerTypeOptions
    Integer property.
    isFilterable boolean
    Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
    isMetadata boolean
    Whether the property is user supplied metadata.
    isRepeatable boolean
    Whether the property can have multiple values.
    isRequired boolean
    Whether the property is mandatory.
    isSearchable boolean
    Indicates that the property should be included in a global search.
    mapTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionMapTypeOptions
    Map property.
    propertyTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptions
    Nested structured data property. Structure is documented below.
    retrievalImportance string
    Stores the retrieval importance. Possible values are: HIGHEST, HIGHER, HIGH, MEDIUM, LOW, LOWEST.
    schemaSources DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSource[]
    The schema source information. Structure is documented below.
    textTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionTextTypeOptions
    Text property.
    timestampTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionTimestampTypeOptions
    Timestamp property. Not supported by CMEK compliant deployment.
    name str
    The name of the metadata property.
    date_time_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionDateTimeTypeOptions
    Date time property. Not supported by CMEK compliant deployment.
    display_name str
    The display-name for the property, used for front-end.
    enum_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionEnumTypeOptions
    Enum/categorical property. Structure is documented below.
    float_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionFloatTypeOptions
    Float property.
    integer_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionIntegerTypeOptions
    Integer property.
    is_filterable bool
    Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
    is_metadata bool
    Whether the property is user supplied metadata.
    is_repeatable bool
    Whether the property can have multiple values.
    is_required bool
    Whether the property is mandatory.
    is_searchable bool
    Indicates that the property should be included in a global search.
    map_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionMapTypeOptions
    Map property.
    property_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptions
    Nested structured data property. Structure is documented below.
    retrieval_importance str
    Stores the retrieval importance. Possible values are: HIGHEST, HIGHER, HIGH, MEDIUM, LOW, LOWEST.
    schema_sources Sequence[DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSource]
    The schema source information. Structure is documented below.
    text_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionTextTypeOptions
    Text property.
    timestamp_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionTimestampTypeOptions
    Timestamp property. Not supported by CMEK compliant deployment.
    name String
    The name of the metadata property.
    dateTimeTypeOptions Property Map
    Date time property. Not supported by CMEK compliant deployment.
    displayName String
    The display-name for the property, used for front-end.
    enumTypeOptions Property Map
    Enum/categorical property. Structure is documented below.
    floatTypeOptions Property Map
    Float property.
    integerTypeOptions Property Map
    Integer property.
    isFilterable Boolean
    Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
    isMetadata Boolean
    Whether the property is user supplied metadata.
    isRepeatable Boolean
    Whether the property can have multiple values.
    isRequired Boolean
    Whether the property is mandatory.
    isSearchable Boolean
    Indicates that the property should be included in a global search.
    mapTypeOptions Property Map
    Map property.
    propertyTypeOptions Property Map
    Nested structured data property. Structure is documented below.
    retrievalImportance String
    Stores the retrieval importance. Possible values are: HIGHEST, HIGHER, HIGH, MEDIUM, LOW, LOWEST.
    schemaSources List<Property Map>
    The schema source information. Structure is documented below.
    textTypeOptions Property Map
    Text property.
    timestampTypeOptions Property Map
    Timestamp property. Not supported by CMEK compliant deployment.

    DocumentAiWarehouseDocumentSchemaPropertyDefinitionEnumTypeOptions, DocumentAiWarehouseDocumentSchemaPropertyDefinitionEnumTypeOptionsArgs

    PossibleValues List<string>
    List of possible enum values.
    ValidationCheckDisabled bool
    Make sure the enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.

    PossibleValues []string
    List of possible enum values.
    ValidationCheckDisabled bool
    Make sure the enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.

    possibleValues List<String>
    List of possible enum values.
    validationCheckDisabled Boolean
    Make sure the enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.

    possibleValues string[]
    List of possible enum values.
    validationCheckDisabled boolean
    Make sure the enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.

    possible_values Sequence[str]
    List of possible enum values.
    validation_check_disabled bool
    Make sure the enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.

    possibleValues List<String>
    List of possible enum values.
    validationCheckDisabled Boolean
    Make sure the enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.

    DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptions, DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsArgs

    PropertyDefinitions []DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinition
    Defines the metadata for a schema property. Structure is documented below.
    propertyDefinitions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinition[]
    Defines the metadata for a schema property. Structure is documented below.
    propertyDefinitions List<Property Map>
    Defines the metadata for a schema property. Structure is documented below.

    DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinition, DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionArgs

    Name string
    The name of the metadata property.
    DateTimeTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionDateTimeTypeOptions
    Date time property. Not supported by CMEK compliant deployment.
    DisplayName string
    The display-name for the property, used for front-end.
    EnumTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionEnumTypeOptions
    Enum/categorical property. Structure is documented below.
    FloatTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionFloatTypeOptions
    Float property.
    IntegerTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionIntegerTypeOptions
    Integer property.
    IsFilterable bool
    Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
    IsMetadata bool
    Whether the property is user supplied metadata.
    IsRepeatable bool
    Whether the property can have multiple values.
    IsRequired bool
    Whether the property is mandatory.
    IsSearchable bool
    Indicates that the property should be included in a global search.
    MapTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionMapTypeOptions
    Map property.
    RetrievalImportance string
    Stores the retrieval importance. Possible values are: HIGHEST, HIGHER, HIGH, MEDIUM, LOW, LOWEST.
    SchemaSources List<DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionSchemaSource>
    The schema source information. Structure is documented below.
    TextTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionTextTypeOptions
    Text property.
    TimestampTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionTimestampTypeOptions
    Timestamp property. Not supported by CMEK compliant deployment.
    Name string
    The name of the metadata property.
    DateTimeTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionDateTimeTypeOptions
    Date time property. Not supported by CMEK compliant deployment.
    DisplayName string
    The display-name for the property, used for front-end.
    EnumTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionEnumTypeOptions
    Enum/categorical property. Structure is documented below.
    FloatTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionFloatTypeOptions
    Float property.
    IntegerTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionIntegerTypeOptions
    Integer property.
    IsFilterable bool
    Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
    IsMetadata bool
    Whether the property is user supplied metadata.
    IsRepeatable bool
    Whether the property can have multiple values.
    IsRequired bool
    Whether the property is mandatory.
    IsSearchable bool
    Indicates that the property should be included in a global search.
    MapTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionMapTypeOptions
    Map property.
    RetrievalImportance string
    Stores the retrieval importance. Possible values are: HIGHEST, HIGHER, HIGH, MEDIUM, LOW, LOWEST.
    SchemaSources []DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionSchemaSource
    The schema source information. Structure is documented below.
    TextTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionTextTypeOptions
    Text property.
    TimestampTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionTimestampTypeOptions
    Timestamp property. Not supported by CMEK compliant deployment.
    name String
    The name of the metadata property.
    dateTimeTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionDateTimeTypeOptions
    Date time property. Not supported by CMEK compliant deployment.
    displayName String
    The display-name for the property, used for front-end.
    enumTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionEnumTypeOptions
    Enum/categorical property. Structure is documented below.
    floatTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionFloatTypeOptions
    Float property.
    integerTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionIntegerTypeOptions
    Integer property.
    isFilterable Boolean
    Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
    isMetadata Boolean
    Whether the property is user supplied metadata.
    isRepeatable Boolean
    Whether the property can have multiple values.
    isRequired Boolean
    Whether the property is mandatory.
    isSearchable Boolean
    Indicates that the property should be included in a global search.
    mapTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionMapTypeOptions
    Map property.
    retrievalImportance String
    Stores the retrieval importance. Possible values are: HIGHEST, HIGHER, HIGH, MEDIUM, LOW, LOWEST.
    schemaSources List<DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionSchemaSource>
    The schema source information. Structure is documented below.
    textTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionTextTypeOptions
    Text property.
    timestampTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionTimestampTypeOptions
    Timestamp property. Not supported by CMEK compliant deployment.
    name string
    The name of the metadata property.
    dateTimeTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionDateTimeTypeOptions
    Date time property. Not supported by CMEK compliant deployment.
    displayName string
    The display-name for the property, used for front-end.
    enumTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionEnumTypeOptions
    Enum/categorical property. Structure is documented below.
    floatTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionFloatTypeOptions
    Float property.
    integerTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionIntegerTypeOptions
    Integer property.
    isFilterable boolean
    Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
    isMetadata boolean
    Whether the property is user supplied metadata.
    isRepeatable boolean
    Whether the property can have multiple values.
    isRequired boolean
    Whether the property is mandatory.
    isSearchable boolean
    Indicates that the property should be included in a global search.
    mapTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionMapTypeOptions
    Map property.
    retrievalImportance string
    Stores the retrieval importance. Possible values are: HIGHEST, HIGHER, HIGH, MEDIUM, LOW, LOWEST.
    schemaSources DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionSchemaSource[]
    The schema source information. Structure is documented below.
    textTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionTextTypeOptions
    Text property.
    timestampTypeOptions DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionTimestampTypeOptions
    Timestamp property. Not supported by CMEK compliant deployment.
    name str
    The name of the metadata property.
    date_time_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionDateTimeTypeOptions
    Date time property. Not supported by CMEK compliant deployment.
    display_name str
    The display-name for the property, used for front-end.
    enum_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionEnumTypeOptions
    Enum/categorical property. Structure is documented below.
    float_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionFloatTypeOptions
    Float property.
    integer_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionIntegerTypeOptions
    Integer property.
    is_filterable bool
    Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
    is_metadata bool
    Whether the property is user supplied metadata.
    is_repeatable bool
    Whether the property can have multiple values.
    is_required bool
    Whether the property is mandatory.
    is_searchable bool
    Indicates that the property should be included in a global search.
    map_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionMapTypeOptions
    Map property.
    retrieval_importance str
    Stores the retrieval importance. Possible values are: HIGHEST, HIGHER, HIGH, MEDIUM, LOW, LOWEST.
    schema_sources Sequence[DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionSchemaSource]
    The schema source information. Structure is documented below.
    text_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionTextTypeOptions
    Text property.
    timestamp_type_options DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionTimestampTypeOptions
    Timestamp property. Not supported by CMEK compliant deployment.
    name String
    The name of the metadata property.
    dateTimeTypeOptions Property Map
    Date time property. Not supported by CMEK compliant deployment.
    displayName String
    The display-name for the property, used for front-end.
    enumTypeOptions Property Map
    Enum/categorical property. Structure is documented below.
    floatTypeOptions Property Map
    Float property.
    integerTypeOptions Property Map
    Integer property.
    isFilterable Boolean
    Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
    isMetadata Boolean
    Whether the property is user supplied metadata.
    isRepeatable Boolean
    Whether the property can have multiple values.
    isRequired Boolean
    Whether the property is mandatory.
    isSearchable Boolean
    Indicates that the property should be included in a global search.
    mapTypeOptions Property Map
    Map property.
    retrievalImportance String
    Stores the retrieval importance. Possible values are: HIGHEST, HIGHER, HIGH, MEDIUM, LOW, LOWEST.
    schemaSources List<Property Map>
    The schema source information. Structure is documented below.
    textTypeOptions Property Map
    Text property.
    timestampTypeOptions Property Map
    Timestamp property. Not supported by CMEK compliant deployment.

    DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionEnumTypeOptions, DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionEnumTypeOptionsArgs

    PossibleValues List<string>
    List of possible enum values.
    ValidationCheckDisabled bool
    Make sure the enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.

    PossibleValues []string
    List of possible enum values.
    ValidationCheckDisabled bool
    Make sure the enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.

    possibleValues List<String>
    List of possible enum values.
    validationCheckDisabled Boolean
    Make sure the enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.

    possibleValues string[]
    List of possible enum values.
    validationCheckDisabled boolean
    Make sure the enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.

    possible_values Sequence[str]
    List of possible enum values.
    validation_check_disabled bool
    Make sure the enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.

    possibleValues List<String>
    List of possible enum values.
    validationCheckDisabled Boolean
    Make sure the enum property value provided in the document is in the possile value list during document creation. The validation check runs by default.

    DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionSchemaSource, DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionSchemaSourceArgs

    Name string
    The schema name in the source.
    ProcessorType string
    The Doc AI processor type name.
    Name string
    The schema name in the source.
    ProcessorType string
    The Doc AI processor type name.
    name String
    The schema name in the source.
    processorType String
    The Doc AI processor type name.
    name string
    The schema name in the source.
    processorType string
    The Doc AI processor type name.
    name str
    The schema name in the source.
    processor_type str
    The Doc AI processor type name.
    name String
    The schema name in the source.
    processorType String
    The Doc AI processor type name.

    DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSource, DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs

    Name string
    The schema name in the source.
    ProcessorType string
    The Doc AI processor type name.
    Name string
    The schema name in the source.
    ProcessorType string
    The Doc AI processor type name.
    name String
    The schema name in the source.
    processorType String
    The Doc AI processor type name.
    name string
    The schema name in the source.
    processorType string
    The Doc AI processor type name.
    name str
    The schema name in the source.
    processor_type str
    The Doc AI processor type name.
    name String
    The schema name in the source.
    processorType String
    The Doc AI processor type name.

    Import

    DocumentSchema can be imported using any of these accepted formats:

    • projects/{{project_number}}/locations/{{location}}/documentSchemas/{{name}}

    • {{project_number}}/{{location}}/{{name}}

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

    $ pulumi import gcp:essentialcontacts/documentAiWarehouseDocumentSchema:DocumentAiWarehouseDocumentSchema default projects/{{project_number}}/locations/{{location}}/documentSchemas/{{name}}

    $ pulumi import gcp:essentialcontacts/documentAiWarehouseDocumentSchema:DocumentAiWarehouseDocumentSchema default {{project_number}}/{{location}}/{{name}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v8.3.1 published on Wednesday, Sep 25, 2024 by Pulumi
    pulumi/pulumi-gcp