PatchResource
Updates information in an existing resource. Patch method only replaces fields that are provided in the submitted resource.
Task version: 1.0.0
Required Frends version: 5.5+
Required .NET version: 6.0
Compatible Agents: Crossplatform
Task Parameters
BaseUri : String
Service base URI.
If empty, the default base URI for the service is used.
Default: -
Example: https://bigquery.googleapis.com
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
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: 1
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
Resource : Resources
Resource type.
Possible values:
Dataset: Resource type.Table: Resource type.
Default: 0
Example: Resources.Dataset
Description : String
Resource description. (Optional)
Default: -
Example: Example description.
FriendlyName : String
Friendly name for Dataset or Table resource. (Optional)
Default: -
Example: Example name
Location : String
The geographic location where the resource should reside.
See details at https://cloud.google.com/bigquery/docs/locations
Default: EU
Example: europe-north1
Label : LabelParameters[]
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.
Default: -
Example: [ {foo, bar }, { bar, foo } ]
SetEncryptionConfiguration : Boolean
Set Dataset or Table encryption configuration.
Default: False
Example: false
KmsKeyName : String
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.
Default: -
Example: projects/your-project/locations/global/keyRings/your-key-ring/cryptoKeys/your-key
StorageBillingModel : String
Storage billing model to be used for all tables in the dataset.
Can be set to PHYSICAL.
Default: LOGICAL
Example: LOGICAL
IsCaseInsensitive : Boolean
Indicates if table names are case insensitive in the dataset.
Default: False
Example: false
MaxTimeTravelHours : Int64
Number of hours for the max time travel for all tables in the dataset.
Unlimited if 0.
Default: 0
Example: 0
Access : AccessParameters[]
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;
Default: -
Example: [ { READER, foo@bar.com }, { WRITER, bar@bar.com } ]
Tag : TagParameters[]
The tags associated with this dataset. (Optional)
Tag keys are globally unique.
Default: -
Example: [ { foo, bar }, { foo2, bar2 } ]
RequirePartitionFilter : Boolean
If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
Default: False
Example: false
TableSchema : TableSchemaParameters[]
Describes the schema of this table.
Default: -
Example: [ { Name = "Name", Type = "STRING" }, { Name = "AGE", Type = "INTEGER" }, { Name = "BDAY", Type = "DATE" } ]
Partition : TablePartitionOptions
Partition option.
Possible values:
None: Partition option.RangePartitioning: Partition option.TimePartitioning: Partition option.
Default: 0
Example: TablePartitionOptions.RangePartitioning
RangeField : String
The table is partitioned by this field.
The field must be a top-level NULLABLE/REQUIRED field.
The only supported type is INTEGER/INT64.
Default: -
Example: AGE
RangeStart : Int64
The start of range partitioning, inclusive
Default: -
Example: 1
RangeEnd : Int64
The end of range partitioning, exclusive.
Default: -
Example: 2
RangeInterval : Int64
The width of each interval.
Default: -
Example: 2
TimeField : String
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.
Default: -
Example: TIMESTAMP
Type : TimeTypeOptions
Generate one partition per day, hour, month, or year.
Possible values:
DAY: Generate one partition per day, hour, month, or year.HOUR: Generate one partition per day, hour, month, or year.MONTH: Generate one partition per day, hour, month, or year.YEAR: Generate one partition per day, hour, month, or year.
Default: 0
Example: TimeTypeOptions.DAY
TimeRequirePartitionFilter : Boolean
RequirePartitionFilter
Default: false
Example: false
ExpirationMs : Int64
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.
Default: 0
Example: 0
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
Success : Boolean
Operation complete without errors.
Example: true
ErrorMessage : String
Error message.
Example: Error occured...
Task Changelog
Changelog for Task Frends.GoogleBigQuery.PatchResource.
[1.0.0] - 2023-09-19
Added
Initial implementation
Last updated
Was this helpful?