Package com.google.cloud.discoveryengine.v1beta

Interface PurgeDocumentsRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PurgeDocumentsRequest, PurgeDocumentsRequest.Builder
@Generated public interface PurgeDocumentsRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasGcsSource

      boolean hasGcsSource()
       Cloud Storage location for the input content.
 Supported `data_schema`:
 * `document_id`: One valid
 [Document.id][google.cloud.discoveryengine.v1beta.Document.id] per line.
      .google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 5;
      Returns:
      Whether the gcsSource field is set.

    • getGcsSource

      GcsSource getGcsSource()
       Cloud Storage location for the input content.
 Supported `data_schema`:
 * `document_id`: One valid
 [Document.id][google.cloud.discoveryengine.v1beta.Document.id] per line.
      .google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 5;
      Returns:
      The gcsSource.

    • getGcsSourceOrBuilder

      GcsSourceOrBuilder getGcsSourceOrBuilder()
       Cloud Storage location for the input content.
 Supported `data_schema`:
 * `document_id`: One valid
 [Document.id][google.cloud.discoveryengine.v1beta.Document.id] per line.
      .google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 5;

    • hasInlineSource

      boolean hasInlineSource()
       Inline source for the input content for purge.
      .google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.InlineSource inline_source = 6;
      Returns:
      Whether the inlineSource field is set.

    • getInlineSource

      PurgeDocumentsRequest.InlineSource getInlineSource()
       Inline source for the input content for purge.
      .google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.InlineSource inline_source = 6;
      Returns:
      The inlineSource.

    • getInlineSourceOrBuilder

      PurgeDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()
       Inline source for the input content for purge.
      .google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.InlineSource inline_source = 6;

    • getParent

      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:
      The parent.

    • getParentBytes

      com.google.protobuf.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:
      The bytes for parent.

    • getFilter

      String getFilter()
       Required. Filter matching documents to purge. Only currently supported
 value is
 `*` (all items).
      string filter = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The filter.

    • getFilterBytes

      com.google.protobuf.ByteString getFilterBytes()
       Required. Filter matching documents to purge. Only currently supported
 value is
 `*` (all items).
      string filter = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for filter.

    • hasErrorConfig

      boolean hasErrorConfig()
       The desired location of errors incurred during the purge.
      .google.cloud.discoveryengine.v1beta.PurgeErrorConfig error_config = 7;
      Returns:
      Whether the errorConfig field is set.

    • getErrorConfig

      PurgeErrorConfig getErrorConfig()
       The desired location of errors incurred during the purge.
      .google.cloud.discoveryengine.v1beta.PurgeErrorConfig error_config = 7;
      Returns:
      The errorConfig.

    • getErrorConfigOrBuilder

      PurgeErrorConfigOrBuilder getErrorConfigOrBuilder()
       The desired location of errors incurred during the purge.
      .google.cloud.discoveryengine.v1beta.PurgeErrorConfig error_config = 7;

    • getForce

      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:
      The force.

    • getSourceCase

      PurgeDocumentsRequest.SourceCase getSourceCase()