Class Routine.Builder (2.41.0)

public static class Routine.Builder extends RoutineInfo.Builder

Inheritance

java.lang.Object > RoutineInfo.Builder > Routine.Builder

Methods

build()

public Routine build()

Creates a RoutineInfo object.

Returns
Type Description
Routine
Overrides

setArguments(List<RoutineArgument> arguments)

public Routine.Builder setArguments(List<RoutineArgument> arguments)

Specifies the list of input/output arguments for the routine.

Parameter
Name Description
arguments List<RoutineArgument>
Returns
Type Description
Routine.Builder
Overrides

setBody(String body)

public Routine.Builder setBody(String body)

Required. 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, " ", y))

The definitionBody is concat(x, " ", y) ( 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 " "; '

The definitionBody is

return " ";

Note that both are replaced with linebreaks.

Parameter
Name Description
body String
Returns
Type Description
Routine.Builder
Overrides

setDataGovernanceType(String dataGovernanceType)

public Routine.Builder setDataGovernanceType(String dataGovernanceType)

Sets the data governance type for the Builder (e.g. DATA_MASKING).

See https://cloud.google.com/bigquery/docs/reference/rest/v2/routines

Parameter
Name Description
dataGovernanceType String
Returns
Type Description
Routine.Builder
Overrides

setDescription(String description)

public Routine.Builder setDescription(String description)
Parameter
Name Description
description String
Returns
Type Description
Routine.Builder

setDeterminismLevel(String determinismLevel)

public Routine.Builder setDeterminismLevel(String determinismLevel)

Sets the JavaScript UDF determinism levels (e.g. DETERMINISM_LEVEL_UNSPECIFIED, DETERMINISTIC, NOT_DETERMINISTIC) only applicable to Javascript UDFs.

Parameter
Name Description
determinismLevel String
Returns
Type Description
Routine.Builder
Overrides

setImportedLibraries(List<String> libraries)

public Routine.Builder setImportedLibraries(List<String> libraries)

Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries as a list of gs:// URLs.

Parameter
Name Description
libraries List<String>
Returns
Type Description
Routine.Builder
Overrides

setLanguage(String language)

public Routine.Builder setLanguage(String language)

Sets the language for the routine (e.g. SQL or JAVASCRIPT)

Parameter
Name Description
language String
Returns
Type Description
Routine.Builder
Overrides

setRemoteFunctionOptions(RemoteFunctionOptions remoteFunctionOptions)

public Routine.Builder setRemoteFunctionOptions(RemoteFunctionOptions remoteFunctionOptions)

Optional. Remote function specific options.

Parameter
Name Description
remoteFunctionOptions RemoteFunctionOptions
Returns
Type Description
Routine.Builder
Overrides

setReturnTableType(StandardSQLTableType returnTableType)

public Routine.Builder setReturnTableType(StandardSQLTableType returnTableType)

Optional. Set only if Routine is a "TABLE_VALUED_FUNCTION".

Parameter
Name Description
returnTableType StandardSQLTableType
Returns
Type Description
Routine.Builder
Overrides

setReturnType(StandardSQLDataType returnType)

public Routine.Builder setReturnType(StandardSQLDataType returnType)

Sets the return type of the routine.

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.

Parameter
Name Description
returnType StandardSQLDataType
Returns
Type Description
Routine.Builder
Overrides

setRoutineType(String routineType)

public Routine.Builder setRoutineType(String routineType)

Sets the routine type for the Builder (e.g. SCALAR_FUNCTION).

See https://cloud.google.com/bigquery/docs/reference/rest/v2/routines

Parameter
Name Description
routineType String
Returns
Type Description
Routine.Builder
Overrides