bigframes._config.BigQueryOptions.use_regional_endpoints

property BigQueryOptions.use_regional_endpoints: bool

Flag to connect to regional API endpoints for BigQuery API and BigQuery Storage API.

Note

Use of regional endpoints is a feature in Preview and available only in regions “europe-west3”, “europe-west8”, “europe-west9”, “me-central2”, “us-central1”, “us-central2”, “us-east1”, “us-east4”, “us-east5”, “us-east7”, “us-south1”, “us-west1”, “us-west2”, “us-west3” and “us-west4”.

Requires that location is set. For [supported regions](https://cloud.google.com/bigquery/docs/regional-endpoints), for example europe-west3, you need to specify location='europe-west3' and use_regional_endpoints=True, and then BigQuery DataFrames would connect to the BigQuery endpoint bigquery.europe-west3.rep.googleapis.com. For not supported regions, for example asia-northeast1, when you specify location='asia-northeast1' and use_regional_endpoints=True, the global endpoint bigquery.googleapis.com would be used, which does not promise any guarantee on the request remaining within the location during transit.

Returns:

A boolean value, where True indicates that regional endpoints would be used for BigQuery and BigQuery storage APIs; otherwise global endpoints would be used.

Return type:

bool