Class Document.IndexStatus (0.48.0)

public static final class Document.IndexStatus extends GeneratedMessageV3 implements Document.IndexStatusOrBuilder

Index status of the document.

Protobuf type google.cloud.discoveryengine.v1.Document.IndexStatus

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

Static Methods

getDefaultInstance()

public static Document.IndexStatus getDefaultInstance()
Returns
Type Description
Document.IndexStatus

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Document.IndexStatus.Builder newBuilder()
Returns
Type Description
Document.IndexStatus.Builder

newBuilder(Document.IndexStatus prototype)

public static Document.IndexStatus.Builder newBuilder(Document.IndexStatus prototype)
Parameter
Name Description
prototype Document.IndexStatus
Returns
Type Description
Document.IndexStatus.Builder

parseDelimitedFrom(InputStream input)

public static Document.IndexStatus parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.IndexStatus
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.IndexStatus parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.IndexStatus
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Document.IndexStatus parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Document.IndexStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.IndexStatus parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.IndexStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.IndexStatus parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Document.IndexStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.IndexStatus parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.IndexStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.IndexStatus parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Document.IndexStatus
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.IndexStatus parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.IndexStatus
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Document.IndexStatus parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.IndexStatus
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.IndexStatus parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.IndexStatus
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Document.IndexStatus parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Document.IndexStatus
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.IndexStatus parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.IndexStatus
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Document.IndexStatus> parser()
Returns
Type Description
Parser<IndexStatus>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Document.IndexStatus getDefaultInstanceForType()
Returns
Type Description
Document.IndexStatus

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
index int
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
index int
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;

Returns
Type Description
TimestampOrBuilder

getParserForType()

public Parser<Document.IndexStatus> getParserForType()
Returns
Type Description
Parser<IndexStatus>
Overrides

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Document.IndexStatus.Builder newBuilderForType()
Returns
Type Description
Document.IndexStatus.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.IndexStatus.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Document.IndexStatus.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Document.IndexStatus.Builder toBuilder()
Returns
Type Description
Document.IndexStatus.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException