Google BigQuery

Frends.GoogleBigQuery.GetResource / 1.0.0

Summary

Fetches the definition of one BigQuery object, optionally only the fields you ask for.

Typical use — checking a table's schema or a job's outcome before a Process acts on it

Details

Frends version
5.5 and newer
Agent
Crossplatform
Target framework
net6.0

Connection parameters.

Name Type Default Example Description
BaseUri String https://bigquery.googleapis.com

Service base URI. If empty, the default base URI for the service is used.

Resource Resources Tables Resources.Tables

Resource.

Possible values:

  • Datasets: Resource.

  • Jobs: Resource.

  • Models: Resource.

  • Routines: Resource.

  • Tables: Resource.

ProjectId String global-env-397309

Project ID.

DatasetId String baseball

Dataset ID.

TableId String games_post_wide

Table ID.

JobId String my_job

Job ID.

ModelId String my_model

Model ID.

RoutineId String my_routine

Routine ID.

ReadMask String user.displayName,photos

If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned. This is a comma-separated list of fully qualified names of fields.

SelectedFields String foo,bar

Table schema fields to return (comma-separated). If unspecified, all fields are returned. A fieldMask cannot be used here because the fields will automatically be converted from camelCase to snake_case and the conversion will fail if there are underscores. Since these are fields in BigQuery table schemas, underscores are allowed.

View Views Storagestats Views.Storagestats

Specifies the view that determines which table information is returned. By default, basic table information and storage statistics (STORAGE_STATS) are returned.

Possible values:

  • Full: Includes all table information, including storage statistics. It returns same information as STORAGE_STATS view, but may contain additional information in the future.

  • Basic: Includes basic table information including schema and partitioning specification. This view does not include storage statistics such as numRows or numBytes. This view is significantly more efficient and should be used to support high query rates.

  • Storagestats: Includes all information in the BASIC view as well as storage statistics (numBytes, numLongTermBytes, numRows and lastModifiedTime).

  • Tablemetadataviewunspecified: The default value. Default to the STORAGE_STATS view.

ReadJsonMethod ReadJsonMethods File ReadJsonMethods.File

Method to read Service account JSON.

Possible values:

  • JSON: Method to read Service account JSON.

  • File: Method to read Service account JSON.

SecretJsonSecret String { "type": "service_account", "project_id": "your-project-id", ... }

Service account key file.

CredentialsFilePath String C:\temp\jsonfile.json

Filepath to service account key file.

An unhandled error has occurred. Reload 🗙