Interface PurgeDocumentsRequestOrBuilder (0.49.0)

public interface PurgeDocumentsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getErrorConfig()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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`

getInlineSource()

public abstract PurgeDocumentsRequest.InlineSource getInlineSource()

Inline source for the input content for purge.

.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource inline_source = 6;

Returns
Type	Description
`PurgeDocumentsRequest.InlineSource`	The inlineSource.

getInlineSourceOrBuilder()

public abstract PurgeDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()

Inline source for the input content for purge.

.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource inline_source = 6;

Returns
Type	Description
`PurgeDocumentsRequest.InlineSourceOrBuilder`

getParent()

public abstract 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 abstract 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.

getSourceCase()

public abstract PurgeDocumentsRequest.SourceCase getSourceCase()

Returns
Type	Description
`PurgeDocumentsRequest.SourceCase`

hasErrorConfig()

public abstract 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 abstract 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.

hasInlineSource()

public abstract boolean hasInlineSource()

Inline source for the input content for purge.

.google.cloud.discoveryengine.v1alpha.PurgeDocumentsRequest.InlineSource inline_source = 6;

Returns
Type	Description
`boolean`	Whether the inlineSource field is set.