Package com.google.cloud.discoveryengine.v1

Interface Document.IndexStatusOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Document.IndexStatus, Document.IndexStatus.Builder
Enclosing class:
Document
public static interface Document.IndexStatusOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Status
    getErrorSamples(int index)
    A sample of errors encountered while indexing the document.
    int
    getErrorSamplesCount()
    A sample of errors encountered while indexing the document.
    List<Status>
    getErrorSamplesList()
    A sample of errors encountered while indexing the document.
    StatusOrBuilder
    getErrorSamplesOrBuilder(int index)
    A sample of errors encountered while indexing the document.
    List<? extends StatusOrBuilder>
    getErrorSamplesOrBuilderList()
    A sample of errors encountered while indexing the document.
    com.google.protobuf.Timestamp
    getIndexTime()
    The time when the document was indexed.
    com.google.protobuf.TimestampOrBuilder
    getIndexTimeOrBuilder()
    The time when the document was indexed.
    String
    getPendingMessage()
    Immutable.
    com.google.protobuf.ByteString
    getPendingMessageBytes()
    Immutable.
    boolean
    hasIndexTime()
    The time when the document was indexed.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasIndexTime

      boolean hasIndexTime()
       The time when the document was indexed.
 If this field is populated, it means the document has been indexed.
      .google.protobuf.Timestamp index_time = 1;
      Returns:
      Whether the indexTime field is set.

    • getIndexTime

      com.google.protobuf.Timestamp getIndexTime()
       The time when the document was indexed.
 If this field is populated, it means the document has been indexed.
      .google.protobuf.Timestamp index_time = 1;
      Returns:
      The indexTime.

    • getIndexTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getIndexTimeOrBuilder()
       The time when the document was indexed.
 If this field is populated, it means the document has been indexed.
      .google.protobuf.Timestamp index_time = 1;

    • getErrorSamplesList

      List<Status> getErrorSamplesList()
       A sample of errors encountered while indexing the document.
 If this field is populated, the document is not indexed due to errors.
      repeated .google.rpc.Status error_samples = 2;

    • getErrorSamples

      Status getErrorSamples(int index)
       A sample of errors encountered while indexing the document.
 If this field is populated, the document is not indexed due to errors.
      repeated .google.rpc.Status error_samples = 2;

    • getErrorSamplesCount

      int getErrorSamplesCount()
       A sample of errors encountered while indexing the document.
 If this field is populated, the document is not indexed due to errors.
      repeated .google.rpc.Status error_samples = 2;

    • getErrorSamplesOrBuilderList

      List<? extends StatusOrBuilder> getErrorSamplesOrBuilderList()
       A sample of errors encountered while indexing the document.
 If this field is populated, the document is not indexed due to errors.
      repeated .google.rpc.Status error_samples = 2;

    • getErrorSamplesOrBuilder

      StatusOrBuilder getErrorSamplesOrBuilder(int index)
       A sample of errors encountered while indexing the document.
 If this field is populated, the document is not indexed due to errors.
      repeated .google.rpc.Status error_samples = 2;

    • getPendingMessage

      String getPendingMessage()
       Immutable. The message indicates the document index is in progress.
 If this field is populated, the document index is pending.
      string pending_message = 3 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The pendingMessage.

    • getPendingMessageBytes

      com.google.protobuf.ByteString getPendingMessageBytes()
       Immutable. The message indicates the document index is in progress.
 If this field is populated, the document index is pending.
      string pending_message = 3 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The bytes for pendingMessage.