Class PurgeDocumentsRequest (0.41.0)

public final class PurgeDocumentsRequest extends GeneratedMessageV3 implements PurgeDocumentsRequestOrBuilder

Request message for DocumentService.PurgeDocuments method.

Protobuf type google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest

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

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PurgeDocumentsRequest getDefaultInstance()
Returns
Type Description
PurgeDocumentsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PurgeDocumentsRequest.Builder newBuilder()
Returns
Type Description
PurgeDocumentsRequest.Builder

newBuilder(PurgeDocumentsRequest prototype)

public static PurgeDocumentsRequest.Builder newBuilder(PurgeDocumentsRequest prototype)
Parameter
Name Description
prototype PurgeDocumentsRequest
Returns
Type Description
PurgeDocumentsRequest.Builder

parseDelimitedFrom(InputStream input)

public static PurgeDocumentsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PurgeDocumentsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PurgeDocumentsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PurgeDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PurgeDocumentsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PurgeDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PurgeDocumentsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PurgeDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PurgeDocumentsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PurgeDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PurgeDocumentsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PurgeDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PurgeDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PurgeDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PurgeDocumentsRequest> parser()
Returns
Type Description
Parser<PurgeDocumentsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PurgeDocumentsRequest getDefaultInstanceForType()
Returns
Type Description
PurgeDocumentsRequest

getErrorConfig()

public PurgeErrorConfig getErrorConfig()

The desired location of errors incurred during the purge.

.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;

Returns
Type Description
PurgeErrorConfig

The errorConfig.

getErrorConfigOrBuilder()

public PurgeErrorConfigOrBuilder getErrorConfigOrBuilder()

The desired location of errors incurred during the purge.

.google.cloud.discoveryengine.v1alpha.PurgeErrorConfig error_config = 7;

Returns
Type Description
PurgeErrorConfigOrBuilder

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.v1alpha.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.v1alpha.GcsSource gcs_source = 5;

Returns
Type Description
GcsSourceOrBuilder

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()
Returns
Type Description
Parser<PurgeDocumentsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSourceCase()

public PurgeDocumentsRequest.SourceCase getSourceCase()
Returns
Type Description
PurgeDocumentsRequest.SourceCase

hasErrorConfig()

public boolean hasErrorConfig()

The desired location of errors incurred during the purge.

.google.cloud.discoveryengine.v1alpha.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.v1alpha.GcsSource gcs_source = 5;

Returns
Type Description
boolean

Whether the gcsSource field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PurgeDocumentsRequest.Builder newBuilderForType()
Returns
Type Description
PurgeDocumentsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PurgeDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PurgeDocumentsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PurgeDocumentsRequest.Builder toBuilder()
Returns
Type Description
PurgeDocumentsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException