For the complete documentation index, see llms.txt. This page is also available as Markdown.

GetResource

Get resource.

Task version: 1.0.0

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Task Parameters

Name
Description

BaseUri : String

Service base URI.

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

Default: - Example: https://bigquery.googleapis.com

Resource : Resources

Resource.

Possible values:

  • Datasets: Resource.

  • Jobs: Resource.

  • Models: Resource.

  • Routines: Resource.

  • Tables: Resource.

Default: Tables Example: Resources.Tables

ProjectId : String

Project ID.

Default: - Example: global-env-397309

DatasetId : String

Dataset ID.

Default: - Example: baseball

TableId : String

Table ID.

Default: - Example: games_post_wide

JobId : String

Job ID.

Default: - Example: my_job

ModelId : String

Model ID.

Default: - Example: my_model

RoutineId : String

Routine ID.

Default: - Example: my_routine

ReadMask : String

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.

Default: - Example: user.displayName,photos

SelectedFields : String

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.

Default: - Example: foo,bar

View : Views

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.

Default: Storagestats Example: Views.Storagestats

ReadJsonMethod : ReadJsonMethods

Method to read Service account JSON.

Possible values:

  • JSON: Method to read Service account JSON.

  • File: Method to read Service account JSON.

Default: File Example: ReadJsonMethods.File

🗝SecretJson : String

Service account key file.

Default: - Example: { "type": "service_account", "project_id": "your-project-id", ... }

CredentialsFilePath : String

Filepath to service account key file.

Default: - Example: C:\temp\jsonfile.json

Name
Description

ThrowOnError : Boolean

Throw an error on exception.

If set to false, exception message can be found in Result.ErrorMessage.

Default: True Example: true

Task Result

Name
Description

Success : Boolean

Operation complete without errors. Example: true

Data : Object

Data as JToken. Example: {{ "access": [ { "dataset": null, "domain": null, "groupByEmail": null ... }}

ErrorMessage : String

Error message. Example: Error occured...

Task Changelog

Changelog for Task Frends.GoogleBigQuery.GetResource.

[1.0.0] - 2023-09-12

Added

  • Initial implementation

Last updated

Was this helpful?