gcp.essentialcontacts.DocumentAiWarehouseDocumentSchema
Explore with Pulumi AI
A document schema is used to define document structure.
To get more information about DocumentSchema, see:
- API documentation
- How-to Guides
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, &organizations.LookupProjectArgs{}, 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: &essentialcontacts.DocumentAiWarehouseDocumentSchemaPropertyDefinitionTextTypeOptionsArgs{},
},
},
})
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:
- Display
Name string - Name of the schema given by the user.
- Location string
- The location of the resource.
- Project
Number string - The unique identifier of the project.
- Property
Definitions List<DocumentAi Warehouse Document Schema Property Definition> - Defines the metadata for a schema property. Structure is documented below.
- Document
Is boolFolder - Tells whether the document is a folder or a typical document.
- Display
Name string - Name of the schema given by the user.
- Location string
- The location of the resource.
- Project
Number string - The unique identifier of the project.
- Property
Definitions []DocumentAi Warehouse Document Schema Property Definition Args - Defines the metadata for a schema property. Structure is documented below.
- Document
Is boolFolder - Tells whether the document is a folder or a typical document.
- display
Name String - Name of the schema given by the user.
- location String
- The location of the resource.
- project
Number String - The unique identifier of the project.
- property
Definitions List<DocumentAi Warehouse Document Schema Property Definition> - Defines the metadata for a schema property. Structure is documented below.
- document
Is BooleanFolder - Tells whether the document is a folder or a typical document.
- display
Name string - Name of the schema given by the user.
- location string
- The location of the resource.
- project
Number string - The unique identifier of the project.
- property
Definitions DocumentAi Warehouse Document Schema Property Definition[] - Defines the metadata for a schema property. Structure is documented below.
- document
Is booleanFolder - 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[DocumentAi Warehouse Document Schema Property Definition Args] - Defines the metadata for a schema property. Structure is documented below.
- document_
is_ boolfolder - Tells whether the document is a folder or a typical document.
- display
Name String - Name of the schema given by the user.
- location String
- The location of the resource.
- project
Number String - The unique identifier of the project.
- property
Definitions List<Property Map> - Defines the metadata for a schema property. Structure is documented below.
- document
Is BooleanFolder - 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:
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.
- Display
Name string - Name of the schema given by the user.
- Document
Is boolFolder - 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.
- Project
Number string - The unique identifier of the project.
- Property
Definitions List<DocumentAi Warehouse Document Schema Property Definition> - Defines the metadata for a schema property. Structure is documented below.
- Display
Name string - Name of the schema given by the user.
- Document
Is boolFolder - 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.
- Project
Number string - The unique identifier of the project.
- Property
Definitions []DocumentAi Warehouse Document Schema Property Definition Args - Defines the metadata for a schema property. Structure is documented below.
- display
Name String - Name of the schema given by the user.
- document
Is BooleanFolder - 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.
- project
Number String - The unique identifier of the project.
- property
Definitions List<DocumentAi Warehouse Document Schema Property Definition> - Defines the metadata for a schema property. Structure is documented below.
- display
Name string - Name of the schema given by the user.
- document
Is booleanFolder - 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.
- project
Number string - The unique identifier of the project.
- property
Definitions DocumentAi Warehouse Document Schema Property Definition[] - Defines the metadata for a schema property. Structure is documented below.
- display_
name str - Name of the schema given by the user.
- document_
is_ boolfolder - 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[DocumentAi Warehouse Document Schema Property Definition Args] - Defines the metadata for a schema property. Structure is documented below.
- display
Name String - Name of the schema given by the user.
- document
Is BooleanFolder - 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.
- project
Number String - The unique identifier of the project.
- property
Definitions 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.
- Date
Time DocumentType Options Ai Warehouse Document Schema Property Definition Date Time Type Options - Date time property. Not supported by CMEK compliant deployment.
- Display
Name string - The display-name for the property, used for front-end.
- Enum
Type DocumentOptions Ai Warehouse Document Schema Property Definition Enum Type Options - Enum/categorical property. Structure is documented below.
- Float
Type DocumentOptions Ai Warehouse Document Schema Property Definition Float Type Options - Float property.
- Integer
Type DocumentOptions Ai Warehouse Document Schema Property Definition Integer Type Options - 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 DocumentOptions Ai Warehouse Document Schema Property Definition Map Type Options - Map property.
- Property
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options - Nested structured data property. Structure is documented below.
- Retrieval
Importance string - Stores the retrieval importance.
Possible values are:
HIGHEST
,HIGHER
,HIGH
,MEDIUM
,LOW
,LOWEST
. - Schema
Sources List<DocumentAi Warehouse Document Schema Property Definition Schema Source> - The schema source information. Structure is documented below.
- Text
Type DocumentOptions Ai Warehouse Document Schema Property Definition Text Type Options - Text property.
- Timestamp
Type DocumentOptions Ai Warehouse Document Schema Property Definition Timestamp Type Options - Timestamp property. Not supported by CMEK compliant deployment.
- Name string
- The name of the metadata property.
- Date
Time DocumentType Options Ai Warehouse Document Schema Property Definition Date Time Type Options - Date time property. Not supported by CMEK compliant deployment.
- Display
Name string - The display-name for the property, used for front-end.
- Enum
Type DocumentOptions Ai Warehouse Document Schema Property Definition Enum Type Options - Enum/categorical property. Structure is documented below.
- Float
Type DocumentOptions Ai Warehouse Document Schema Property Definition Float Type Options - Float property.
- Integer
Type DocumentOptions Ai Warehouse Document Schema Property Definition Integer Type Options - 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 DocumentOptions Ai Warehouse Document Schema Property Definition Map Type Options - Map property.
- Property
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options - Nested structured data property. Structure is documented below.
- Retrieval
Importance string - Stores the retrieval importance.
Possible values are:
HIGHEST
,HIGHER
,HIGH
,MEDIUM
,LOW
,LOWEST
. - Schema
Sources []DocumentAi Warehouse Document Schema Property Definition Schema Source - The schema source information. Structure is documented below.
- Text
Type DocumentOptions Ai Warehouse Document Schema Property Definition Text Type Options - Text property.
- Timestamp
Type DocumentOptions Ai Warehouse Document Schema Property Definition Timestamp Type Options - Timestamp property. Not supported by CMEK compliant deployment.
- name String
- The name of the metadata property.
- date
Time DocumentType Options Ai Warehouse Document Schema Property Definition Date Time Type Options - Date time property. Not supported by CMEK compliant deployment.
- display
Name String - The display-name for the property, used for front-end.
- enum
Type DocumentOptions Ai Warehouse Document Schema Property Definition Enum Type Options - Enum/categorical property. Structure is documented below.
- float
Type DocumentOptions Ai Warehouse Document Schema Property Definition Float Type Options - Float property.
- integer
Type DocumentOptions Ai Warehouse Document Schema Property Definition Integer Type Options - Integer property.
- is
Filterable Boolean - Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
- is
Metadata Boolean - Whether the property is user supplied metadata.
- is
Repeatable Boolean - Whether the property can have multiple values.
- is
Required Boolean - Whether the property is mandatory.
- is
Searchable Boolean - Indicates that the property should be included in a global search.
- map
Type DocumentOptions Ai Warehouse Document Schema Property Definition Map Type Options - Map property.
- property
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options - Nested structured data property. Structure is documented below.
- retrieval
Importance String - Stores the retrieval importance.
Possible values are:
HIGHEST
,HIGHER
,HIGH
,MEDIUM
,LOW
,LOWEST
. - schema
Sources List<DocumentAi Warehouse Document Schema Property Definition Schema Source> - The schema source information. Structure is documented below.
- text
Type DocumentOptions Ai Warehouse Document Schema Property Definition Text Type Options - Text property.
- timestamp
Type DocumentOptions Ai Warehouse Document Schema Property Definition Timestamp Type Options - Timestamp property. Not supported by CMEK compliant deployment.
- name string
- The name of the metadata property.
- date
Time DocumentType Options Ai Warehouse Document Schema Property Definition Date Time Type Options - Date time property. Not supported by CMEK compliant deployment.
- display
Name string - The display-name for the property, used for front-end.
- enum
Type DocumentOptions Ai Warehouse Document Schema Property Definition Enum Type Options - Enum/categorical property. Structure is documented below.
- float
Type DocumentOptions Ai Warehouse Document Schema Property Definition Float Type Options - Float property.
- integer
Type DocumentOptions Ai Warehouse Document Schema Property Definition Integer Type Options - Integer property.
- is
Filterable boolean - Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
- is
Metadata boolean - Whether the property is user supplied metadata.
- is
Repeatable boolean - Whether the property can have multiple values.
- is
Required boolean - Whether the property is mandatory.
- is
Searchable boolean - Indicates that the property should be included in a global search.
- map
Type DocumentOptions Ai Warehouse Document Schema Property Definition Map Type Options - Map property.
- property
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options - Nested structured data property. Structure is documented below.
- retrieval
Importance string - Stores the retrieval importance.
Possible values are:
HIGHEST
,HIGHER
,HIGH
,MEDIUM
,LOW
,LOWEST
. - schema
Sources DocumentAi Warehouse Document Schema Property Definition Schema Source[] - The schema source information. Structure is documented below.
- text
Type DocumentOptions Ai Warehouse Document Schema Property Definition Text Type Options - Text property.
- timestamp
Type DocumentOptions Ai Warehouse Document Schema Property Definition Timestamp Type Options - Timestamp property. Not supported by CMEK compliant deployment.
- name str
- The name of the metadata property.
- date_
time_ Documenttype_ options Ai Warehouse Document Schema Property Definition Date Time Type Options - Date time property. Not supported by CMEK compliant deployment.
- display_
name str - The display-name for the property, used for front-end.
- enum_
type_ Documentoptions Ai Warehouse Document Schema Property Definition Enum Type Options - Enum/categorical property. Structure is documented below.
- float_
type_ Documentoptions Ai Warehouse Document Schema Property Definition Float Type Options - Float property.
- integer_
type_ Documentoptions Ai Warehouse Document Schema Property Definition Integer Type Options - 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_ Documentoptions Ai Warehouse Document Schema Property Definition Map Type Options - Map property.
- property_
type_ Documentoptions Ai Warehouse Document Schema Property Definition Property Type Options - 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[DocumentAi Warehouse Document Schema Property Definition Schema Source] - The schema source information. Structure is documented below.
- text_
type_ Documentoptions Ai Warehouse Document Schema Property Definition Text Type Options - Text property.
- timestamp_
type_ Documentoptions Ai Warehouse Document Schema Property Definition Timestamp Type Options - Timestamp property. Not supported by CMEK compliant deployment.
- name String
- The name of the metadata property.
- date
Time Property MapType Options - Date time property. Not supported by CMEK compliant deployment.
- display
Name String - The display-name for the property, used for front-end.
- enum
Type Property MapOptions - Enum/categorical property. Structure is documented below.
- float
Type Property MapOptions - Float property.
- integer
Type Property MapOptions - Integer property.
- is
Filterable Boolean - Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
- is
Metadata Boolean - Whether the property is user supplied metadata.
- is
Repeatable Boolean - Whether the property can have multiple values.
- is
Required Boolean - Whether the property is mandatory.
- is
Searchable Boolean - Indicates that the property should be included in a global search.
- map
Type Property MapOptions - Map property.
- property
Type Property MapOptions - Nested structured data property. Structure is documented below.
- retrieval
Importance String - Stores the retrieval importance.
Possible values are:
HIGHEST
,HIGHER
,HIGH
,MEDIUM
,LOW
,LOWEST
. - schema
Sources List<Property Map> - The schema source information. Structure is documented below.
- text
Type Property MapOptions - Text property.
- timestamp
Type Property MapOptions - Timestamp property. Not supported by CMEK compliant deployment.
DocumentAiWarehouseDocumentSchemaPropertyDefinitionEnumTypeOptions, DocumentAiWarehouseDocumentSchemaPropertyDefinitionEnumTypeOptionsArgs
- Possible
Values List<string> - List of possible enum values.
- Validation
Check boolDisabled - 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 []string - List of possible enum values.
- Validation
Check boolDisabled - 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 List<String> - List of possible enum values.
- validation
Check BooleanDisabled - 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 string[] - List of possible enum values.
- validation
Check booleanDisabled - 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_ booldisabled - 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 List<String> - List of possible enum values.
- validation
Check BooleanDisabled - 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
- Property
Definitions List<DocumentAi Warehouse Document Schema Property Definition Property Type Options Property Definition> - Defines the metadata for a schema property. Structure is documented below.
- Property
Definitions []DocumentAi Warehouse Document Schema Property Definition Property Type Options Property Definition - Defines the metadata for a schema property. Structure is documented below.
- property
Definitions List<DocumentAi Warehouse Document Schema Property Definition Property Type Options Property Definition> - Defines the metadata for a schema property. Structure is documented below.
- property
Definitions DocumentAi Warehouse Document Schema Property Definition Property Type Options Property Definition[] - Defines the metadata for a schema property. Structure is documented below.
- property_
definitions Sequence[DocumentAi Warehouse Document Schema Property Definition Property Type Options Property Definition] - Defines the metadata for a schema property. Structure is documented below.
- property
Definitions List<Property Map> - Defines the metadata for a schema property. Structure is documented below.
DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinition, DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionArgs
- Name string
- The name of the metadata property.
- Date
Time DocumentType Options Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Date Time Type Options - Date time property. Not supported by CMEK compliant deployment.
- Display
Name string - The display-name for the property, used for front-end.
- Enum
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Enum Type Options - Enum/categorical property. Structure is documented below.
- Float
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Float Type Options - Float property.
- Integer
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Integer Type Options - 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 DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Map Type Options - Map property.
- Retrieval
Importance string - Stores the retrieval importance.
Possible values are:
HIGHEST
,HIGHER
,HIGH
,MEDIUM
,LOW
,LOWEST
. - Schema
Sources List<DocumentAi Warehouse Document Schema Property Definition Property Type Options Property Definition Schema Source> - The schema source information. Structure is documented below.
- Text
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Text Type Options - Text property.
- Timestamp
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Timestamp Type Options - Timestamp property. Not supported by CMEK compliant deployment.
- Name string
- The name of the metadata property.
- Date
Time DocumentType Options Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Date Time Type Options - Date time property. Not supported by CMEK compliant deployment.
- Display
Name string - The display-name for the property, used for front-end.
- Enum
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Enum Type Options - Enum/categorical property. Structure is documented below.
- Float
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Float Type Options - Float property.
- Integer
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Integer Type Options - 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 DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Map Type Options - Map property.
- Retrieval
Importance string - Stores the retrieval importance.
Possible values are:
HIGHEST
,HIGHER
,HIGH
,MEDIUM
,LOW
,LOWEST
. - Schema
Sources []DocumentAi Warehouse Document Schema Property Definition Property Type Options Property Definition Schema Source - The schema source information. Structure is documented below.
- Text
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Text Type Options - Text property.
- Timestamp
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Timestamp Type Options - Timestamp property. Not supported by CMEK compliant deployment.
- name String
- The name of the metadata property.
- date
Time DocumentType Options Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Date Time Type Options - Date time property. Not supported by CMEK compliant deployment.
- display
Name String - The display-name for the property, used for front-end.
- enum
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Enum Type Options - Enum/categorical property. Structure is documented below.
- float
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Float Type Options - Float property.
- integer
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Integer Type Options - Integer property.
- is
Filterable Boolean - Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
- is
Metadata Boolean - Whether the property is user supplied metadata.
- is
Repeatable Boolean - Whether the property can have multiple values.
- is
Required Boolean - Whether the property is mandatory.
- is
Searchable Boolean - Indicates that the property should be included in a global search.
- map
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Map Type Options - Map property.
- retrieval
Importance String - Stores the retrieval importance.
Possible values are:
HIGHEST
,HIGHER
,HIGH
,MEDIUM
,LOW
,LOWEST
. - schema
Sources List<DocumentAi Warehouse Document Schema Property Definition Property Type Options Property Definition Schema Source> - The schema source information. Structure is documented below.
- text
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Text Type Options - Text property.
- timestamp
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Timestamp Type Options - Timestamp property. Not supported by CMEK compliant deployment.
- name string
- The name of the metadata property.
- date
Time DocumentType Options Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Date Time Type Options - Date time property. Not supported by CMEK compliant deployment.
- display
Name string - The display-name for the property, used for front-end.
- enum
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Enum Type Options - Enum/categorical property. Structure is documented below.
- float
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Float Type Options - Float property.
- integer
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Integer Type Options - Integer property.
- is
Filterable boolean - Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
- is
Metadata boolean - Whether the property is user supplied metadata.
- is
Repeatable boolean - Whether the property can have multiple values.
- is
Required boolean - Whether the property is mandatory.
- is
Searchable boolean - Indicates that the property should be included in a global search.
- map
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Map Type Options - Map property.
- retrieval
Importance string - Stores the retrieval importance.
Possible values are:
HIGHEST
,HIGHER
,HIGH
,MEDIUM
,LOW
,LOWEST
. - schema
Sources DocumentAi Warehouse Document Schema Property Definition Property Type Options Property Definition Schema Source[] - The schema source information. Structure is documented below.
- text
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Text Type Options - Text property.
- timestamp
Type DocumentOptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Timestamp Type Options - Timestamp property. Not supported by CMEK compliant deployment.
- name str
- The name of the metadata property.
- date_
time_ Documenttype_ options Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Date Time Type Options - Date time property. Not supported by CMEK compliant deployment.
- display_
name str - The display-name for the property, used for front-end.
- enum_
type_ Documentoptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Enum Type Options - Enum/categorical property. Structure is documented below.
- float_
type_ Documentoptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Float Type Options - Float property.
- integer_
type_ Documentoptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Integer Type Options - 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_ Documentoptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Map Type Options - Map property.
- retrieval_
importance str - Stores the retrieval importance.
Possible values are:
HIGHEST
,HIGHER
,HIGH
,MEDIUM
,LOW
,LOWEST
. - schema_
sources Sequence[DocumentAi Warehouse Document Schema Property Definition Property Type Options Property Definition Schema Source] - The schema source information. Structure is documented below.
- text_
type_ Documentoptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Text Type Options - Text property.
- timestamp_
type_ Documentoptions Ai Warehouse Document Schema Property Definition Property Type Options Property Definition Timestamp Type Options - Timestamp property. Not supported by CMEK compliant deployment.
- name String
- The name of the metadata property.
- date
Time Property MapType Options - Date time property. Not supported by CMEK compliant deployment.
- display
Name String - The display-name for the property, used for front-end.
- enum
Type Property MapOptions - Enum/categorical property. Structure is documented below.
- float
Type Property MapOptions - Float property.
- integer
Type Property MapOptions - Integer property.
- is
Filterable Boolean - Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable.
- is
Metadata Boolean - Whether the property is user supplied metadata.
- is
Repeatable Boolean - Whether the property can have multiple values.
- is
Required Boolean - Whether the property is mandatory.
- is
Searchable Boolean - Indicates that the property should be included in a global search.
- map
Type Property MapOptions - Map property.
- retrieval
Importance String - Stores the retrieval importance.
Possible values are:
HIGHEST
,HIGHER
,HIGH
,MEDIUM
,LOW
,LOWEST
. - schema
Sources List<Property Map> - The schema source information. Structure is documented below.
- text
Type Property MapOptions - Text property.
- timestamp
Type Property MapOptions - Timestamp property. Not supported by CMEK compliant deployment.
DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionEnumTypeOptions, DocumentAiWarehouseDocumentSchemaPropertyDefinitionPropertyTypeOptionsPropertyDefinitionEnumTypeOptionsArgs
- Possible
Values List<string> - List of possible enum values.
- Validation
Check boolDisabled - 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 []string - List of possible enum values.
- Validation
Check boolDisabled - 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 List<String> - List of possible enum values.
- validation
Check BooleanDisabled - 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 string[] - List of possible enum values.
- validation
Check booleanDisabled - 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_ booldisabled - 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 List<String> - List of possible enum values.
- validation
Check BooleanDisabled - 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.
- Processor
Type string - The Doc AI processor type name.
- Name string
- The schema name in the source.
- Processor
Type string - The Doc AI processor type name.
- name String
- The schema name in the source.
- processor
Type String - The Doc AI processor type name.
- name string
- The schema name in the source.
- processor
Type 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.
- processor
Type String - The Doc AI processor type name.
DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSource, DocumentAiWarehouseDocumentSchemaPropertyDefinitionSchemaSourceArgs
- Name string
- The schema name in the source.
- Processor
Type string - The Doc AI processor type name.
- Name string
- The schema name in the source.
- Processor
Type string - The Doc AI processor type name.
- name String
- The schema name in the source.
- processor
Type String - The Doc AI processor type name.
- name string
- The schema name in the source.
- processor
Type 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.
- processor
Type 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.