View Source GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse (google_api_discovery_engine v0.7.0)

Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.

Attributes

  • purgeCount (type: String.t, default: nil) - The total count of documents purged as a result of the operation.
  • purgeSample (type: list(String.t), default: nil) - A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse{
    purgeCount: String.t() | nil,
    purgeSample: [String.t()] | nil
  }

Functions

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

Unwrap a decoded JSON object into its complex fields.