Package com.google.cloud.discoveryengine.v1beta

Class Document

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.Document
All Implemented Interfaces:
DocumentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Document extends com.google.protobuf.GeneratedMessage implements DocumentOrBuilder
 Document captures all raw metadata information of items to be recommended or
 searched.
Protobuf type google.cloud.discoveryengine.v1beta.Document
See Also:

  • Field Details

    • STRUCT_DATA_FIELD_NUMBER

      public static final int STRUCT_DATA_FIELD_NUMBER
      See Also:

    • JSON_DATA_FIELD_NUMBER

      public static final int JSON_DATA_FIELD_NUMBER
      See Also:

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • SCHEMA_ID_FIELD_NUMBER

      public static final int SCHEMA_ID_FIELD_NUMBER
      See Also:

    • CONTENT_FIELD_NUMBER

      public static final int CONTENT_FIELD_NUMBER
      See Also:

    • PARENT_DOCUMENT_ID_FIELD_NUMBER

      public static final int PARENT_DOCUMENT_ID_FIELD_NUMBER
      See Also:

    • DERIVED_STRUCT_DATA_FIELD_NUMBER

      public static final int DERIVED_STRUCT_DATA_FIELD_NUMBER
      See Also:

    • INDEX_TIME_FIELD_NUMBER

      public static final int INDEX_TIME_FIELD_NUMBER
      See Also:

    • INDEX_STATUS_FIELD_NUMBER

      public static final int INDEX_STATUS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getDataCase

      public Document.DataCase getDataCase()
      Specified by:
      getDataCase in interface DocumentOrBuilder

    • hasStructData

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

    • getStructData

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

    • getStructDataOrBuilder

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

    • hasJsonData

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

    • getJsonData

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

    • getJsonDataBytes

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

    • getName

      public 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];
      Specified by:
      getName in interface DocumentOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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];
      Specified by:
      getNameBytes in interface DocumentOrBuilder
      Returns:
      The bytes for name.

    • getId

      public 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];
      Specified by:
      getId in interface DocumentOrBuilder
      Returns:
      The id.

    • getIdBytes

      public 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];
      Specified by:
      getIdBytes in interface DocumentOrBuilder
      Returns:
      The bytes for id.

    • getSchemaId

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

    • getSchemaIdBytes

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

    • hasContent

      public 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.v1beta.Document.Content content = 10;
      Specified by:
      hasContent in interface DocumentOrBuilder
      Returns:
      Whether the content field is set.

    • getContent

      public 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.v1beta.Document.Content content = 10;
      Specified by:
      getContent in interface DocumentOrBuilder
      Returns:
      The content.

    • getContentOrBuilder

      public 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.v1beta.Document.Content content = 10;
      Specified by:
      getContentOrBuilder in interface DocumentOrBuilder

    • getParentDocumentId

      public 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;
      Specified by:
      getParentDocumentId in interface DocumentOrBuilder
      Returns:
      The parentDocumentId.

    • getParentDocumentIdBytes

      public 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;
      Specified by:
      getParentDocumentIdBytes in interface DocumentOrBuilder
      Returns:
      The bytes for parentDocumentId.

    • hasDerivedStructData

      public 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];
      Specified by:
      hasDerivedStructData in interface DocumentOrBuilder
      Returns:
      Whether the derivedStructData field is set.

    • getDerivedStructData

      public 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];
      Specified by:
      getDerivedStructData in interface DocumentOrBuilder
      Returns:
      The derivedStructData.

    • getDerivedStructDataOrBuilder

      public 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];
      Specified by:
      getDerivedStructDataOrBuilder in interface DocumentOrBuilder

    • hasIndexTime

      public boolean hasIndexTime()
       Output only. The last time the document was indexed. If this field is set,
 the document could be returned in search results.

 This field is OUTPUT_ONLY. If this field is not populated, it means the
 document has never been indexed.
      .google.protobuf.Timestamp index_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasIndexTime in interface DocumentOrBuilder
      Returns:
      Whether the indexTime field is set.

    • getIndexTime

      public com.google.protobuf.Timestamp getIndexTime()
       Output only. The last time the document was indexed. If this field is set,
 the document could be returned in search results.

 This field is OUTPUT_ONLY. If this field is not populated, it means the
 document has never been indexed.
      .google.protobuf.Timestamp index_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getIndexTime in interface DocumentOrBuilder
      Returns:
      The indexTime.

    • getIndexTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getIndexTimeOrBuilder()
       Output only. The last time the document was indexed. If this field is set,
 the document could be returned in search results.

 This field is OUTPUT_ONLY. If this field is not populated, it means the
 document has never been indexed.
      .google.protobuf.Timestamp index_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getIndexTimeOrBuilder in interface DocumentOrBuilder

    • hasIndexStatus

      public boolean hasIndexStatus()
       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, index_status is unset.
      .google.cloud.discoveryengine.v1beta.Document.IndexStatus index_status = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      hasIndexStatus in interface DocumentOrBuilder
      Returns:
      Whether the indexStatus field is set.

    • getIndexStatus

      public Document.IndexStatus getIndexStatus()
       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, index_status is unset.
      .google.cloud.discoveryengine.v1beta.Document.IndexStatus index_status = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getIndexStatus in interface DocumentOrBuilder
      Returns:
      The indexStatus.

    • getIndexStatusOrBuilder

      public Document.IndexStatusOrBuilder getIndexStatusOrBuilder()
       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, index_status is unset.
      .google.cloud.discoveryengine.v1beta.Document.IndexStatus index_status = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getIndexStatusOrBuilder in interface DocumentOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Document parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Document parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Document parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Document parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Document.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Document.Builder newBuilder()

    • newBuilder

      public static Document.Builder newBuilder(Document prototype)

    • toBuilder

      public Document.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Document.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Document getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Document> parser()

    • getParserForType

      public com.google.protobuf.Parser<Document> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Document getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder