Frends.GoogleBigQuery.UpdateResource / 2.0.0
Summary
Replaces an existing BigQuery object's definition wholesale, so anything you leave out reverts rather than persisting.
Typical use — applying a definition you hold in full; use the patch Task when you only mean to change a field or two
Input parameters.
| Name | Type | Default | Example | Description |
|---|---|---|---|---|
| Resource | Resources |
Dataset |
Resources.Dataset |
Resource type. Possible values:
|
| Description | String |
– | Example description. |
Resource description. |
| FriendlyName | String |
– | Example name |
Friendly name for Dataset or Table resource. |
| Location | String |
EU |
europe-north1 |
The geographic location where the resource should reside. See details at https://cloud.google.com/bigquery/docs/locations |
| Label | LabelParameters[] |
– | [ {foo, bar }, { bar, foo } ] |
Label(s) for Dataset or Table resource. (Optional) Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label keys must start with a letter and each label in the list must have a different key. |
| SetEncryptionConfiguration | Boolean |
False |
false |
Set Dataset or Table encryption configuration. |
| KmsKeyName | String |
– | projects/your-project/locations/global/keyRings/your-key-ring/cryptoKeys/your-key |
Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key. |
| StorageBillingModel | String |
LOGICAL |
LOGICAL |
Storage billing model to be used for all tables in the dataset. Can be set to PHYSICAL. |
| IsCaseInsensitive | Boolean |
False |
false |
Indicates if table names are case insensitive in the dataset. |
| MaxTimeTravelHours | Int64 |
0 |
0 |
Number of hours for the max time travel for all tables in the dataset. Unlimited if 0. |
| Access | AccessParameters[] |
– | [ { READER, foo@bar.com }, { WRITER, bar@bar.com } ] |
An array of objects that define dataset access for one or more entities. (Optional) You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; |
| Tag | TagParameters[] |
– | [ { foo, bar }, { foo2, bar2 } ] |
The tags associated with this dataset. (Optional) Tag keys are globally unique. |
| DefinitionBody | String |
– | concat(x, \"\\n\", y) |
The body of the routine.
For functions, this is the expression in the AS clause.
If language=SQL, it is the substring inside (but excluding) the parentheses.
For example, for the function created with the following statement:
|
| Language | String |
– | SQL |
Defaults to "SQL" if Input.RemoteFunctionParameters is not empty, not set otherwise. (Optional) |
| RoutineType | RoutineTypes |
SCALAR_FUNCTION |
RoutineTypes.SCALAR_FUNCTION |
Routine type. Possible values:
|
| ReturnType | String |
– | DATE |
Optional if language = "SQL"; required otherwise.
Cannot be set if Input.RoutineType = "TABLE_VALUED_FUNCTION".
If absent, the return type is inferred from definition_body at query time in each query that references this routine.
If present, then the evaluated result will be cast to the specified returned type at query time.
For example, for the functions created with the following statements: * |
| DeterminismLevel | DeterminismLevels |
DETERMINISM_LEVEL_UNSPECIFIED |
DeterminismLevels.DETERMINISTIC |
The determinism level of the JavaScript UDF, if defined. Possible values:
|
| StrictMode | Boolean |
True |
true |
Can be set for procedures only. If true (default), the definition body will be validated in the creation and the updates of the procedure. For procedures with an argument of ANY TYPE, the definition body validtion is not supported at creation/update time, and thus this field must be set to false explicitly. |
| ImportedLibrary | ImportedLibraryParameters[] |
– | [ { foo }, { bar } ] |
If Input.Language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. (Optional) |
| Argument | ArgumentParameters[] |
– | [ { x, IN, INT64, FIXED_TYPE }, { y, OUT, INT64, FIXED_TYPE }, { 'not set', 'not set', INT64, 'not set' } ] |
Argument(s) of a function or a stored procedure. |
| SetRemoteFunctionParameters | Boolean |
False |
false |
Set remote function specific options. |
| RemoteConnection | String |
– | projects/{projectId}/locations/{locationId}/connections/{connectionId} |
Fully qualified name of the user-provided connection object which holds the authentication information to send requests to the remote service. |
| RemoteEndpoint | String |
– | https://us-east1-my_gcf_project.cloudfunctions.net/remote_add |
Endpoint of the user-provided remote service. |
| RemoteMaxBatchingRows | Int64 |
– | 0 |
Max number of rows in each batch sent to the remote service. If 0, BigQuery dynamically decides the number of rows in a batch. |
| RemoteUserDefinedContext | UserDefinedContext[] |
– | [ { foo, bar }, { foo2, bar2 } ] |
User-defined context as a set of key/value pairs, which will be sent as function invocation context together with batched arguments in the requests to the remote service. The total number of bytes of keys and values must be less than 8KB. |
| RequirePartitionFilter | Boolean |
False |
false |
If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. |
| TableSchema | TableSchemaParameters[] |
– | [ { Name = "Name", Type = "STRING" }, { Name = "AGE", Type = "INTEGER" }, { Name = "BDAY", Type = "DATE" } ] |
Describes the schema of this table. |
| Partition | TablePartitionOptions |
None |
TablePartitionOptions.RangePartitioning |
Partition option. Possible values:
|
| RangeField | String |
– | AGE |
The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64. |
| RangeStart | Int64 |
– | 1 |
The start of range partitioning, inclusive |
| RangeEnd | Int64 |
– | 2 |
The end of range partitioning, exclusive. |
| RangeInterval | Int64 |
– | 2 |
The width of each interval. |
| TimeField | String |
– | TIMESTAMP |
If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. |
| Type | TimeTypeOptions |
DAY |
TimeTypeOptions.DAY |
Generate one partition per day, hour, month, or year. Possible values:
|
| TimeRequirePartitionFilter | Boolean |
false |
false |
RequirePartitionFilter |
| ExpirationMs | Int64 |
0 |
0 |
Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value. |