GoogleCloudContentwarehouseV1PropertyDefinition

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):

View Attributes

Attributes

  1. dateTimeTypeOptions (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1DateTimeTypeOptions, default: nil)
    - Date time property. It is not supported by CMEK compliant deployment.
  2. displayName (type: String.t, default: nil)
    - The display-name for the property, used for front-end.
  3. enumTypeOptions (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1EnumTypeOptions, default: nil)
    - Enum/categorical property.
  4. floatTypeOptions (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1FloatTypeOptions, default: nil)
    - Float property.
  5. integerTypeOptions (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1IntegerTypeOptions, default: nil)
    - Integer property.
  6. 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.
  7. 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.
  8. isRepeatable (type: boolean(), default: nil)
    - Whether the property can have multiple values.
  9. 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.
  10. isSearchable (type: boolean(), default: nil)
    - Indicates that the property should be included in a global search.
  11. mapTypeOptions (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1MapTypeOptions, default: nil)
    - Map property.
  12. 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 .
  13. propertyTypeOptions (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1PropertyTypeOptions, default: nil)
    - Nested structured data property.
  14. retrievalImportance (type: String.t, default: nil)
    - The retrieval importance of the property during search.
  15. schemaSources (type: list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1PropertyDefinitionSchemaSource), default: nil)
    - The mapping information between this property to another schema source.
  16. textTypeOptions (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1TextTypeOptions, default: nil)
    - Text/string property.
  17. timestampTypeOptions (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1TimestampTypeOptions, default: nil)
    - Timestamp property. It is not supported by CMEK compliant deployment.

Type

Function

@spec decode(struct(), keyword()) :: struct()

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1PropertyDefinition