# GetResource

Required Frends version: 5.5+

Required .NET version: 6.0

Compatible Agents: Crossplatform

Source code: <https://github.com/FrendsPlatform/Frends.GoogleBigQuery>

{% tabs %}
{% tab title="Parameter: Connection" %}

| Name                               | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| BaseUri : `String`                 | <p>Service base URI.</p><p>If empty, the default base URI for the service is used.</p><p><br>Default: <code>-</code><br>Example: <code><https://bigquery.googleapis.com></code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| Resource : `Resources`             | <p>Resource.</p><p>Possible values:</p><ul><li><code>Datasets</code>:</li></ul><p>Resource.</p><ul><li><code>Jobs</code>:</li></ul><p>Resource.</p><ul><li><code>Models</code>:</li></ul><p>Resource.</p><ul><li><code>Routines</code>:</li></ul><p>Resource.</p><ul><li><code>Tables</code>:</li></ul><p>Resource.</p><p><br>Default: <code>4</code><br>Example: <code>Resources.Tables</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ProjectId : `String`               | <p>Project ID.</p><p><br>Default: <code>-</code><br>Example: <code>global-env-397309</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| DatasetId : `String`               | <p>Dataset ID.</p><p><br>Default: <code>-</code><br>Example: <code>baseball</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| TableId : `String`                 | <p>Table ID.</p><p><br>Default: <code>-</code><br>Example: <code>games\_post\_wide</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| JobId : `String`                   | <p>Job ID.</p><p><br>Default: <code>-</code><br>Example: <code>my\_job</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| ModelId : `String`                 | <p>Model ID.</p><p><br>Default: <code>-</code><br>Example: <code>my\_model</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| RoutineId : `String`               | <p>Routine ID.</p><p><br>Default: <code>-</code><br>Example: <code>my\_routine</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| ReadMask : `String`                | <p>If set, only the Routine fields in the field mask are returned in the response.</p><p>If unset, all Routine fields are returned.</p><p>This is a comma-separated list of fully qualified names of fields.</p><p><br>Default: <code>-</code><br>Example: <code>user.displayName,photos</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| SelectedFields : `String`          | <p>Table schema fields to return (comma-separated).</p><p>If unspecified, all fields are returned.</p><p>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.</p><p>Since these are fields in BigQuery table schemas, underscores are allowed.</p><p><br>Default: <code>-</code><br>Example: <code>foo,bar</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| View : `Views`                     | <p>Specifies the view that determines which table information is returned.</p><p>By default, basic table information and storage statistics (STORAGE\_STATS) are returned.</p><p>Possible values:</p><ul><li><code>Full</code>:</li></ul><p>Specifies the view that determines which table information is returned.</p><p>By default, basic table information and storage statistics (STORAGE\_STATS) are returned.</p><ul><li><code>Basic</code>:</li></ul><p>Specifies the view that determines which table information is returned.</p><p>By default, basic table information and storage statistics (STORAGE\_STATS) are returned.</p><ul><li><code>Storagestats</code>:</li></ul><p>Specifies the view that determines which table information is returned.</p><p>By default, basic table information and storage statistics (STORAGE\_STATS) are returned.</p><ul><li><code>Tablemetadataviewunspecified</code>:</li></ul><p>Specifies the view that determines which table information is returned.</p><p>By default, basic table information and storage statistics (STORAGE\_STATS) are returned.</p><p><br>Default: <code>2</code><br>Example: <code>Views.Storagestats</code></p> |
| ReadJsonMethod : `ReadJsonMethods` | <p>Method to read Service account JSON.</p><p>Possible values:</p><ul><li><code>JSON</code>:</li></ul><p>Method to read Service account JSON.</p><ul><li><code>File</code>:</li></ul><p>Method to read Service account JSON.</p><p><br>Default: <code>1</code><br>Example: <code>ReadJsonMethods.File</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| 🗝SecretJson : `String`            | <p>Service account key file.</p><p><br>Default: <code>-</code><br>Example: <code>{ "type": "service\_account", "project\_id": "your-project-id", ... }</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| CredentialsFilePath : `String`     | <p>Filepath to service account key file.</p><p><br>Default: <code>-</code><br>Example: <code>C:\temp\jsonfile.json</code></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| {% endtab %}                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |

{% tab title="Parameter: Options" %}

| Name                     | Description                                                                                                                                                                          |
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| ThrowOnError : `Boolean` | <p>Throw an error on exception.</p><p>If set to false, exception message can be found in Result.ErrorMessage.</p><p><br>Default: <code>True</code><br>Example: <code>true</code></p> |
| {% endtab %}             |                                                                                                                                                                                      |

{% tab title="Result: Result" %}

| Name                    | Description                                                                                                                    |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| Success : `Boolean`     | <p>Operation complete without errors.<br>Example: <code>true</code></p>                                                        |
| Data : `Object`         | <p>Data as JToken.<br>Example: <code>{{ "access": \[ { "dataset": null, "domain": null, "groupByEmail": null ... }}</code></p> |
| ErrorMessage : `String` | <p>Error message.<br>Example: <code>Error occured...</code></p>                                                                |
| {% endtab %}            |                                                                                                                                |

{% tab title="Changelog" %}

## Changelog

### \[1.0.0] - 2023-09-12

#### Added

* Initial implementation
  {% endtab %}
  {% endtabs %}