Class Document.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Document.Builder>
com.google.cloud.discoveryengine.v1beta.Document.Builder
All Implemented Interfaces:
DocumentOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Document

public static final class Document.Builder extends com.google.protobuf.GeneratedMessage.Builder<Document.Builder> implements DocumentOrBuilder
 Document captures all raw metadata information of items to be recommended or
 searched.
 
Protobuf type google.cloud.discoveryengine.v1beta.Document
  • 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.Builder<Document.Builder>
    • clear

      public Document.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Document.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Document.Builder>
    • getDefaultInstanceForType

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

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

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

      public Document.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Builder>
    • mergeFrom

      public Document.Builder mergeFrom(Document other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Document.Builder>
    • mergeFrom

      public Document.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Builder>
      Throws:
      IOException
    • getDataCase

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

      public Document.Builder clearData()
    • 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.
    • setStructData

      public Document.Builder setStructData(com.google.protobuf.Struct value)
       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;
    • setStructData

      public Document.Builder setStructData(com.google.protobuf.Struct.Builder builderForValue)
       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;
    • mergeStructData

      public Document.Builder mergeStructData(com.google.protobuf.Struct value)
       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;
    • clearStructData

      public Document.Builder clearStructData()
       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;
    • getStructDataBuilder

      public com.google.protobuf.Struct.Builder getStructDataBuilder()
       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;
    • 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.
    • setJsonData

      public Document.Builder setJsonData(String value)
       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;
      Parameters:
      value - The jsonData to set.
      Returns:
      This builder for chaining.
    • clearJsonData

      public Document.Builder clearJsonData()
       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;
      Returns:
      This builder for chaining.
    • setJsonDataBytes

      public Document.Builder setJsonDataBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for jsonData to set.
      Returns:
      This builder for chaining.
    • 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.
    • setName

      public Document.Builder setName(String value)
       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];
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.
    • clearName

      public Document.Builder clearName()
       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:
      This builder for chaining.
    • setNameBytes

      public Document.Builder setNameBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.
    • 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.
    • setId

      public Document.Builder setId(String value)
       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];
      Parameters:
      value - The id to set.
      Returns:
      This builder for chaining.
    • clearId

      public Document.Builder clearId()
       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:
      This builder for chaining.
    • setIdBytes

      public Document.Builder setIdBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for id to set.
      Returns:
      This builder for chaining.
    • 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.
    • setSchemaId

      public Document.Builder setSchemaId(String value)
       The identifier of the schema located in the same data store.
       
      string schema_id = 3;
      Parameters:
      value - The schemaId to set.
      Returns:
      This builder for chaining.
    • clearSchemaId

      public Document.Builder clearSchemaId()
       The identifier of the schema located in the same data store.
       
      string schema_id = 3;
      Returns:
      This builder for chaining.
    • setSchemaIdBytes

      public Document.Builder setSchemaIdBytes(com.google.protobuf.ByteString value)
       The identifier of the schema located in the same data store.
       
      string schema_id = 3;
      Parameters:
      value - The bytes for schemaId to set.
      Returns:
      This builder for chaining.
    • 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.
    • setContent

      public Document.Builder setContent(Document.Content value)
       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;
    • setContent

      public Document.Builder setContent(Document.Content.Builder builderForValue)
       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;
    • mergeContent

      public Document.Builder mergeContent(Document.Content value)
       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;
    • clearContent

      public Document.Builder clearContent()
       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;
    • getContentBuilder

      public Document.Content.Builder getContentBuilder()
       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;
    • 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.
    • setParentDocumentId

      public Document.Builder setParentDocumentId(String value)
       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;
      Parameters:
      value - The parentDocumentId to set.
      Returns:
      This builder for chaining.
    • clearParentDocumentId

      public Document.Builder clearParentDocumentId()
       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:
      This builder for chaining.
    • setParentDocumentIdBytes

      public Document.Builder setParentDocumentIdBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for parentDocumentId to set.
      Returns:
      This builder for chaining.
    • 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.
    • setDerivedStructData

      public Document.Builder setDerivedStructData(com.google.protobuf.Struct value)
       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];
    • setDerivedStructData

      public Document.Builder setDerivedStructData(com.google.protobuf.Struct.Builder builderForValue)
       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];
    • mergeDerivedStructData

      public Document.Builder mergeDerivedStructData(com.google.protobuf.Struct value)
       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];
    • clearDerivedStructData

      public Document.Builder clearDerivedStructData()
       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];
    • getDerivedStructDataBuilder

      public com.google.protobuf.Struct.Builder getDerivedStructDataBuilder()
       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];
    • 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.
    • setIndexTime

      public Document.Builder setIndexTime(com.google.protobuf.Timestamp value)
       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];
    • setIndexTime

      public Document.Builder setIndexTime(com.google.protobuf.Timestamp.Builder builderForValue)
       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];
    • mergeIndexTime

      public Document.Builder mergeIndexTime(com.google.protobuf.Timestamp value)
       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];
    • clearIndexTime

      public Document.Builder clearIndexTime()
       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];
    • getIndexTimeBuilder

      public com.google.protobuf.Timestamp.Builder getIndexTimeBuilder()
       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];
    • 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.
    • setIndexStatus

      public Document.Builder setIndexStatus(Document.IndexStatus value)
       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];
    • setIndexStatus

      public Document.Builder setIndexStatus(Document.IndexStatus.Builder builderForValue)
       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];
    • mergeIndexStatus

      public Document.Builder mergeIndexStatus(Document.IndexStatus value)
       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];
    • clearIndexStatus

      public Document.Builder clearIndexStatus()
       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];
    • getIndexStatusBuilder

      public Document.IndexStatus.Builder getIndexStatusBuilder()
       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];
    • 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