google-native.contentwarehouse/v1.getDocumentSchema

Explore with Pulumi AI

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

Using getDocumentSchema

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDocumentSchema(args: GetDocumentSchemaArgs, opts?: InvokeOptions): Promise<GetDocumentSchemaResult>
function getDocumentSchemaOutput(args: GetDocumentSchemaOutputArgs, opts?: InvokeOptions): Output<GetDocumentSchemaResult>

def get_document_schema(document_schema_id: Optional[str] = None,
                        location: Optional[str] = None,
                        project: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetDocumentSchemaResult
def get_document_schema_output(document_schema_id: Optional[pulumi.Input[str]] = None,
                        location: Optional[pulumi.Input[str]] = None,
                        project: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetDocumentSchemaResult]

func LookupDocumentSchema(ctx *Context, args *LookupDocumentSchemaArgs, opts ...InvokeOption) (*LookupDocumentSchemaResult, error)
func LookupDocumentSchemaOutput(ctx *Context, args *LookupDocumentSchemaOutputArgs, opts ...InvokeOption) LookupDocumentSchemaResultOutput

> Note: This function is named LookupDocumentSchema in the Go SDK.

public static class GetDocumentSchema 
{
    public static Task<GetDocumentSchemaResult> InvokeAsync(GetDocumentSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetDocumentSchemaResult> Invoke(GetDocumentSchemaInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDocumentSchemaResult> getDocumentSchema(GetDocumentSchemaArgs args, InvokeOptions options)
public static Output<GetDocumentSchemaResult> getDocumentSchema(GetDocumentSchemaArgs args, InvokeOptions options)

fn::invoke:
  function: google-native:contentwarehouse/v1:getDocumentSchema
  arguments:
    # arguments dictionary

The following arguments are supported:

DocumentSchemaId string
Location string
Project string

DocumentSchemaId string
Location string
Project string

documentSchemaId String
location String
project String

documentSchemaId string
location string
project string

document_schema_id str
location str
project str

documentSchemaId String
location String
project String

getDocumentSchema Result

The following output properties are available:

CreateTime string: The time when the document schema is created.
Description string: Schema description.
DisplayName string: Name of the schema given by the user. Must be unique per project.
DocumentIsFolder bool: Document Type, true refers the document is a folder, otherwise it is a typical document.
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.
PropertyDefinitions List<Pulumi.GoogleNative.Contentwarehouse.V1.Outputs.GoogleCloudContentwarehouseV1PropertyDefinitionResponse>: Document details.
UpdateTime string: The time when the document schema is last updated.

CreateTime string: The time when the document schema is created.
Description string: Schema description.
DisplayName string: Name of the schema given by the user. Must be unique per project.
DocumentIsFolder bool: Document Type, true refers the document is a folder, otherwise it is a typical document.
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.
PropertyDefinitions []GoogleCloudContentwarehouseV1PropertyDefinitionResponse: Document details.
UpdateTime string: The time when the document schema is last updated.

createTime String: The time when the document schema is created.
description String: Schema description.
displayName String: Name of the schema given by the user. Must be unique per project.
documentIsFolder Boolean: Document Type, true refers the document is a folder, otherwise it is a typical document.
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.
propertyDefinitions List<GoogleCloudContentwarehouseV1PropertyDefinitionResponse>: Document details.
updateTime String: The time when the document schema is last updated.

createTime string: The time when the document schema is created.
description string: Schema description.
displayName string: Name of the schema given by the user. Must be unique per project.
documentIsFolder boolean: Document Type, true refers the document is a folder, otherwise it is a typical document.
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.
propertyDefinitions GoogleCloudContentwarehouseV1PropertyDefinitionResponse[]: Document details.
updateTime string: The time when the document schema is last updated.

create_time str: The time when the document schema is created.
description str: Schema description.
display_name str: Name of the schema given by the user. Must be unique per project.
document_is_folder bool: Document Type, true refers the document is a folder, otherwise it is a typical document.
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.
property_definitions Sequence[GoogleCloudContentwarehouseV1PropertyDefinitionResponse]: Document details.
update_time str: The time when the document schema is last updated.

createTime String: The time when the document schema is created.
description String: Schema description.
displayName String: Name of the schema given by the user. Must be unique per project.
documentIsFolder Boolean: Document Type, true refers the document is a folder, otherwise it is a typical document.
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.
propertyDefinitions List<Property Map>: Document details.
updateTime String: The time when the document schema is last updated.

Supporting Types

GoogleCloudContentwarehouseV1EnumTypeOptionsResponse

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.

GoogleCloudContentwarehouseV1PropertyDefinitionResponse

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.