Package com.google.cloud.discoveryengine.v1

Interface DocumentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Document, Document.Builder
    public interface DocumentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasStructData

        boolean hasStructData()
         The structured JSON data for the document. It should conform to the
 registered [Schema][google.cloud.discoveryengine.v1.Schema] or an
 `INVALID_ARGUMENT` error is thrown.
        .google.protobuf.Struct struct_data = 4;
        Returns:
        Whether the structData field is set.

      • getStructData

        com.google.protobuf.Struct getStructData()
         The structured JSON data for the document. It should conform to the
 registered [Schema][google.cloud.discoveryengine.v1.Schema] or an
 `INVALID_ARGUMENT` error is thrown.
        .google.protobuf.Struct struct_data = 4;
        Returns:
        The structData.

      • getStructDataOrBuilder

        com.google.protobuf.StructOrBuilder getStructDataOrBuilder()
         The structured JSON data for the document. It should conform to the
 registered [Schema][google.cloud.discoveryengine.v1.Schema] or an
 `INVALID_ARGUMENT` error is thrown.
        .google.protobuf.Struct struct_data = 4;

      • hasJsonData

        boolean hasJsonData()
         The JSON string representation of the document. It should conform to the
 registered [Schema][google.cloud.discoveryengine.v1.Schema] or an
 `INVALID_ARGUMENT` error is thrown.
        string json_data = 5;
        Returns:
        Whether the jsonData field is set.

      • getJsonData

        String getJsonData()
         The JSON string representation of the document. It should conform to the
 registered [Schema][google.cloud.discoveryengine.v1.Schema] or an
 `INVALID_ARGUMENT` error is thrown.
        string json_data = 5;
        Returns:
        The jsonData.

      • getJsonDataBytes

        com.google.protobuf.ByteString getJsonDataBytes()
         The JSON string representation of the document. It should conform to the
 registered [Schema][google.cloud.discoveryengine.v1.Schema] or an
 `INVALID_ARGUMENT` error is thrown.
        string json_data = 5;
        Returns:
        The bytes for jsonData.

      • getName

        String getName()
         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.
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         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.
        string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The bytes for name.

      • getId

        String getId()
         Immutable. The identifier of the document.

 Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters.
        string id = 2 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The id.

      • getIdBytes

        com.google.protobuf.ByteString getIdBytes()
         Immutable. The identifier of the document.

 Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters.
        string id = 2 [(.google.api.field_behavior) = IMMUTABLE];
        Returns:
        The bytes for id.

      • getSchemaId

        String getSchemaId()
         The identifier of the schema located in the same data store.
        string schema_id = 3;
        Returns:
        The schemaId.

      • getSchemaIdBytes

        com.google.protobuf.ByteString getSchemaIdBytes()
         The identifier of the schema located in the same data store.
        string schema_id = 3;
        Returns:
        The bytes for schemaId.

      • hasContent

        boolean hasContent()
         The unstructured data linked to this document. Content must be set if this
 document is under a
 `CONTENT_REQUIRED` data store.
        .google.cloud.discoveryengine.v1.Document.Content content = 10;
        Returns:
        Whether the content field is set.

      • getContent

        Document.Content getContent()
         The unstructured data linked to this document. Content must be set if this
 document is under a
 `CONTENT_REQUIRED` data store.
        .google.cloud.discoveryengine.v1.Document.Content content = 10;
        Returns:
        The content.

      • getContentOrBuilder

        Document.ContentOrBuilder getContentOrBuilder()
         The unstructured data linked to this document. Content must be set if this
 document is under a
 `CONTENT_REQUIRED` data store.
        .google.cloud.discoveryengine.v1.Document.Content content = 10;

      • getParentDocumentId

        String getParentDocumentId()
         The identifier of the parent document. Currently supports at most two level
 document hierarchy.

 Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters.
        string parent_document_id = 7;
        Returns:
        The parentDocumentId.

      • getParentDocumentIdBytes

        com.google.protobuf.ByteString getParentDocumentIdBytes()
         The identifier of the parent document. Currently supports at most two level
 document hierarchy.

 Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
 standard with a length limit of 63 characters.
        string parent_document_id = 7;
        Returns:
        The bytes for parentDocumentId.

      • hasDerivedStructData

        boolean hasDerivedStructData()
         Output only. This field is OUTPUT_ONLY.
 It contains derived data that are not in the original input document.
        .google.protobuf.Struct derived_struct_data = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        Whether the derivedStructData field is set.

      • getDerivedStructData

        com.google.protobuf.Struct getDerivedStructData()
         Output only. This field is OUTPUT_ONLY.
 It contains derived data that are not in the original input document.
        .google.protobuf.Struct derived_struct_data = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The derivedStructData.

      • getDerivedStructDataOrBuilder

        com.google.protobuf.StructOrBuilder getDerivedStructDataOrBuilder()
         Output only. This field is OUTPUT_ONLY.
 It contains derived data that are not in the original input document.
        .google.protobuf.Struct derived_struct_data = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];