Class PurgeDocumentsRequest.Builder (0.44.0)
Version 0.44.0keyboard_arrow_down
public static final class PurgeDocumentsRequest . Builder extends GeneratedMessageV3 . Builder<PurgeDocumentsRequest . Builder > implements PurgeDocumentsRequestOrBuilder
Request message for
DocumentService.PurgeDocuments
method.
Protobuf type google.cloud.discoveryengine.v1.PurgeDocumentsRequest
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
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public PurgeDocumentsRequest . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public PurgeDocumentsRequest build ()
buildPartial()
public PurgeDocumentsRequest buildPartial ()
clear()
public PurgeDocumentsRequest . Builder clear ()
Overrides
clearField(Descriptors.FieldDescriptor field)
public PurgeDocumentsRequest . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
clearFilter()
public PurgeDocumentsRequest . Builder clearFilter ()
Required. Filter matching documents to purge. Only currently supported
value is
* (all items).
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
clearForce()
public PurgeDocumentsRequest . Builder clearForce ()
Actually performs the purge. If force is set to false, return the
expected purge count without deleting any documents.
bool force = 3;
clearOneof(Descriptors.OneofDescriptor oneof)
public PurgeDocumentsRequest . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clearParent()
public PurgeDocumentsRequest . Builder clearParent ()
Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
clone()
public PurgeDocumentsRequest . Builder clone ()
Overrides
getDefaultInstanceForType()
public PurgeDocumentsRequest getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
getFilter()
public String getFilter ()
Required. Filter matching documents to purge. Only currently supported
value is
* (all items).
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
String The filter.
getFilterBytes()
public ByteString getFilterBytes ()
Required. Filter matching documents to purge. Only currently supported
value is
* (all items).
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
Returns
Type Description
ByteString The bytes for filter.
getForce()
public boolean getForce ()
Actually performs the purge. If force is set to false, return the
expected purge count without deleting any documents.
bool force = 3;
Returns
Type Description
boolean The force.
getParent()
public String getParent ()
Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type Description
String The parent.
getParentBytes()
public ByteString getParentBytes ()
Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns
Type Description
ByteString The bytes for parent.
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(PurgeDocumentsRequest other)
public PurgeDocumentsRequest . Builder mergeFrom ( PurgeDocumentsRequest other )
public PurgeDocumentsRequest . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public PurgeDocumentsRequest . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final PurgeDocumentsRequest . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public PurgeDocumentsRequest . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
setFilter(String value)
public PurgeDocumentsRequest . Builder setFilter ( String value )
Required. Filter matching documents to purge. Only currently supported
value is
* (all items).
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name Description
valueString The filter to set.
setFilterBytes(ByteString value)
public PurgeDocumentsRequest . Builder setFilterBytes ( ByteString value )
Required. Filter matching documents to purge. Only currently supported
value is
* (all items).
string filter = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter
Name Description
valueByteString The bytes for filter to set.
setForce(boolean value)
public PurgeDocumentsRequest . Builder setForce ( boolean value )
Actually performs the purge. If force is set to false, return the
expected purge count without deleting any documents.
bool force = 3;
Parameter
Name Description
valueboolean The force to set.
setParent(String value)
public PurgeDocumentsRequest . Builder setParent ( String value )
Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter
Name Description
valueString The parent to set.
setParentBytes(ByteString value)
public PurgeDocumentsRequest . Builder setParentBytes ( ByteString value )
Required. The parent resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter
Name Description
valueByteString The bytes for parent to set.
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public PurgeDocumentsRequest . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final PurgeDocumentsRequest . 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 2025-10-29 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-29 UTC."],[],[]]
