Class Routine.Builder (2.20.2)

Version 2.20.2

• 2.44.0 (latest)
• 2.43.3
• 2.42.3
• 2.41.0
• 2.40.3
• 2.39.1
• 2.38.2
• 2.37.2
• 2.36.0
• 2.35.0
• 2.34.2
• 2.33.2

public static class Routine.Builder extends RoutineInfo.Builder

Inheritance

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

Inherited Members

RoutineInfo.Builder.build()

RoutineInfo.Builder.setArguments(List<RoutineArgument>)

RoutineInfo.Builder.setBody(String)

RoutineInfo.Builder.setDeterminismLevel(String)

RoutineInfo.Builder.setImportedLibraries(List<String>)

RoutineInfo.Builder.setLanguage(String)

RoutineInfo.Builder.setRemoteFunctionOptions(RemoteFunctionOptions)

RoutineInfo.Builder.setReturnTableType(StandardSQLTableType)

RoutineInfo.Builder.setReturnType(StandardSQLDataType)

RoutineInfo.Builder.setRoutineType(String)

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Methods

build()

public Routine build()

Creates a RoutineInfo object.

Returns

Type	Description
Routine

Overrides

RoutineInfo.Builder.build()

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

RoutineInfo.Builder.setArguments(List<RoutineArgument> argumentList)

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

RoutineInfo.Builder.setBody(String body)

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

RoutineInfo.Builder.setDeterminismLevel(String determinismLevel)

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

RoutineInfo.Builder.setImportedLibraries(List<String> importedLibrariesList)

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

RoutineInfo.Builder.setLanguage(String language)

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

RoutineInfo.Builder.setRemoteFunctionOptions(RemoteFunctionOptions remoteFunctionOptions)

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

RoutineInfo.Builder.setReturnTableType(StandardSQLTableType returnTableType)

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

RoutineInfo.Builder.setReturnType(StandardSQLDataType returnType)

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

RoutineInfo.Builder.setRoutineType(String routineType)