GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest (google_api_discovery_engine v0.28.0)

View Source

Request message for CrawlRateManagementService.SetDedicatedCrawlRate method. The user can set the crawl rate for a crawl_rate_scope they own. They can set up an overall crawl rate, or set up a user-triggered crawl rate and a auto-refresh crawl rate separately. If an overall crawl rate is set, Vertex AI will automatically splits crawl_rate into user-triggered and auto-refresh.

Attributes

  • crawlRate (type: integer(), default: nil) - Optional. The crawl QPS set by the user. It is not guaranteed that Vertex crawl bot will crawl at this QPS. If the crawl rate is too high, the real QPS may be lower than the value set by the user to avoid overloading the user's website.
  • crawlRateScope (type: String.t, default: nil) - Required. The scope of the crawl rate that the user wants to config. Currently, only domain and host name are supported. A domain name example: example.com. A host name example: www.example.com. Please do not include / in the domain or host name.
  • crawlType (type: String.t, default: nil) - Optional. Whether it's the crawl rate of user-triggered or auto-refresh.
  • mode (type: String.t, default: nil) - Optional. Whether the rate is explicitly set by users, or set by vertex AI.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaSetDedicatedCrawlRateRequest{
    crawlRate: integer() | nil,
    crawlRateScope: String.t() | nil,
    crawlType: String.t() | nil,
    mode: String.t() | nil
  }

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.