View Source GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1PurgeDocumentsRequest (google_api_discovery_engine v0.27.0)

Request message for DocumentService.PurgeDocuments method.

Attributes

  • errorConfig (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1PurgeErrorConfig.t, default: nil) - The desired location of errors incurred during the purge.
  • filter (type: String.t, default: nil) - Required. Filter matching documents to purge. Only currently supported value is * (all items).
  • force (type: boolean(), default: nil) - Actually performs the purge. If force is set to false, return the expected purge count without deleting any documents.
  • gcsSource (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1GcsSource.t, default: nil) - Cloud Storage location for the input content. Supported data_schema: * document_id: One valid Document.id per line.
  • inlineSource (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource.t, default: nil) - Inline source for the input content for purge.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1PurgeDocumentsRequest{
    errorConfig:
      GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1PurgeErrorConfig.t()
      | nil,
    filter: String.t() | nil,
    force: boolean() | nil,
    gcsSource:
      GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1GcsSource.t()
      | nil,
    inlineSource:
      GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource.t()
      | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.