Routine class

Creates a new routine in the dataset. Auto-naming is currently not supported for this resource.

Constructors

Routine(String name, {RoutineArgs? args, CustomResourceOptions? options})

Creates a new Routine. name The Pulumi resource name. args Arguments used to configure this Routine. The set of arguments for Routine. options Resource options controlling this resource's behavior.

Properties

arguments ↔ Output<List<Map<String, dynamic>>>

Optional.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

creationTime ↔ Output<String>

The time when this routine was created, in milliseconds since the epoch.

late, final

dataGovernanceType ↔ Output<String>

Optional. If set to DATA_MASKING, the function is validated and made available as a masking function. For more information, see Create custom masking routines.

late, final

datasetId ↔ Output<String>

late, final

definitionBody ↔ Output<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.

late, final

description ↔ Output<String>

Optional. The description of the routine, if defined.

late, final

determinismLevel ↔ Output<String>

Optional. The determinism level of the JavaScript UDF, if defined.

late, final

etag ↔ Output<String>

A hash of this resource.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

importedLibraries ↔ Output<List<String>>

Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.

late, final

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

language ↔ Output<String>

Optional. Defaults to "SQL" if remote_function_options field is absent, not set otherwise.

late, final

lastModifiedTime ↔ Output<String>

The time when this routine was last modified, in milliseconds since the epoch.

late, final

project ↔ Output<String>

late, final

remoteFunctionOptions ↔ Output<RemoteFunctionOptionsResponse>

Optional. Remote function specific options.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

returnTableType ↔ Output<StandardSqlTableTypeResponse>

Optional. Can be set only if routine_type = "TABLE_VALUED_FUNCTION". If absent, the return table type is inferred from definition_body 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 specified in return table type, at query time.

late, final

returnType ↔ Output<StandardSqlDataTypeResponse>

Optional if language = "SQL"; required otherwise. Cannot be set if routine_type = "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.

late, final

routineReference ↔ Output<RoutineReferenceResponse>

Reference describing the ID of this routine.

late, final

routineType ↔ Output<String>

The type of routine.

late, final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

securityMode ↔ Output<String>

Optional. The security mode of the routine, if defined. If not defined, the security mode is automatically determined from the routine's configuration.

late, final

sparkOptions ↔ Output<SparkOptionsResponse>

Optional. Spark specific options.

late, final

strictMode ↔ Output<bool>

Optional. 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.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited