Interface PurgeDocumentsResponseOrBuilder (0.37.0) 

public interface PurgeDocumentsResponseOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getPurgeCount()

public abstract long getPurgeCount()

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

int64 purge_count = 1;

Returns
Type Description
long

The purgeCount.

getPurgeSample(int index)

public abstract 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
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The purgeSample at the given index.

getPurgeSampleBytes(int index)

public abstract 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
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the purgeSample at the given index.

getPurgeSampleCount()

public abstract 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
Type Description
int

The count of purgeSample.

getPurgeSampleList()

public abstract List<String> 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
Type Description
List<String>

A list containing the purgeSample.