- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- WebsiteDataSource
- EstimatorUriPattern
- FileDataSource
Estimates the data size to be used by a customer.
HTTP request
POST https://discoveryengine.googleapis.com/v1alpha/{location=projects/*/locations/*}:estimateDataSize
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
location
|
Required. Full resource name of the location, such as |
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{ // Union field |
data_source
. Data source for which we are estimating its size. data_source
can be only one of the following:websiteDataSource
object (
WebsiteDataSource
)
Website data.
fileDataSource
object (
FileDataSource
)
Structured or unstructured data.
Response body
If successful, the response body contains an instance of Operation
.
Authorization scopes
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
IAM Permissions
Requires the following IAM
permission on the location
resource:
-
discoveryengine.locations.estimateDataSize
For more information, see the IAM documentation .
WebsiteDataSource
Data source is a set of website patterns that we crawl to get the total number of websites.
| JSON representation |
|---|
{
"estimatorUriPatterns"
:
[
{
object (
|
| Fields | |
|---|---|
estimatorUriPatterns[]
|
Required. The URI patterns to estimate the data sizes. At most 10 patterns are allowed, otherwise an INVALID_ARGUMENT error is thrown. |
EstimatorUriPattern
URI patterns that we use to crawl.
| JSON representation |
|---|
{ "providedUriPattern" : string , "exactMatch" : boolean , "exclusive" : boolean } |
| Fields | |
|---|---|
providedUriPattern
|
User provided URI pattern. For example, |
exactMatch
|
Whether we infer the generated URI or use the exact provided one. |
exclusive
|
Whether the pattern is exclusive or not. If set to true, the pattern is considered exclusive. If unset or set to false, the pattern is considered inclusive by default. |
FileDataSource
Data source contains files either in Cloud Storage or BigQuery.
| JSON representation |
|---|
{ // Union field |
source
. Which source contains the files to be used. source
can be only one of the following:gcsSource
object (
GcsSource
)
Cloud Storage location for the input content.
bigquerySource
object (
BigQuerySource
)
BigQuery input source.
