Send feedback
Class Document.IndexStatus (0.74.0)
Version latestkeyboard_arrow_down
public static final class Document . IndexStatus extends GeneratedMessageV3 implements Document . IndexStatusOrBuilder
Index status of the document.
Protobuf type google.cloud.discoveryengine.v1.Document.IndexStatus
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ERROR_SAMPLES_FIELD_NUMBER
public static final int ERROR_SAMPLES_FIELD_NUMBER
Field Value
Type Description
int
INDEX_TIME_FIELD_NUMBER
public static final int INDEX_TIME_FIELD_NUMBER
Field Value
Type Description
int
PENDING_MESSAGE_FIELD_NUMBER
public static final int PENDING_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Document . IndexStatus getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Document . IndexStatus . Builder newBuilder ()
newBuilder(Document.IndexStatus prototype)
public static Document . IndexStatus . Builder newBuilder ( Document . IndexStatus prototype )
public static Document . IndexStatus parseDelimitedFrom ( InputStream input )
public static Document . IndexStatus parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Document . IndexStatus parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document . IndexStatus parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Document . IndexStatus parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document . IndexStatus parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Document . IndexStatus parseFrom ( CodedInputStream input )
public static Document . IndexStatus parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Document . IndexStatus parseFrom ( InputStream input )
public static Document . IndexStatus parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Document . IndexStatus parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document . IndexStatus parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Document . IndexStatus > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public Document . IndexStatus getDefaultInstanceForType ()
getErrorSamples(int index)
public 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;
Parameter
Name Description
indexint
Returns
Type Description
com.google.rpc.Status
getErrorSamplesCount()
public 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;
Returns
Type Description
int
getErrorSamplesList()
public 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;
Returns
Type Description
List <com.google.rpc.Status >
getErrorSamplesOrBuilder(int index)
public 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;
Parameter
Name Description
indexint
Returns
Type Description
com.google.rpc.StatusOrBuilder
getErrorSamplesOrBuilderList()
public 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;
Returns
Type Description
List <? extends com.google.rpc.StatusOrBuilder >
getIndexTime()
public 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
Type Description
Timestamp The indexTime.
getIndexTimeOrBuilder()
public 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;
getParserForType()
public Parser<Document . IndexStatus > getParserForType ()
Overrides
getPendingMessage()
public 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
Type Description
String The pendingMessage.
getPendingMessageBytes()
public 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
Type Description
ByteString The bytes for pendingMessage.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hasIndexTime()
public 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
Type Description
boolean Whether the indexTime field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Document . IndexStatus . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document . IndexStatus . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Document . IndexStatus . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
