Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::Document (v0.28.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Document.

Document captures all raw metadata information of items to be recommended or searched.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#acl_info

def acl_info() -> ::Google::Cloud::DiscoveryEngine::V1beta::Document::AclInfo
Returns

#acl_info=

def acl_info=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Document::AclInfo
Parameter
Returns

#content

def content() -> ::Google::Cloud::DiscoveryEngine::V1beta::Document::Content
Returns

#content=

def content=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Document::Content
Parameter
Returns

#derived_struct_data

def derived_struct_data() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

#id

def id() -> ::String
Returns
  • (::String) — Immutable. The identifier of the document.

    Id should conform to RFC-1034 standard with a length limit of 128 characters.

#id=

def id=(value) -> ::String
Parameter
  • value (::String) — Immutable. The identifier of the document.

    Id should conform to RFC-1034 standard with a length limit of 128 characters.

Returns
  • (::String) — Immutable. The identifier of the document.

    Id should conform to RFC-1034 standard with a length limit of 128 characters.

#index_status

def index_status() -> ::Google::Cloud::DiscoveryEngine::V1beta::Document::IndexStatus
Returns
  • (::Google::Cloud::DiscoveryEngine::V1beta::Document::IndexStatus) —

    Output only. The index status of the document.

    • If document is indexed successfully, the index_time field is populated.
    • Otherwise, if document is not indexed due to errors, the error_samples field is populated.
    • Otherwise, if document's index is in progress, the pending_message field is populated.

#index_time

def index_time() -> ::Google::Protobuf::Timestamp
Returns
  • (::Google::Protobuf::Timestamp) — Output only. The time when the document was last indexed.

    If this field is populated, it means the document has been indexed. While documents typically become searchable within seconds of indexing, it can sometimes take up to a few hours.

    If this field is not populated, it means the document has never been indexed.

#json_data

def json_data() -> ::String
Returns
  • (::String) — The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.

    Note: The following fields are mutually exclusive: json_data, struct_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

#json_data=

def json_data=(value) -> ::String
Parameter
  • value (::String) — The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.

    Note: The following fields are mutually exclusive: json_data, struct_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.

    Note: The following fields are mutually exclusive: json_data, struct_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

#name

def name() -> ::String
Returns
  • (::String) — Immutable. The full resource name of the document. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}.

    This field must be a UTF-8 encoded string with a length limit of 1024 characters.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Immutable. The full resource name of the document. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}.

    This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Returns
  • (::String) — Immutable. The full resource name of the document. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}.

    This field must be a UTF-8 encoded string with a length limit of 1024 characters.

#parent_document_id

def parent_document_id() -> ::String
Returns
  • (::String) — The identifier of the parent document. Currently supports at most two level document hierarchy.

    Id should conform to RFC-1034 standard with a length limit of 63 characters.

#parent_document_id=

def parent_document_id=(value) -> ::String
Parameter
  • value (::String) — The identifier of the parent document. Currently supports at most two level document hierarchy.

    Id should conform to RFC-1034 standard with a length limit of 63 characters.

Returns
  • (::String) — The identifier of the parent document. Currently supports at most two level document hierarchy.

    Id should conform to RFC-1034 standard with a length limit of 63 characters.

#schema_id

def schema_id() -> ::String
Returns
  • (::String) — The identifier of the schema located in the same data store.

#schema_id=

def schema_id=(value) -> ::String
Parameter
  • value (::String) — The identifier of the schema located in the same data store.
Returns
  • (::String) — The identifier of the schema located in the same data store.

#struct_data

def struct_data() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.

    Note: The following fields are mutually exclusive: struct_data, json_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

#struct_data=

def struct_data=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.

    Note: The following fields are mutually exclusive: struct_data, json_data. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Struct) — The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.

    Note: The following fields are mutually exclusive: struct_data, json_data. If a field in that set is populated, all other fields in the set will automatically be cleared.