Discovery Engine API (discoveryengine:v1alpha)

Additions

Methods


• ▼ ▲ discoveryengine.projects.locations.obtainCrawlRate

  Path : v1alpha/{+location}:obtainCrawlRate

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}:obtainCrawlRate

  HTTP Method : POST

  Parameters :

  location

  Description : Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : location

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

  Description : Obtains the time series data of organic or dedicated crawl rate for monitoring. When dedicated crawl rate is not set, it will return vertex AI's organic crawl rate time series. Organic crawl means Google automatically crawl the internet at its own convenience. When dedicated crawl rate is set, it will return vertex AI's dedicated crawl rate time series.

• ▼ ▲ discoveryengine.projects.locations.setDedicatedCrawlRate

  Path : v1alpha/{+location}:setDedicatedCrawlRate

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}:setDedicatedCrawlRate

  HTTP Method : POST

  Parameters :

  location

  Description : Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : location

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

  Description : Sets the dedicated crawl rate for a crawl_rate_scope. If the dedicated crawl rate was not set, this will enable vertex AI's crawl bot to use the new dedicated crawl rate for crawling. If the dedicated crawl rate was set, vertex AI's crawl bot will try to update the rate to the new value. If the new value is too high, the crawl bot may crawl at a lower rate to avoid overloading the user's website.

• ▼ ▲ discoveryengine.projects.locations.removeDedicatedCrawlRate

  Path : v1alpha/{+location}:removeDedicatedCrawlRate

  Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}:removeDedicatedCrawlRate

  HTTP Method : POST

  Parameters :

  location

  Description : Required. The location resource where crawl rate management will be performed. Format: `projects/{project}/locations/{location}`

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

  Location : path

  Required : Yes

  Type : string

  Parameter Order : location

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

  Description : Removes the dedicated crawl rate for a craw_rate_scope. If the dedicated crawl rate was set, this will disable vertex AI's crawl bot from using the dedicated crawl rate for crawling. If the dedicated crawl rate was not set, this is a no-op.