Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. contentwarehouse
  5. contentwarehouse/v1
  6. DocumentSchema

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.contentwarehouse/v1.DocumentSchema

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a document schema.

    Create DocumentSchema Resource

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

    Constructor syntax

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

@overload
def DocumentSchema(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   display_name: Optional[str] = None,
                   description: Optional[str] = None,
                   document_is_folder: Optional[bool] = None,
                   location: Optional[str] = None,
                   name: Optional[str] = None,
                   project: Optional[str] = None,
                   property_definitions: Optional[Sequence[GoogleCloudContentwarehouseV1PropertyDefinitionArgs]] = None)
    func NewDocumentSchema(ctx *Context, name string, args DocumentSchemaArgs, opts ...ResourceOption) (*DocumentSchema, error)
    public DocumentSchema(string name, DocumentSchemaArgs args, CustomResourceOptions? opts = null)
    public DocumentSchema(String name, DocumentSchemaArgs args)
public DocumentSchema(String name, DocumentSchemaArgs args, CustomResourceOptions options)

    type: google-native:contentwarehouse/v1:DocumentSchema
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 DocumentSchemaArgs
    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 DocumentSchemaArgs
    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 DocumentSchemaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DocumentSchemaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DocumentSchemaArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var documentSchemaResource = new GoogleNative.Contentwarehouse.V1.DocumentSchema("documentSchemaResource", new()
{
    DisplayName = "string",
    Description = "string",
    DocumentIsFolder = false,
    Location = "string",
    Name = "string",
    Project = "string",
    PropertyDefinitions = new[]
    {
        new GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1PropertyDefinitionArgs
        {
            Name = "string",
            IsRequired = false,
            IsRepeatable = false,
            FloatTypeOptions = null,
            IntegerTypeOptions = null,
            IsSearchable = false,
            IsMetadata = false,
            EnumTypeOptions = new GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1EnumTypeOptionsArgs
            {
                PossibleValues = new[]
                {
                    "string",
                },
                ValidationCheckDisabled = false,
            },
            DateTimeTypeOptions = null,
            IsFilterable = false,
            MapTypeOptions = null,
            DisplayName = "string",
            PropertyTypeOptions = new GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1PropertyTypeOptionsArgs
            {
                PropertyDefinitions = new[]
                {
                    googleCloudContentwarehouseV1PropertyDefinition,
                },
            },
            RetrievalImportance = GoogleNative.Contentwarehouse.V1.GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportance.RetrievalImportanceUnspecified,
            SchemaSources = new[]
            {
                new GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSourceArgs
                {
                    Name = "string",
                    ProcessorType = "string",
                },
            },
            TextTypeOptions = null,
            TimestampTypeOptions = null,
        },
    },
});

    example, err := contentwarehouse.NewDocumentSchema(ctx, "documentSchemaResource", &contentwarehouse.DocumentSchemaArgs{
DisplayName: pulumi.String("string"),
Description: pulumi.String("string"),
DocumentIsFolder: pulumi.Bool(false),
Location: pulumi.String("string"),
Name: pulumi.String("string"),
Project: pulumi.String("string"),
PropertyDefinitions: contentwarehouse.GoogleCloudContentwarehouseV1PropertyDefinitionArray{
&contentwarehouse.GoogleCloudContentwarehouseV1PropertyDefinitionArgs{
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: &contentwarehouse.GoogleCloudContentwarehouseV1EnumTypeOptionsArgs{
PossibleValues: pulumi.StringArray{
pulumi.String("string"),
},
ValidationCheckDisabled: pulumi.Bool(false),
},
DateTimeTypeOptions: nil,
IsFilterable: pulumi.Bool(false),
MapTypeOptions: nil,
DisplayName: pulumi.String("string"),
PropertyTypeOptions: &contentwarehouse.GoogleCloudContentwarehouseV1PropertyTypeOptionsArgs{
PropertyDefinitions: contentwarehouse.GoogleCloudContentwarehouseV1PropertyDefinitionArray{
googleCloudContentwarehouseV1PropertyDefinition,
},
},
RetrievalImportance: contentwarehouse.GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportanceRetrievalImportanceUnspecified,
SchemaSources: contentwarehouse.GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSourceArray{
&contentwarehouse.GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSourceArgs{
Name: pulumi.String("string"),
ProcessorType: pulumi.String("string"),
},
},
TextTypeOptions: nil,
TimestampTypeOptions: nil,
},
},
})

    var documentSchemaResource = new DocumentSchema("documentSchemaResource", DocumentSchemaArgs.builder()        
    .displayName("string")
    .description("string")
    .documentIsFolder(false)
    .location("string")
    .name("string")
    .project("string")
    .propertyDefinitions(GoogleCloudContentwarehouseV1PropertyDefinitionArgs.builder()
        .name("string")
        .isRequired(false)
        .isRepeatable(false)
        .floatTypeOptions()
        .integerTypeOptions()
        .isSearchable(false)
        .isMetadata(false)
        .enumTypeOptions(GoogleCloudContentwarehouseV1EnumTypeOptionsArgs.builder()
            .possibleValues("string")
            .validationCheckDisabled(false)
            .build())
        .dateTimeTypeOptions()
        .isFilterable(false)
        .mapTypeOptions()
        .displayName("string")
        .propertyTypeOptions(GoogleCloudContentwarehouseV1PropertyTypeOptionsArgs.builder()
            .propertyDefinitions(googleCloudContentwarehouseV1PropertyDefinition)
            .build())
        .retrievalImportance("RETRIEVAL_IMPORTANCE_UNSPECIFIED")
        .schemaSources(GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSourceArgs.builder()
            .name("string")
            .processorType("string")
            .build())
        .textTypeOptions()
        .timestampTypeOptions()
        .build())
    .build());

    document_schema_resource = google_native.contentwarehouse.v1.DocumentSchema("documentSchemaResource",
    display_name="string",
    description="string",
    document_is_folder=False,
    location="string",
    name="string",
    project="string",
    property_definitions=[google_native.contentwarehouse.v1.GoogleCloudContentwarehouseV1PropertyDefinitionArgs(
        name="string",
        is_required=False,
        is_repeatable=False,
        float_type_options=google_native.contentwarehouse.v1.GoogleCloudContentwarehouseV1FloatTypeOptionsArgs(),
        integer_type_options=google_native.contentwarehouse.v1.GoogleCloudContentwarehouseV1IntegerTypeOptionsArgs(),
        is_searchable=False,
        is_metadata=False,
        enum_type_options=google_native.contentwarehouse.v1.GoogleCloudContentwarehouseV1EnumTypeOptionsArgs(
            possible_values=["string"],
            validation_check_disabled=False,
        ),
        date_time_type_options=google_native.contentwarehouse.v1.GoogleCloudContentwarehouseV1DateTimeTypeOptionsArgs(),
        is_filterable=False,
        map_type_options=google_native.contentwarehouse.v1.GoogleCloudContentwarehouseV1MapTypeOptionsArgs(),
        display_name="string",
        property_type_options=google_native.contentwarehouse.v1.GoogleCloudContentwarehouseV1PropertyTypeOptionsArgs(
            property_definitions=[google_cloud_contentwarehouse_v1_property_definition],
        ),
        retrieval_importance=google_native.contentwarehouse.v1.GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportance.RETRIEVAL_IMPORTANCE_UNSPECIFIED,
        schema_sources=[google_native.contentwarehouse.v1.GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSourceArgs(
            name="string",
            processor_type="string",
        )],
        text_type_options=google_native.contentwarehouse.v1.GoogleCloudContentwarehouseV1TextTypeOptionsArgs(),
        timestamp_type_options=google_native.contentwarehouse.v1.GoogleCloudContentwarehouseV1TimestampTypeOptionsArgs(),
    )])

    const documentSchemaResource = new google_native.contentwarehouse.v1.DocumentSchema("documentSchemaResource", {
    displayName: "string",
    description: "string",
    documentIsFolder: false,
    location: "string",
    name: "string",
    project: "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: [googleCloudContentwarehouseV1PropertyDefinition],
        },
        retrievalImportance: google_native.contentwarehouse.v1.GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportance.RetrievalImportanceUnspecified,
        schemaSources: [{
            name: "string",
            processorType: "string",
        }],
        textTypeOptions: {},
        timestampTypeOptions: {},
    }],
});

    type: google-native:contentwarehouse/v1:DocumentSchema
properties:
    description: string
    displayName: string
    documentIsFolder: false
    location: string
    name: string
    project: 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:
                - ${googleCloudContentwarehouseV1PropertyDefinition}
          retrievalImportance: RETRIEVAL_IMPORTANCE_UNSPECIFIED
          schemaSources:
            - name: string
              processorType: string
          textTypeOptions: {}
          timestampTypeOptions: {}

    DocumentSchema 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 DocumentSchema resource accepts the following input properties:

    DisplayName string
    Name of the schema given by the user. Must be unique per project.
    Description string
    Schema description.
    DocumentIsFolder bool
    Document Type, true refers the document is a folder, otherwise it is a typical document.
    Location string
    Name string
    The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
    Project string
    PropertyDefinitions List<Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1PropertyDefinition>
    Document details.
    DisplayName string
    Name of the schema given by the user. Must be unique per project.
    Description string
    Schema description.
    DocumentIsFolder bool
    Document Type, true refers the document is a folder, otherwise it is a typical document.
    Location string
    Name string
    The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
    Project string
    PropertyDefinitions []GoogleCloudContentwarehouseV1PropertyDefinitionArgs
    Document details.
    displayName String
    Name of the schema given by the user. Must be unique per project.
    description String
    Schema description.
    documentIsFolder Boolean
    Document Type, true refers the document is a folder, otherwise it is a typical document.
    location String
    name String
    The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
    project String
    propertyDefinitions List<GoogleCloudContentwarehouseV1PropertyDefinition>
    Document details.
    displayName string
    Name of the schema given by the user. Must be unique per project.
    description string
    Schema description.
    documentIsFolder boolean
    Document Type, true refers the document is a folder, otherwise it is a typical document.
    location string
    name string
    The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
    project string
    propertyDefinitions GoogleCloudContentwarehouseV1PropertyDefinition[]
    Document details.
    display_name str
    Name of the schema given by the user. Must be unique per project.
    description str
    Schema description.
    document_is_folder bool
    Document Type, true refers the document is a folder, otherwise it is a typical document.
    location str
    name str
    The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
    project str
    property_definitions Sequence[GoogleCloudContentwarehouseV1PropertyDefinitionArgs]
    Document details.
    displayName String
    Name of the schema given by the user. Must be unique per project.
    description String
    Schema description.
    documentIsFolder Boolean
    Document Type, true refers the document is a folder, otherwise it is a typical document.
    location String
    name String
    The resource name of the document schema. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}. The name is ignored when creating a document schema.
    project String
    propertyDefinitions List<Property Map>
    Document details.

    Outputs

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

    CreateTime string
    The time when the document schema is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateTime string
    The time when the document schema is last updated.
    CreateTime string
    The time when the document schema is created.
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdateTime string
    The time when the document schema is last updated.
    createTime String
    The time when the document schema is created.
    id String
    The provider-assigned unique ID for this managed resource.
    updateTime String
    The time when the document schema is last updated.
    createTime string
    The time when the document schema is created.
    id string
    The provider-assigned unique ID for this managed resource.
    updateTime string
    The time when the document schema is last updated.
    create_time str
    The time when the document schema is created.
    id str
    The provider-assigned unique ID for this managed resource.
    update_time str
    The time when the document schema is last updated.
    createTime String
    The time when the document schema is created.
    id String
    The provider-assigned unique ID for this managed resource.
    updateTime String
    The time when the document schema is last updated.

    Supporting Types

    GoogleCloudContentwarehouseV1EnumTypeOptions, GoogleCloudContentwarehouseV1EnumTypeOptionsArgs

    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.

    GoogleCloudContentwarehouseV1EnumTypeOptionsResponse, GoogleCloudContentwarehouseV1EnumTypeOptionsResponseArgs

    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.

    GoogleCloudContentwarehouseV1PropertyDefinition, GoogleCloudContentwarehouseV1PropertyDefinitionArgs

    Name string
    The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
    DateTimeTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1DateTimeTypeOptions
    Date time property. It is not supported by CMEK compliant deployment.
    DisplayName string
    The display-name for the property, used for front-end.
    EnumTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1EnumTypeOptions
    Enum/categorical property.
    FloatTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1FloatTypeOptions
    Float property.
    IntegerTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1IntegerTypeOptions
    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. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
    IsRepeatable bool
    Whether the property can have multiple values.
    IsRequired bool
    Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
    IsSearchable bool
    Indicates that the property should be included in a global search.
    MapTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1MapTypeOptions
    Map property.
    PropertyTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1PropertyTypeOptions
    Nested structured data property.
    RetrievalImportance Pulumi.GoogleNative.Contentwarehouse.V1.GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportance
    The retrieval importance of the property during search.
    SchemaSources List<Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource>
    The mapping information between this property to another schema source.
    TextTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1TextTypeOptions
    Text/string property.
    TimestampTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1TimestampTypeOptions
    Timestamp property. It is not supported by CMEK compliant deployment.
    Name string
    The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
    DateTimeTypeOptions GoogleCloudContentwarehouseV1DateTimeTypeOptions
    Date time property. It is not supported by CMEK compliant deployment.
    DisplayName string
    The display-name for the property, used for front-end.
    EnumTypeOptions GoogleCloudContentwarehouseV1EnumTypeOptions
    Enum/categorical property.
    FloatTypeOptions GoogleCloudContentwarehouseV1FloatTypeOptions
    Float property.
    IntegerTypeOptions GoogleCloudContentwarehouseV1IntegerTypeOptions
    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. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
    IsRepeatable bool
    Whether the property can have multiple values.
    IsRequired bool
    Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
    IsSearchable bool
    Indicates that the property should be included in a global search.
    MapTypeOptions GoogleCloudContentwarehouseV1MapTypeOptions
    Map property.
    PropertyTypeOptions GoogleCloudContentwarehouseV1PropertyTypeOptions
    Nested structured data property.
    RetrievalImportance GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportance
    The retrieval importance of the property during search.
    SchemaSources []GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource
    The mapping information between this property to another schema source.
    TextTypeOptions GoogleCloudContentwarehouseV1TextTypeOptions
    Text/string property.
    TimestampTypeOptions GoogleCloudContentwarehouseV1TimestampTypeOptions
    Timestamp property. It is not supported by CMEK compliant deployment.
    name String
    The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
    dateTimeTypeOptions GoogleCloudContentwarehouseV1DateTimeTypeOptions
    Date time property. It is not supported by CMEK compliant deployment.
    displayName String
    The display-name for the property, used for front-end.
    enumTypeOptions GoogleCloudContentwarehouseV1EnumTypeOptions
    Enum/categorical property.
    floatTypeOptions GoogleCloudContentwarehouseV1FloatTypeOptions
    Float property.
    integerTypeOptions GoogleCloudContentwarehouseV1IntegerTypeOptions
    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. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
    isRepeatable Boolean
    Whether the property can have multiple values.
    isRequired Boolean
    Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
    isSearchable Boolean
    Indicates that the property should be included in a global search.
    mapTypeOptions GoogleCloudContentwarehouseV1MapTypeOptions
    Map property.
    propertyTypeOptions GoogleCloudContentwarehouseV1PropertyTypeOptions
    Nested structured data property.
    retrievalImportance GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportance
    The retrieval importance of the property during search.
    schemaSources List<GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource>
    The mapping information between this property to another schema source.
    textTypeOptions GoogleCloudContentwarehouseV1TextTypeOptions
    Text/string property.
    timestampTypeOptions GoogleCloudContentwarehouseV1TimestampTypeOptions
    Timestamp property. It is not supported by CMEK compliant deployment.
    name string
    The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
    dateTimeTypeOptions GoogleCloudContentwarehouseV1DateTimeTypeOptions
    Date time property. It is not supported by CMEK compliant deployment.
    displayName string
    The display-name for the property, used for front-end.
    enumTypeOptions GoogleCloudContentwarehouseV1EnumTypeOptions
    Enum/categorical property.
    floatTypeOptions GoogleCloudContentwarehouseV1FloatTypeOptions
    Float property.
    integerTypeOptions GoogleCloudContentwarehouseV1IntegerTypeOptions
    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. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
    isRepeatable boolean
    Whether the property can have multiple values.
    isRequired boolean
    Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
    isSearchable boolean
    Indicates that the property should be included in a global search.
    mapTypeOptions GoogleCloudContentwarehouseV1MapTypeOptions
    Map property.
    propertyTypeOptions GoogleCloudContentwarehouseV1PropertyTypeOptions
    Nested structured data property.
    retrievalImportance GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportance
    The retrieval importance of the property during search.
    schemaSources GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource[]
    The mapping information between this property to another schema source.
    textTypeOptions GoogleCloudContentwarehouseV1TextTypeOptions
    Text/string property.
    timestampTypeOptions GoogleCloudContentwarehouseV1TimestampTypeOptions
    Timestamp property. It is not supported by CMEK compliant deployment.
    name str
    The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
    date_time_type_options GoogleCloudContentwarehouseV1DateTimeTypeOptions
    Date time property. It is not supported by CMEK compliant deployment.
    display_name str
    The display-name for the property, used for front-end.
    enum_type_options GoogleCloudContentwarehouseV1EnumTypeOptions
    Enum/categorical property.
    float_type_options GoogleCloudContentwarehouseV1FloatTypeOptions
    Float property.
    integer_type_options GoogleCloudContentwarehouseV1IntegerTypeOptions
    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. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
    is_repeatable bool
    Whether the property can have multiple values.
    is_required bool
    Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
    is_searchable bool
    Indicates that the property should be included in a global search.
    map_type_options GoogleCloudContentwarehouseV1MapTypeOptions
    Map property.
    property_type_options GoogleCloudContentwarehouseV1PropertyTypeOptions
    Nested structured data property.
    retrieval_importance GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportance
    The retrieval importance of the property during search.
    schema_sources Sequence[GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource]
    The mapping information between this property to another schema source.
    text_type_options GoogleCloudContentwarehouseV1TextTypeOptions
    Text/string property.
    timestamp_type_options GoogleCloudContentwarehouseV1TimestampTypeOptions
    Timestamp property. It is not supported by CMEK compliant deployment.
    name String
    The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
    dateTimeTypeOptions Property Map
    Date time property. It is not supported by CMEK compliant deployment.
    displayName String
    The display-name for the property, used for front-end.
    enumTypeOptions Property Map
    Enum/categorical property.
    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. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
    isRepeatable Boolean
    Whether the property can have multiple values.
    isRequired Boolean
    Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
    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.
    retrievalImportance "RETRIEVAL_IMPORTANCE_UNSPECIFIED" | "HIGHEST" | "HIGHER" | "HIGH" | "MEDIUM" | "LOW" | "LOWEST"
    The retrieval importance of the property during search.
    schemaSources List<Property Map>
    The mapping information between this property to another schema source.
    textTypeOptions Property Map
    Text/string property.
    timestampTypeOptions Property Map
    Timestamp property. It is not supported by CMEK compliant deployment.

    GoogleCloudContentwarehouseV1PropertyDefinitionResponse, GoogleCloudContentwarehouseV1PropertyDefinitionResponseArgs

    DateTimeTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1DateTimeTypeOptionsResponse
    Date time property. It is not supported by CMEK compliant deployment.
    DisplayName string
    The display-name for the property, used for front-end.
    EnumTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1EnumTypeOptionsResponse
    Enum/categorical property.
    FloatTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1FloatTypeOptionsResponse
    Float property.
    IntegerTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1IntegerTypeOptionsResponse
    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. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
    IsRepeatable bool
    Whether the property can have multiple values.
    IsRequired bool
    Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
    IsSearchable bool
    Indicates that the property should be included in a global search.
    MapTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1MapTypeOptionsResponse
    Map property.
    Name string
    The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
    PropertyTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1PropertyTypeOptionsResponse
    Nested structured data property.
    RetrievalImportance string
    The retrieval importance of the property during search.
    SchemaSources List<Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSourceResponse>
    The mapping information between this property to another schema source.
    TextTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1TextTypeOptionsResponse
    Text/string property.
    TimestampTypeOptions Pulumi.GoogleNative.Contentwarehouse.V1.Inputs.GoogleCloudContentwarehouseV1TimestampTypeOptionsResponse
    Timestamp property. It is not supported by CMEK compliant deployment.
    DateTimeTypeOptions GoogleCloudContentwarehouseV1DateTimeTypeOptionsResponse
    Date time property. It is not supported by CMEK compliant deployment.
    DisplayName string
    The display-name for the property, used for front-end.
    EnumTypeOptions GoogleCloudContentwarehouseV1EnumTypeOptionsResponse
    Enum/categorical property.
    FloatTypeOptions GoogleCloudContentwarehouseV1FloatTypeOptionsResponse
    Float property.
    IntegerTypeOptions GoogleCloudContentwarehouseV1IntegerTypeOptionsResponse
    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. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
    IsRepeatable bool
    Whether the property can have multiple values.
    IsRequired bool
    Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
    IsSearchable bool
    Indicates that the property should be included in a global search.
    MapTypeOptions GoogleCloudContentwarehouseV1MapTypeOptionsResponse
    Map property.
    Name string
    The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
    PropertyTypeOptions GoogleCloudContentwarehouseV1PropertyTypeOptionsResponse
    Nested structured data property.
    RetrievalImportance string
    The retrieval importance of the property during search.
    SchemaSources []GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSourceResponse
    The mapping information between this property to another schema source.
    TextTypeOptions GoogleCloudContentwarehouseV1TextTypeOptionsResponse
    Text/string property.
    TimestampTypeOptions GoogleCloudContentwarehouseV1TimestampTypeOptionsResponse
    Timestamp property. It is not supported by CMEK compliant deployment.
    dateTimeTypeOptions GoogleCloudContentwarehouseV1DateTimeTypeOptionsResponse
    Date time property. It is not supported by CMEK compliant deployment.
    displayName String
    The display-name for the property, used for front-end.
    enumTypeOptions GoogleCloudContentwarehouseV1EnumTypeOptionsResponse
    Enum/categorical property.
    floatTypeOptions GoogleCloudContentwarehouseV1FloatTypeOptionsResponse
    Float property.
    integerTypeOptions GoogleCloudContentwarehouseV1IntegerTypeOptionsResponse
    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. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
    isRepeatable Boolean
    Whether the property can have multiple values.
    isRequired Boolean
    Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
    isSearchable Boolean
    Indicates that the property should be included in a global search.
    mapTypeOptions GoogleCloudContentwarehouseV1MapTypeOptionsResponse
    Map property.
    name String
    The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
    propertyTypeOptions GoogleCloudContentwarehouseV1PropertyTypeOptionsResponse
    Nested structured data property.
    retrievalImportance String
    The retrieval importance of the property during search.
    schemaSources List<GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSourceResponse>
    The mapping information between this property to another schema source.
    textTypeOptions GoogleCloudContentwarehouseV1TextTypeOptionsResponse
    Text/string property.
    timestampTypeOptions GoogleCloudContentwarehouseV1TimestampTypeOptionsResponse
    Timestamp property. It is not supported by CMEK compliant deployment.
    dateTimeTypeOptions GoogleCloudContentwarehouseV1DateTimeTypeOptionsResponse
    Date time property. It is not supported by CMEK compliant deployment.
    displayName string
    The display-name for the property, used for front-end.
    enumTypeOptions GoogleCloudContentwarehouseV1EnumTypeOptionsResponse
    Enum/categorical property.
    floatTypeOptions GoogleCloudContentwarehouseV1FloatTypeOptionsResponse
    Float property.
    integerTypeOptions GoogleCloudContentwarehouseV1IntegerTypeOptionsResponse
    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. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
    isRepeatable boolean
    Whether the property can have multiple values.
    isRequired boolean
    Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
    isSearchable boolean
    Indicates that the property should be included in a global search.
    mapTypeOptions GoogleCloudContentwarehouseV1MapTypeOptionsResponse
    Map property.
    name string
    The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
    propertyTypeOptions GoogleCloudContentwarehouseV1PropertyTypeOptionsResponse
    Nested structured data property.
    retrievalImportance string
    The retrieval importance of the property during search.
    schemaSources GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSourceResponse[]
    The mapping information between this property to another schema source.
    textTypeOptions GoogleCloudContentwarehouseV1TextTypeOptionsResponse
    Text/string property.
    timestampTypeOptions GoogleCloudContentwarehouseV1TimestampTypeOptionsResponse
    Timestamp property. It is not supported by CMEK compliant deployment.
    date_time_type_options GoogleCloudContentwarehouseV1DateTimeTypeOptionsResponse
    Date time property. It is not supported by CMEK compliant deployment.
    display_name str
    The display-name for the property, used for front-end.
    enum_type_options GoogleCloudContentwarehouseV1EnumTypeOptionsResponse
    Enum/categorical property.
    float_type_options GoogleCloudContentwarehouseV1FloatTypeOptionsResponse
    Float property.
    integer_type_options GoogleCloudContentwarehouseV1IntegerTypeOptionsResponse
    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. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
    is_repeatable bool
    Whether the property can have multiple values.
    is_required bool
    Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
    is_searchable bool
    Indicates that the property should be included in a global search.
    map_type_options GoogleCloudContentwarehouseV1MapTypeOptionsResponse
    Map property.
    name str
    The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
    property_type_options GoogleCloudContentwarehouseV1PropertyTypeOptionsResponse
    Nested structured data property.
    retrieval_importance str
    The retrieval importance of the property during search.
    schema_sources Sequence[GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSourceResponse]
    The mapping information between this property to another schema source.
    text_type_options GoogleCloudContentwarehouseV1TextTypeOptionsResponse
    Text/string property.
    timestamp_type_options GoogleCloudContentwarehouseV1TimestampTypeOptionsResponse
    Timestamp property. It is not supported by CMEK compliant deployment.
    dateTimeTypeOptions Property Map
    Date time property. It is not supported by CMEK compliant deployment.
    displayName String
    The display-name for the property, used for front-end.
    enumTypeOptions Property Map
    Enum/categorical property.
    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. This out-of-the box placeholder setting can be used to tag derived properties. Its value and interpretation logic should be implemented by API user.
    isRepeatable Boolean
    Whether the property can have multiple values.
    isRequired Boolean
    Whether the property is mandatory. Default is 'false', i.e. populating property value can be skipped. If 'true' then user must populate the value for this property.
    isSearchable Boolean
    Indicates that the property should be included in a global search.
    mapTypeOptions Property Map
    Map property.
    name String
    The name of the metadata property. Must be unique within a document schema and is case insensitive. Names must be non-blank, start with a letter, and can contain alphanumeric characters and: /, :, -, _, and .
    propertyTypeOptions Property Map
    Nested structured data property.
    retrievalImportance String
    The retrieval importance of the property during search.
    schemaSources List<Property Map>
    The mapping information between this property to another schema source.
    textTypeOptions Property Map
    Text/string property.
    timestampTypeOptions Property Map
    Timestamp property. It is not supported by CMEK compliant deployment.

    GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportance, GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportanceArgs

    RetrievalImportanceUnspecified
    RETRIEVAL_IMPORTANCE_UNSPECIFIEDNo importance specified. Default medium importance.
    Highest
    HIGHESTHighest importance.
    Higher
    HIGHERHigher importance.
    High
    HIGHHigh importance.
    Medium
    MEDIUMMedium importance.
    Low
    LOWLow importance (negative).
    Lowest
    LOWESTLowest importance (negative).
    GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportanceRetrievalImportanceUnspecified
    RETRIEVAL_IMPORTANCE_UNSPECIFIEDNo importance specified. Default medium importance.
    GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportanceHighest
    HIGHESTHighest importance.
    GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportanceHigher
    HIGHERHigher importance.
    GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportanceHigh
    HIGHHigh importance.
    GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportanceMedium
    MEDIUMMedium importance.
    GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportanceLow
    LOWLow importance (negative).
    GoogleCloudContentwarehouseV1PropertyDefinitionRetrievalImportanceLowest
    LOWESTLowest importance (negative).
    RetrievalImportanceUnspecified
    RETRIEVAL_IMPORTANCE_UNSPECIFIEDNo importance specified. Default medium importance.
    Highest
    HIGHESTHighest importance.
    Higher
    HIGHERHigher importance.
    High
    HIGHHigh importance.
    Medium
    MEDIUMMedium importance.
    Low
    LOWLow importance (negative).
    Lowest
    LOWESTLowest importance (negative).
    RetrievalImportanceUnspecified
    RETRIEVAL_IMPORTANCE_UNSPECIFIEDNo importance specified. Default medium importance.
    Highest
    HIGHESTHighest importance.
    Higher
    HIGHERHigher importance.
    High
    HIGHHigh importance.
    Medium
    MEDIUMMedium importance.
    Low
    LOWLow importance (negative).
    Lowest
    LOWESTLowest importance (negative).
    RETRIEVAL_IMPORTANCE_UNSPECIFIED
    RETRIEVAL_IMPORTANCE_UNSPECIFIEDNo importance specified. Default medium importance.
    HIGHEST
    HIGHESTHighest importance.
    HIGHER
    HIGHERHigher importance.
    HIGH
    HIGHHigh importance.
    MEDIUM
    MEDIUMMedium importance.
    LOW
    LOWLow importance (negative).
    LOWEST
    LOWESTLowest importance (negative).
    "RETRIEVAL_IMPORTANCE_UNSPECIFIED"
    RETRIEVAL_IMPORTANCE_UNSPECIFIEDNo importance specified. Default medium importance.
    "HIGHEST"
    HIGHESTHighest importance.
    "HIGHER"
    HIGHERHigher importance.
    "HIGH"
    HIGHHigh importance.
    "MEDIUM"
    MEDIUMMedium importance.
    "LOW"
    LOWLow importance (negative).
    "LOWEST"
    LOWESTLowest importance (negative).

    GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource, GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSourceArgs

    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.

    GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSourceResponse, GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSourceResponseArgs

    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.

    GoogleCloudContentwarehouseV1PropertyTypeOptions, GoogleCloudContentwarehouseV1PropertyTypeOptionsArgs

    propertyDefinitions List<Property Map>
    List of property definitions.

    GoogleCloudContentwarehouseV1PropertyTypeOptionsResponse, GoogleCloudContentwarehouseV1PropertyTypeOptionsResponseArgs

    propertyDefinitions List<Property Map>
    List of property definitions.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native