Class PurgeDocumentsResponse (0.36.0)
Version 0.36.0keyboard_arrow_down
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.v1beta.PurgeDocumentsResponse
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
PURGE_COUNT_FIELD_NUMBER
public static final int PURGE_COUNT_FIELD_NUMBER
Field Value
Type Description
int
PURGE_SAMPLE_FIELD_NUMBER
public static final int PURGE_SAMPLE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static PurgeDocumentsResponse getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static PurgeDocumentsResponse . Builder newBuilder ()
newBuilder(PurgeDocumentsResponse prototype)
public static PurgeDocumentsResponse . Builder newBuilder ( PurgeDocumentsResponse prototype )
public static PurgeDocumentsResponse parseDelimitedFrom ( InputStream input )
public static PurgeDocumentsResponse parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static PurgeDocumentsResponse parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PurgeDocumentsResponse parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static PurgeDocumentsResponse parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PurgeDocumentsResponse parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static PurgeDocumentsResponse parseFrom ( CodedInputStream input )
public static PurgeDocumentsResponse parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static PurgeDocumentsResponse parseFrom ( InputStream input )
public static PurgeDocumentsResponse parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static PurgeDocumentsResponse parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PurgeDocumentsResponse parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<PurgeDocumentsResponse> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public PurgeDocumentsResponse getDefaultInstanceForType ()
getParserForType()
public Parser<PurgeDocumentsResponse> getParserForType ()
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) = { ... }
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public PurgeDocumentsResponse . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PurgeDocumentsResponse . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public PurgeDocumentsResponse . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
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 2025-10-30 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 2025-10-30 UTC."],[],[]]
