CreateResource
Create resource to BigQuery table.
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.
Not required when Input.Resource = Dataset.
Default: -
Example: baseball
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": "global-env-397309", ... }
CredentialsFilePath : String
Filepath to service account key file.
Default: -
Example: C:\temp\jsonfile.json
Resource : Resources
Resource type.
Possible values:
Dataset: Resource type.Routine: 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
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
DatasetId : String
A unique ID for this dataset, without the project name.
The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
The maximum length is 1,024 characters.
Default: -
Example: Exampleid
Location : String
The geographic location where the dataset should reside.
See details at https://cloud.google.com/bigquery/docs/locations
Default: EU
Example: europe-north1
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 } ]
RoutineId : String
The ID of the routine.
The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).
The maximum length is 256.
Default: -
Example: routine
DefinitionBody : String
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:
CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y)) The definition_body is concat(x, "\n", y) (\n is not replaced with linebreak).
If language=JAVASCRIPT, it is the evaluated string in the AS clause.
For example, for the function created with the following statement:
CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n' The definition_body is return "\n";\n
Note that both \n are replaced with linebreaks.
Default: -
Example: concat(x, "\n", y)
Language : String
Defaults to "SQL" if Input.RemoteFunctionParameters is not empty, not set otherwise. (Optional)
Default: -
Example: SQL
RoutineType : RoutineTypes
Routine type.
Possible values:
SCALAR_FUNCTION: Routine type.PROCEDURE: Routine type.TABLE_FUNCTION: Routine type.
Default: 0
Example: RoutineTypes.SCALAR_FUNCTION
ReturnType : String
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: * CREATE FUNCTION Add(x FLOAT64, y FLOAT64) RETURNS FLOAT64 AS (x + y); * CREATE FUNCTION Increment(x FLOAT64) AS (Add(x, 1)); * CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1)); The return_type is {type_kind: "FLOAT64"} for Add and Decrement, and is absent for Increment (inferred as FLOAT64 at query time).
Suppose the function Add is replaced by CREATE OR REPLACE FUNCTION Add(x INT64, y INT64) AS (x + y); Then the inferred return type of Increment is automatically changed to INT64 at query time, while the return type of Decrement remains FLOAT64.
Default: -
Example: DATE
DeterminismLevel : DeterminismLevels
The determinism level of the JavaScript UDF, if defined.
Possible values:
DETERMINISM_LEVEL_UNSPECIFIED: The determinism level of the JavaScript UDF, if defined.DETERMINISTIC: The determinism level of the JavaScript UDF, if defined.NOT_DETERMINISTIC: The determinism level of the JavaScript UDF, if defined.
Default: 0
Example: DeterminismLevels.DETERMINISTIC
StrictMode : Boolean
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.
Default: True
Example: true
ImportedLibrary : ImportedLibraryParameters[]
If Input.Language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. (Optional)
Default: -
Example: [ { foo }, { bar } ]
Argument : ArgumentParameters[]
Argument(s) of a function or a stored procedure.
Default: -
Example: [ { x, IN, INT64, FIXED_TYPE }, { y, OUT, INT64, FIXED_TYPE }, { 'not set', 'not set', INT64, 'not set' } ]
SetRemoteFunctionParameters : Boolean
Set remote function specific options.
Default: False
Example: false
RemoteConnection : String
Fully qualified name of the user-provided connection object which holds the authentication information to send requests to the remote service.
Default: -
Example: projects/{projectId}/locations/{locationId}/connections/{connectionId}
RemoteEndpoint : String
Endpoint of the user-provided remote service.
Default: -
Example: https://us-east1-my_gcf_project.cloudfunctions.net/remote_add
RemoteMaxBatchingRows : Int64
Max number of rows in each batch sent to the remote service.
If 0, BigQuery dynamically decides the number of rows in a batch.
Default: -
Example: 0
RemoteUserDefinedContext : UserDefinedContext[]
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.
Default: -
Example: [ { foo, bar }, { foo2, bar2 } ]
TableId : String
Table ID.
Default: -
Example: tableid
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
Url : String
URL to new dataset or table resource. New routine return an empty string.
Example: true
ErrorMessage : String
Error message.
Example: Error occured...
Task Changelog
Changelog for Task Frends.GoogleBigQuery.CreateResource.
[1.0.0] - 2023-09-12
Added
Initial implementation
Last updated
Was this helpful?