GoogleCloudContentwarehouseV1PropertyDefinition

AI Overview😉

The potential purpose of this module is to define the metadata for a schema property, which means it helps to organize and structure data within a search engine. It seems to be related to how Google Cloud Content Warehouse handles metadata and properties within a document schema.
This module could impact search results by influencing how properties are filtered, searched, and retrieved. It could also affect the importance of certain properties during search, as indicated by the "retrievalImportance" attribute. This might lead to more relevant or accurate search results, as the search engine can better understand the structure and relationships within the data.
A website may change things to be more favorable for this function by ensuring that their metadata and properties are accurately defined and structured within their document schema. This could involve using clear and descriptive names for properties, specifying the correct data types, and indicating which properties are filterable, searchable, or required. By doing so, the website can improve the search engine's ability to understand and retrieve their data, leading to better search results and a more efficient search experience.

Interesting Module? Vote 👇

Voting helps other researchers find interesting modules.

Current Votes: 0

GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1PropertyDefinition (google_api_content_warehouse v0.4.0)

Defines the metadata for a schema property.

Attributes

dateTimeTypeOptions (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1DateTimeTypeOptions.t, 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.t, default: nil) - Enum/categorical property.
floatTypeOptions (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1FloatTypeOptions.t, default: nil) - Float property.
integerTypeOptions (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1IntegerTypeOptions.t, 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.t, 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.t, 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.t), default: nil) - The mapping information between this property to another schema source.
textTypeOptions (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1TextTypeOptions.t, default: nil) - Text/string property.
timestampTypeOptions (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1TimestampTypeOptions.t, default: nil) - Timestamp property. It is not supported by CMEK compliant deployment.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

Link to this type

t()

@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
  }

Functions

Link to this function

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.