GoogleCloudContentwarehouseV1DocumentReference

AI Overview😉

  • The potential purpose of this module is to provide a structured way to reference and store metadata about documents within a content warehouse. This includes information such as the document's name, display name, creation and update times, and a snippet of its content.
  • This module could impact search results by allowing the search algorithm to better understand the relationships between documents and their metadata. For example, it could use the document's display name and snippet to improve the relevance of search results, or use the creation and update times to prioritize more recent or updated documents.
  • A website may change things to be more favorable for this function by ensuring that their document metadata is accurately and consistently represented, and that their content is well-structured and easily parsable. This could involve using standardized naming conventions, providing clear and descriptive display names, and optimizing their content for search engines.

Interesting Module? Vote 👇

Voting helps other researchers find interesting modules.

Current Votes: 0

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

References to the documents.

Attributes

  • createTime (type: DateTime.t, default: nil) - Output only. The time when the document is created.
  • deleteTime (type: DateTime.t, default: nil) - Output only. The time when the document is deleted.
  • displayName (type: String.t, default: nil) - display_name of the referenced document; this name does not need to be consistent to the display_name in the Document proto, depending on the ACL constraint.
  • documentIsFolder (type: boolean(), default: nil) - The document type of the document being referenced.
  • documentIsLegalHoldFolder (type: boolean(), default: nil) - Document is a folder with legal hold.
  • documentIsRetentionFolder (type: boolean(), default: nil) - Document is a folder with retention policy.
  • documentName (type: String.t, default: nil) - Required. Name of the referenced document.
  • snippet (type: String.t, default: nil) - Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.
  • updateTime (type: DateTime.t, default: nil) - Output only. The time when the document is last updated.

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.GoogleCloudContentwarehouseV1DocumentReference{
    createTime: DateTime.t() | nil,
    deleteTime: DateTime.t() | nil,
    displayName: String.t() | nil,
    documentIsFolder: boolean() | nil,
    documentIsLegalHoldFolder: boolean() | nil,
    documentIsRetentionFolder: boolean() | nil,
    documentName: String.t() | nil,
    snippet: String.t() | nil,
    updateTime: DateTime.t() | nil
  }

Functions

Link to this function

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.