Discovery Engine API (discoveryengine:v1)

2024-07-31

2 new methods | 2 updated methods

Additions

    Methods
  • discoveryengine.projects.locations.collections.dataStores.userEvents.purge

      Path: v1/{+parent}/userEvents:purge

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:purge

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`

          Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.

  • discoveryengine.projects.locations.dataStores.userEvents.purge

      Path: v1/{+parent}/userEvents:purge

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:purge

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`

          Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first.

Updates

    Methods
  • discoveryengine.projects.locations.collections.dataStores.create

      Parameters:

        skipDefaultSchemaCreation

          Description: A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.

          Location: query

          Type: boolean

  • discoveryengine.projects.locations.dataStores.create

      Parameters:

        skipDefaultSchemaCreation

          Description: A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified.

          Location: query

          Type: boolean