RoutineArgs class

The set of arguments for Routine. The set of arguments for Routine.

Constructors

RoutineArgs({Input<List<RoutineArgument>?>? arguments, Input<String?>? dataGovernanceType, required Input<String> datasetId, required Input<String> definitionBody, Input<String?>? deletionPolicy, Input<String?>? description, Input<String?>? determinismLevel, Input<RoutineExternalRuntimeOptions?>? externalRuntimeOptions, Input<List<String>?>? importedLibraries, Input<String?>? language, Input<String?>? project, Input<RoutinePythonOptions?>? pythonOptions, Input<RoutineRemoteFunctionOptions?>? remoteFunctionOptions, Input<String?>? returnTableType, Input<String?>? returnType, required Input<String> routineId, required Input<String> routineType, Input<String?>? securityMode, Input<RoutineSparkOptions?>? sparkOptions})
Creates a new RoutineArgs. arguments Input/output argument of a function or a stored procedure. dataGovernanceType If set to DATA_MASKING, the function is validated and made available as a masking function. For more information, see https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask datasetId The ID of the dataset containing this routine definitionBody The body of the routine. For functions, this is the expression in the AS clause. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. description The description of the routine if defined. determinismLevel The determinism level of the JavaScript UDF if defined. externalRuntimeOptions (Optional, Beta) importedLibraries Optional. If language = "JAVASCRIPT", this field stores the path of the language The language of the routine. project The ID of the project in which the resource belongs. pythonOptions (Optional, Beta) remoteFunctionOptions Remote function specific options. returnTableType Optional. Can be set only if routineType = "TABLE_VALUED_FUNCTION". returnType A JSON schema for the return type. Optional if language = "SQL"; required otherwise. routineId The ID of the the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. routineType The type of routine. securityMode Optional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine's configuration. sparkOptions Optional. If language is one of "PYTHON", "JAVA", "SCALA", this field stores the options for spark stored procedure.
const
RoutineArgs.fromMap(Map<String, dynamic> map)
factory

Properties

arguments → Input<List<RoutineArgument>?>?
Input/output argument of a function or a stored procedure. Structure is documented below.
final
dataGovernanceType → Input<String?>?
If set to DATA_MASKING, the function is validated and made available as a masking function. For more information, see https://cloud.google.com/bigquery/docs/user-defined-functions#custom-mask Possible values are: DATA_MASKING.
final
datasetId → Input<String>
The ID of the dataset containing this routine
final
definitionBody → Input<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.
final
deletionPolicy → Input<String?>?
Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
final
description → Input<String?>?
The description of the routine if defined.
final
determinismLevel → Input<String?>?
The determinism level of the JavaScript UDF if defined. Possible values are: DETERMINISM_LEVEL_UNSPECIFIED, DETERMINISTIC, NOT_DETERMINISTIC.
final
externalRuntimeOptions → Input<RoutineExternalRuntimeOptions?>?
(Optional, Beta) Options for the runtime of the external system. This field is only applicable for Python UDFs. Structure is documented below.
final
hashCode → int
The hash code for this object.
no setterinherited
importedLibraries → Input<List<String>?>?
Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.
final
language → Input<String?>?
The language of the routine. Possible values are: SQL, JAVASCRIPT, PYTHON, JAVA, SCALA.
final
project → Input<String?>?
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
final
pythonOptions → Input<RoutinePythonOptions?>?
(Optional, Beta) Options for a user-defined Python function. Structure is documented below.
final
remoteFunctionOptions → Input<RoutineRemoteFunctionOptions?>?
Remote function specific options. Structure is documented below.
final
returnTableType → Input<String?>?
Optional. Can be set only if routineType = "TABLE_VALUED_FUNCTION". If absent, the return table type is inferred from definitionBody at query time in each query that references this routine. If present, then the columns in the evaluated table result will be cast to match the column types specificed in return table type, at query time.
final
returnType → Input<String?>?
A JSON schema for the return type. Optional if language = "SQL"; required otherwise. If absent, the return type is inferred from definitionBody 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. ~>NOTE: Because this field expects a JSON string, any changes to the string will create a diff, even if the JSON itself hasn't changed. If the API returns a different value for the same schema, e.g. it switche d the order of values or replaced STRUCT field type with RECORD field type, we currently cannot suppress the recurring diff this causes. As a workaround, we recommend using the schema as returned by the API.
final
routineId → Input<String>
The ID of the the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
final
routineType → Input<String>
The type of routine. Possible values are: SCALAR_FUNCTION, PROCEDURE, TABLE_VALUED_FUNCTION.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityMode → Input<String?>?
Optional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine's configuration. Possible values are: DEFINER, INVOKER.
final
sparkOptions → Input<RoutineSparkOptions?>?
Optional. If language is one of "PYTHON", "JAVA", "SCALA", this field stores the options for spark stored procedure. Structure is documented below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited