pulumi-gcp-kotlin/com.pulumi.gcp.essentialcontacts.kotlin/DocumentAiWarehouseDocumentSchema

DocumentAiWarehouseDocumentSchema

class DocumentAiWarehouseDocumentSchema : KotlinCustomResource

A document schema is used to define document structure. To get more information about DocumentSchema, see:

Example Usage

Document Ai Warehouse Document Schema Text

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());
    }
}
Content copied to clipboard

Document Ai Warehouse Document Schema Integer

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.DocumentAiWarehouseDocumentSchemaPropertyDefinitionIntegerTypeOptionsArgs;
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 exampleInteger = new DocumentAiWarehouseDocumentSchema("exampleInteger", DocumentAiWarehouseDocumentSchemaArgs.builder()
            .projectNumber(project.applyValue(getProjectResult -> getProjectResult.number()))
            .displayName("test-property-integer")
            .location("us")
            .propertyDefinitions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs.builder()
                .name("prop1")
                .displayName("propdisp1")
                .isRepeatable(false)
                .isFilterable(true)
                .isSearchable(true)
                .isMetadata(false)
                .isRequired(false)
                .retrievalImportance("HIGHEST")
                .schemaSources(DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs.builder()
                    .name("dummy_source")
                    .processorType("dummy_processor")
                    .build())
                .integerTypeOptions()
                .build())
            .build());
    }
}
Content copied to clipboard

Document Ai Warehouse Document Schema Float

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.DocumentAiWarehouseDocumentSchemaPropertyDefinitionFloatTypeOptionsArgs;
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 exampleFloat = new DocumentAiWarehouseDocumentSchema("exampleFloat", DocumentAiWarehouseDocumentSchemaArgs.builder()
            .projectNumber(project.applyValue(getProjectResult -> getProjectResult.number()))
            .displayName("test-property-float")
            .location("us")
            .propertyDefinitions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs.builder()
                .name("prop2")
                .displayName("propdisp2")
                .isRepeatable(false)
                .isFilterable(true)
                .isSearchable(true)
                .isMetadata(false)
                .isRequired(false)
                .retrievalImportance("HIGHEST")
                .schemaSources(DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs.builder()
                    .name("dummy_source")
                    .processorType("dummy_processor")
                    .build())
                .floatTypeOptions()
                .build())
            .build());
    }
}
Content copied to clipboard

Document Ai Warehouse Document Schema Property

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.DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsArgs;
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 exampleProperty = new DocumentAiWarehouseDocumentSchema("exampleProperty", DocumentAiWarehouseDocumentSchemaArgs.builder()
            .projectNumber(project.applyValue(getProjectResult -> getProjectResult.number()))
            .displayName("test-property-property")
            .location("us")
            .documentIsFolder(false)
            .propertyDefinitions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs.builder()
                .name("prop8")
                .displayName("propdisp8")
                .isRepeatable(false)
                .isFilterable(true)
                .isSearchable(true)
                .isMetadata(false)
                .isRequired(false)
                .retrievalImportance("HIGHEST")
                .schemaSources(DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs.builder()
                    .name("dummy_source")
                    .processorType("dummy_processor")
                    .build())
                .propertyTypeOptions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsArgs.builder()
                    .propertyDefinitions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionArgs.builder()
                        .name("prop8_nested")
                        .displayName("propdisp8_nested")
                        .isRepeatable(false)
                        .isFilterable(true)
                        .isSearchable(true)
                        .isMetadata(false)
                        .isRequired(false)
                        .retrievalImportance("HIGHEST")
                        .schemaSources(DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionSchemaSourceArgs.builder()
                            .name("dummy_source_nested")
                            .processorType("dummy_processor_nested")
                            .build())
                        .textTypeOptions()
                        .build())
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard

Document Ai Warehouse Document Schema Property Enum

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.DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsArgs;
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 examplePropertyEnum = new DocumentAiWarehouseDocumentSchema("examplePropertyEnum", DocumentAiWarehouseDocumentSchemaArgs.builder()
            .projectNumber(project.applyValue(getProjectResult -> getProjectResult.number()))
            .displayName("test-property-property")
            .location("us")
            .documentIsFolder(false)
            .propertyDefinitions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs.builder()
                .name("prop8")
                .displayName("propdisp8")
                .isRepeatable(false)
                .isFilterable(true)
                .isSearchable(true)
                .isMetadata(false)
                .isRequired(false)
                .retrievalImportance("HIGHEST")
                .schemaSources(DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs.builder()
                    .name("dummy_source")
                    .processorType("dummy_processor")
                    .build())
                .propertyTypeOptions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsArgs.builder()
                    .propertyDefinitions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionArgs.builder()
                        .name("prop8_nested")
                        .displayName("propdisp8_nested")
                        .isRepeatable(false)
                        .isFilterable(true)
                        .isSearchable(true)
                        .isMetadata(false)
                        .isRequired(false)
                        .retrievalImportance("HIGHEST")
                        .schemaSources(DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionSchemaSourceArgs.builder()
                            .name("dummy_source_nested")
                            .processorType("dummy_processor_nested")
                            .build())
                        .enumTypeOptions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionEnumTypeOptionsArgs.builder()
                            .possibleValues(
                                "M",
                                "F",
                                "X")
                            .validationCheckDisabled(false)
                            .build())
                        .build())
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard

Document Ai Warehouse Document Schema Enum

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.DocumentAiWarehouseDocumentSchemaPropertyDefinitionEnumTypeOptionsArgs;
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 exampleEnum = new DocumentAiWarehouseDocumentSchema("exampleEnum", DocumentAiWarehouseDocumentSchemaArgs.builder()
            .projectNumber(project.applyValue(getProjectResult -> getProjectResult.number()))
            .displayName("test-property-enum")
            .location("us")
            .propertyDefinitions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs.builder()
                .name("prop6")
                .displayName("propdisp6")
                .isRepeatable(false)
                .isFilterable(true)
                .isSearchable(true)
                .isMetadata(false)
                .isRequired(false)
                .retrievalImportance("HIGHEST")
                .schemaSources(DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs.builder()
                    .name("dummy_source")
                    .processorType("dummy_processor")
                    .build())
                .enumTypeOptions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionEnumTypeOptionsArgs.builder()
                    .possibleValues(
                        "M",
                        "F",
                        "X")
                    .validationCheckDisabled(false)
                    .build())
                .build())
            .build());
    }
}
Content copied to clipboard

Document Ai Warehouse Document Schema Map

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.DocumentAiWarehouseDocumentSchemaPropertyDefinitionMapTypeOptionsArgs;
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 exampleMap = new DocumentAiWarehouseDocumentSchema("exampleMap", DocumentAiWarehouseDocumentSchemaArgs.builder()
            .projectNumber(project.applyValue(getProjectResult -> getProjectResult.number()))
            .displayName("test-property-map")
            .location("us")
            .propertyDefinitions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs.builder()
                .name("prop4")
                .displayName("propdisp4")
                .isRepeatable(false)
                .isFilterable(true)
                .isSearchable(true)
                .isMetadata(false)
                .isRequired(false)
                .retrievalImportance("HIGHEST")
                .schemaSources(DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs.builder()
                    .name("dummy_source")
                    .processorType("dummy_processor")
                    .build())
                .mapTypeOptions()
                .build())
            .build());
    }
}
Content copied to clipboard

Document Ai Warehouse Document Schema Datetime

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.DocumentAiWarehouseDocumentSchemaPropertyDefinitionDateTimeTypeOptionsArgs;
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 exampleDatetime = new DocumentAiWarehouseDocumentSchema("exampleDatetime", DocumentAiWarehouseDocumentSchemaArgs.builder()
            .projectNumber(project.applyValue(getProjectResult -> getProjectResult.number()))
            .displayName("test-property-date_time")
            .location("us")
            .propertyDefinitions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs.builder()
                .name("prop7")
                .displayName("propdisp7")
                .isRepeatable(false)
                .isFilterable(true)
                .isSearchable(true)
                .isMetadata(false)
                .isRequired(false)
                .retrievalImportance("HIGHEST")
                .schemaSources(DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs.builder()
                    .name("dummy_source")
                    .processorType("dummy_processor")
                    .build())
                .dateTimeTypeOptions()
                .build())
            .build());
    }
}
Content copied to clipboard

Document Ai Warehouse Document Schema Timestamp

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.DocumentAiWarehouseDocumentSchemaPropertyDefinitionTimestampTypeOptionsArgs;
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 exampleTimestamp = new DocumentAiWarehouseDocumentSchema("exampleTimestamp", DocumentAiWarehouseDocumentSchemaArgs.builder()
            .projectNumber(project.applyValue(getProjectResult -> getProjectResult.number()))
            .displayName("test-property-timestamp")
            .location("us")
            .propertyDefinitions(DocumentAiWarehouseDocumentSchemaPropertyDefinitionArgs.builder()
                .name("prop5")
                .displayName("propdisp5")
                .isRepeatable(false)
                .isFilterable(true)
                .isSearchable(true)
                .isMetadata(false)
                .isRequired(false)
                .retrievalImportance("HIGHEST")
                .schemaSources(DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs.builder()
                    .name("dummy_source")
                    .processorType("dummy_processor")
                    .build())
                .timestampTypeOptions()
                .build())
            .build());
    }
}
Content copied to clipboard

Import

DocumentSchema can be imported using any of these accepted formats

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

Properties

Link copied to clipboard
val displayName: Output<String>

Name of the schema given by the user.

Link copied to clipboard
val documentIsFolder: Output<Boolean>?

Tells whether the document is a folder or a typical document.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard
val location: Output<String>

The location of the resource.

Link copied to clipboard
val name: Output<String>

The name of the metadata property. (Optional) The schema name in the source. (Required) The name of the metadata property. (Optional) The schema name in the source.

Link copied to clipboard
val projectNumber: Output<String>

The unique identifier of the project.

Link copied to clipboard
val propertyDefinitions: Output<List<DocumentAiWarehouseDocumentSchemaPropertyDefinition>>

Defines the metadata for a schema property. Structure is documented below.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val urn: Output<String>