- 0.74.0 (latest)
- 0.72.0
- 0.71.0
- 0.70.0
- 0.69.0
- 0.68.0
- 0.66.0
- 0.64.0
- 0.63.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface PurgeDocumentsRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getErrorConfig()
public abstract PurgeErrorConfig getErrorConfig()The desired location of errors incurred during the purge.
 .google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.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.v1.PurgeDocumentsRequest.InlineSource inline_source = 6;
 
| Returns | |
|---|---|
| Type | Description | 
| boolean | Whether the inlineSource field is set. |