Class PurgeDocumentsRequest (0.55.0)
Version 0.55.0keyboard_arrow_down
public final class PurgeDocumentsRequest extends GeneratedMessageV3 implements PurgeDocumentsRequestOrBuilder
Request message for
DocumentService.PurgeDocuments
method.
Protobuf type google.cloud.discoveryengine.v1.PurgeDocumentsRequest
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
ERROR_CONFIG_FIELD_NUMBER
public static final int ERROR_CONFIG_FIELD_NUMBER
Field Value
Type Description
int
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int
FORCE_FIELD_NUMBER
public static final int FORCE_FIELD_NUMBER
Field Value
Type Description
int
GCS_SOURCE_FIELD_NUMBER
public static final int GCS_SOURCE_FIELD_NUMBER
Field Value
Type Description
int
INLINE_SOURCE_FIELD_NUMBER
public static final int INLINE_SOURCE_FIELD_NUMBER
Field Value
Type Description
int
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static PurgeDocumentsRequest getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static PurgeDocumentsRequest . Builder newBuilder ()
newBuilder(PurgeDocumentsRequest prototype)
public static PurgeDocumentsRequest . Builder newBuilder ( PurgeDocumentsRequest prototype )
public static PurgeDocumentsRequest parseDelimitedFrom ( InputStream input )
public static PurgeDocumentsRequest parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static PurgeDocumentsRequest parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static PurgeDocumentsRequest parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static PurgeDocumentsRequest parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static PurgeDocumentsRequest parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static PurgeDocumentsRequest parseFrom ( CodedInputStream input )
public static PurgeDocumentsRequest parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static PurgeDocumentsRequest parseFrom ( InputStream input )
public static PurgeDocumentsRequest parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static PurgeDocumentsRequest parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static PurgeDocumentsRequest parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<PurgeDocumentsRequest> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public PurgeDocumentsRequest getDefaultInstanceForType ()
getErrorConfig()
public PurgeErrorConfig getErrorConfig ()
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1.PurgeErrorConfig error_config = 7;
getErrorConfigOrBuilder()
public PurgeErrorConfigOrBuilder getErrorConfigOrBuilder ()
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1.PurgeErrorConfig error_config = 7;
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.
getGcsSource()
public GcsSource getGcsSource ()
Cloud Storage location for the input content.
Supported data_schema:
document_id: One valid
Document.id per line.
.google.cloud.discoveryengine.v1.GcsSource gcs_source = 5;
Returns
Type Description
GcsSource The gcsSource.
getGcsSourceOrBuilder()
public GcsSourceOrBuilder getGcsSourceOrBuilder ()
Cloud Storage location for the input content.
Supported data_schema:
document_id: One valid
Document.id per line.
.google.cloud.discoveryengine.v1.GcsSource gcs_source = 5;
getInlineSource()
public PurgeDocumentsRequest . InlineSource getInlineSource ()
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.InlineSource inline_source = 6;
getInlineSourceOrBuilder()
public PurgeDocumentsRequest . InlineSourceOrBuilder getInlineSourceOrBuilder ()
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.InlineSource inline_source = 6;
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.
getParserForType()
public Parser<PurgeDocumentsRequest> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getSourceCase()
public PurgeDocumentsRequest . SourceCase getSourceCase ()
hasErrorConfig()
public boolean hasErrorConfig ()
The desired location of errors incurred during the purge.
.google.cloud.discoveryengine.v1.PurgeErrorConfig error_config = 7;
Returns
Type Description
boolean Whether the errorConfig field is set.
hasGcsSource()
public boolean hasGcsSource ()
Cloud Storage location for the input content.
Supported data_schema:
document_id: One valid
Document.id per line.
.google.cloud.discoveryengine.v1.GcsSource gcs_source = 5;
Returns
Type Description
boolean Whether the gcsSource field is set.
hasInlineSource()
public boolean hasInlineSource ()
Inline source for the input content for purge.
.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.InlineSource inline_source = 6;
Returns
Type Description
boolean Whether the inlineSource field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public PurgeDocumentsRequest . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected PurgeDocumentsRequest . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public PurgeDocumentsRequest . 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-11 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-11 UTC."],[],[]]
