Class PurgeDocumentsResponse.Builder (0.51.0)
0.83.0 (latest)
0.81.0
0.79.0
0.78.0
0.77.0
0.76.0
0.74.0
0.72.0
0.71.0
0.70.0
0.69.0
0.68.0
0.66.0
0.64.0
0.63.0
0.60.0
0.59.0
0.58.0
0.56.0
0.55.0
0.54.0
0.53.0
0.52.0
0.51.0
0.50.0
0.49.0
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 static final class PurgeDocumentsResponse . Builder extends GeneratedMessageV3 . Builder<PurgeDocumentsResponse . Builder > 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addAllPurgeSample(Iterable<String> values)
public PurgeDocumentsResponse . Builder addAllPurgeSample ( Iterable<String> values )
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
valuesIterable <String >The purgeSample to add.
addPurgeSample(String value)
public PurgeDocumentsResponse . Builder addPurgeSample ( String value )
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
valueString The purgeSample to add.
addPurgeSampleBytes(ByteString value)
public PurgeDocumentsResponse . Builder addPurgeSampleBytes ( ByteString value )
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
valueByteString The bytes of the purgeSample to add.
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PurgeDocumentsResponse . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public PurgeDocumentsResponse build ()
buildPartial()
public PurgeDocumentsResponse buildPartial ()
clear()
public PurgeDocumentsResponse . Builder clear ()
Overrides
clearField(Descriptors.FieldDescriptor field)
public PurgeDocumentsResponse . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public PurgeDocumentsResponse . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clearPurgeCount()
public PurgeDocumentsResponse . Builder clearPurgeCount ()
The total count of documents purged as a result of the operation.
int64 purge_count = 1;
clearPurgeSample()
public PurgeDocumentsResponse . Builder clearPurgeSample ()
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) = { ... }
clone()
public PurgeDocumentsResponse . Builder clone ()
Overrides
getDefaultInstanceForType()
public PurgeDocumentsResponse getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
getPurgeCount()
public 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 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
indexint The index of the element to return.
Returns
Type Description
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
Name Description
indexint The index of the value to return.
Returns
Type Description
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
Type Description
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) = { ... }
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(PurgeDocumentsResponse other)
public PurgeDocumentsResponse . Builder mergeFrom ( PurgeDocumentsResponse other )
public PurgeDocumentsResponse . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public PurgeDocumentsResponse . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PurgeDocumentsResponse . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public PurgeDocumentsResponse . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
setPurgeCount(long value)
public PurgeDocumentsResponse . Builder setPurgeCount ( long value )
The total count of documents purged as a result of the operation.
int64 purge_count = 1;
Parameter
Name Description
valuelong The purgeCount to set.
setPurgeSample(int index, String value)
public PurgeDocumentsResponse . Builder setPurgeSample ( int index , String value )
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) = { ... }
Parameters
Name Description
indexint The index to set the value at.
valueString The purgeSample to set.
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PurgeDocumentsResponse . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final PurgeDocumentsResponse . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
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 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
