GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1PropertyDefinition
Table of Contents ▼
Jump to a specific part of the page:
Description
Defines the metadata for a schema property.
Attributes List
This module has the following attributes (case-insensitive ascending order):
Attributes
-
dateTimeTypeOptions
(type:GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1DateTimeTypeOptions
, default:nil
)
- Date time property. It is not supported by CMEK compliant deployment. -
displayName
(type:String.t
, default:nil
)
- The display-name for the property, used for front-end. -
enumTypeOptions
(type:GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1EnumTypeOptions
, default:nil
)
- Enum/categorical property. -
floatTypeOptions
(type:GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1FloatTypeOptions
, default:nil
)
- Float property. -
integerTypeOptions
(type:GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1IntegerTypeOptions
, default:nil
)
- Integer property. -
isFilterable
(type:boolean()
, default:nil
)
- Whether the property can be filtered. If this is a sub-property, all the parent properties must be marked filterable. -
isMetadata
(type:boolean()
, default:nil
)
- 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
(type:boolean()
, default:nil
)
- Whether the property can have multiple values. -
isRequired
(type:boolean()
, default:nil
)
- 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
(type:boolean()
, default:nil
)
- Indicates that the property should be included in a global search. -
mapTypeOptions
(type:GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1MapTypeOptions
, default:nil
)
- Map property. -
name
(type:String.t
, default:nil
)
- Required. 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
(type:GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1PropertyTypeOptions
, default:nil
)
- Nested structured data property. -
retrievalImportance
(type:String.t
, default:nil
)
- The retrieval importance of the property during search. -
schemaSources
(type:list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource)
, default:nil
)
- The mapping information between this property to another schema source. -
textTypeOptions
(type:GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1TextTypeOptions
, default:nil
)
- Text/string property. -
timestampTypeOptions
(type:GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1TimestampTypeOptions
, default:nil
)
- Timestamp property. It is not supported by CMEK compliant deployment.
Type
@type t() :: %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1PropertyDefinition{
dateTimeTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1DateTimeTypeOptions.t() | nil,
displayName: String.t() | nil,
enumTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1EnumTypeOptions.t() | nil,
floatTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1FloatTypeOptions.t() | nil,
integerTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1IntegerTypeOptions.t() | nil,
isFilterable: boolean() | nil,
isMetadata: boolean() | nil,
isRepeatable: boolean() | nil,
isRequired: boolean() | nil,
isSearchable: boolean() | nil,
mapTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1MapTypeOptions.t() | nil,
name: String.t() | nil,
propertyTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1PropertyTypeOptions.t() | nil,
retrievalImportance: String.t() | nil,
schemaSources: [ GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource.t() ] | nil,
textTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1TextTypeOptions.t() | nil,
timestampTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1TimestampTypeOptions.t() | nil
}
dateTimeTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1DateTimeTypeOptions.t() | nil,
displayName: String.t() | nil,
enumTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1EnumTypeOptions.t() | nil,
floatTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1FloatTypeOptions.t() | nil,
integerTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1IntegerTypeOptions.t() | nil,
isFilterable: boolean() | nil,
isMetadata: boolean() | nil,
isRepeatable: boolean() | nil,
isRequired: boolean() | nil,
isSearchable: boolean() | nil,
mapTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1MapTypeOptions.t() | nil,
name: String.t() | nil,
propertyTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1PropertyTypeOptions.t() | nil,
retrievalImportance: String.t() | nil,
schemaSources: [ GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource.t() ] | nil,
textTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1TextTypeOptions.t() | nil,
timestampTypeOptions: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1TimestampTypeOptions.t() | nil
}
Function
@spec decode(struct(), keyword()) :: struct()Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1PropertyDefinition