Interface PurgeDocumentsResponseOrBuilder (0.49.0)

Version latest

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.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.