Discovery Engine API (discoveryengine:v1alpha)

2024-11-02

5 new methods

Additions

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

      Path: v1alpha/{+parent}/sitemaps

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: parent

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

      Description: Creates a Sitemap.

  • discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.sitemaps.delete

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Deletes a Sitemap.

  • discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.create

      Path: v1alpha/{+parent}/sitemaps

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: parent

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

      Description: Creates a Sitemap.

  • discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.delete

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps/{sitemapsId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. Full resource name of Sitemap, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/sitemaps/{sitemap}`. If the caller does not have permission to access the Sitemap, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Sitemap does not exist, a NOT_FOUND error is returned.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Deletes a Sitemap.

  • discoveryengine.projects.locations.dataStores.siteSearchEngine.sitemaps.fetch

      Path: v1alpha/{+parent}/sitemaps:fetch

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine/sitemaps:fetch

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. Parent resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.

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

          Location: path

          Required: Yes

          Type: string

        matcher.urisMatcher.uris

          Description: The Sitemap uris.

          Location: query

          Repeated: Yes

          Type: string

      Parameter Order: parent

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

      Description: Fetch Sitemaps in a DataStore.