Class PurgeDocumentsResponse (0.16.0)

public final class PurgeDocumentsResponse extends GeneratedMessageV3 implements PurgeDocumentsResponseOrBuilder

Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Protobuf type google.cloud.discoveryengine.v1.PurgeDocumentsResponse

Static Fields

PURGE_COUNT_FIELD_NUMBER

public static final int PURGE_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

PURGE_SAMPLE_FIELD_NUMBER

public static final int PURGE_SAMPLE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PurgeDocumentsResponse getDefaultInstance()
Returns
TypeDescription
PurgeDocumentsResponse

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PurgeDocumentsResponse.Builder newBuilder()
Returns
TypeDescription
PurgeDocumentsResponse.Builder

newBuilder(PurgeDocumentsResponse prototype)

public static PurgeDocumentsResponse.Builder newBuilder(PurgeDocumentsResponse prototype)
Parameter
NameDescription
prototypePurgeDocumentsResponse
Returns
TypeDescription
PurgeDocumentsResponse.Builder

parseDelimitedFrom(InputStream input)

public static PurgeDocumentsResponse parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PurgeDocumentsResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsResponse parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeDocumentsResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PurgeDocumentsResponse parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PurgeDocumentsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsResponse parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeDocumentsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PurgeDocumentsResponse parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PurgeDocumentsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsResponse parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeDocumentsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PurgeDocumentsResponse parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PurgeDocumentsResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsResponse parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeDocumentsResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PurgeDocumentsResponse parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PurgeDocumentsResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsResponse parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeDocumentsResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PurgeDocumentsResponse parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PurgeDocumentsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsResponse parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PurgeDocumentsResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PurgeDocumentsResponse> parser()
Returns
TypeDescription
Parser<PurgeDocumentsResponse>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PurgeDocumentsResponse getDefaultInstanceForType()
Returns
TypeDescription
PurgeDocumentsResponse

getParserForType()

public Parser<PurgeDocumentsResponse> getParserForType()
Returns
TypeDescription
Parser<PurgeDocumentsResponse>
Overrides

getPurgeCount()

public long getPurgeCount()

The total count of documents purged as a result of the operation.

int64 purge_count = 1;

Returns
TypeDescription
long

The purgeCount.

getPurgeSample(int index)

public String getPurgeSample(int index)

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The purgeSample at the given index.

getPurgeSampleBytes(int index)

public ByteString getPurgeSampleBytes(int index)

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the purgeSample at the given index.

getPurgeSampleCount()

public int getPurgeSampleCount()

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
int

The count of purgeSample.

getPurgeSampleList()

public ProtocolStringList getPurgeSampleList()

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

repeated string purge_sample = 2 [(.google.api.resource_reference) = { ... }

Returns
TypeDescription
ProtocolStringList

A list containing the purgeSample.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PurgeDocumentsResponse.Builder newBuilderForType()
Returns
TypeDescription
PurgeDocumentsResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PurgeDocumentsResponse.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PurgeDocumentsResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PurgeDocumentsResponse.Builder toBuilder()
Returns
TypeDescription
PurgeDocumentsResponse.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException