target.apidocs.com.google.api.services.bigquery.model.Routine.html Maven / Gradle / Ivy

Go to download







Routine (BigQuery API v2-rev20201022-1.30.10)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.bigquery.model
Class Routine



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.bigquery.model.Routine













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class Routine
extends GenericJson
A user-defined function or a stored procedure.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the BigQuery API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary




Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


Routine() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Routine
clone() 


List<Argument>
getArguments()
Optional.



Long
getCreationTime()
Output only.



String
getDefinitionBody()
Required.



String
getDescription()
Optional.



String
getDeterminismLevel()
Optional.



String
getEtag()
Output only.



List<String>
getImportedLibraries()
Optional.



String
getLanguage()
Optional.



Long
getLastModifiedTime()
Output only.



StandardSqlDataType
getReturnType()
Optional if language = "SQL"; required otherwise.



RoutineReference
getRoutineReference()
Required.



String
getRoutineType()
Required.



Routine
set(String fieldName,
   Object value) 


Routine
setArguments(List<Argument> arguments)
Optional.



Routine
setCreationTime(Long creationTime)
Output only.



Routine
setDefinitionBody(String definitionBody)
Required.



Routine
setDescription(String description)
Optional.



Routine
setDeterminismLevel(String determinismLevel)
Optional.



Routine
setEtag(String etag)
Output only.



Routine
setImportedLibraries(List<String> importedLibraries)
Optional.



Routine
setLanguage(String language)
Optional.



Routine
setLastModifiedTime(Long lastModifiedTime)
Output only.



Routine
setReturnType(StandardSqlDataType returnType)
Optional if language = "SQL"; required otherwise.



Routine
setRoutineReference(RoutineReference routineReference)
Required.



Routine
setRoutineType(String routineType)
Required.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





Routine
public Routine()









Method Detail





getArguments
public List<Argument> getArguments()
Optional.

Returns:
value or null for none








setArguments
public Routine setArguments(List<Argument> arguments)
Optional.

Parameters:
arguments - arguments or null for none








getCreationTime
public Long getCreationTime()
Output only. The time when this routine was created, in milliseconds since the epoch.

Returns:
value or null for none








setCreationTime
public Routine setCreationTime(Long creationTime)
Output only. The time when this routine was created, in milliseconds since the epoch.

Parameters:
creationTime - creationTime or null for none








getDefinitionBody
public String getDefinitionBody()
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, "\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.

Returns:
value or null for none








setDefinitionBody
public Routine setDefinitionBody(String definitionBody)
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, "\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.

Parameters:
definitionBody - definitionBody or null for none








getDescription
public String getDescription()
Optional. [Experimental] The description of the routine if defined.

Returns:
value or null for none








setDescription
public Routine setDescription(String description)
Optional. [Experimental] The description of the routine if defined.

Parameters:
description - description or null for none








getDeterminismLevel
public String getDeterminismLevel()
Optional. [Experimental] The determinism level of the JavaScript UDF if defined.

Returns:
value or null for none








setDeterminismLevel
public Routine setDeterminismLevel(String determinismLevel)
Optional. [Experimental] The determinism level of the JavaScript UDF if defined.

Parameters:
determinismLevel - determinismLevel or null for none








getEtag
public String getEtag()
Output only. A hash of this resource.

Returns:
value or null for none








setEtag
public Routine setEtag(String etag)
Output only. A hash of this resource.

Parameters:
etag - etag or null for none








getImportedLibraries
public List<String> getImportedLibraries()
Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT
 libraries.

Returns:
value or null for none








setImportedLibraries
public Routine setImportedLibraries(List<String> importedLibraries)
Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT
 libraries.

Parameters:
importedLibraries - importedLibraries or null for none








getLanguage
public String getLanguage()
Optional. Defaults to "SQL".

Returns:
value or null for none








setLanguage
public Routine setLanguage(String language)
Optional. Defaults to "SQL".

Parameters:
language - language or null for none








getLastModifiedTime
public Long getLastModifiedTime()
Output only. The time when this routine was last modified, in milliseconds since the epoch.

Returns:
value or null for none








setLastModifiedTime
public Routine setLastModifiedTime(Long lastModifiedTime)
Output only. The time when this routine was last modified, in milliseconds since the epoch.

Parameters:
lastModifiedTime - lastModifiedTime or null for none








getReturnType
public StandardSqlDataType getReturnType()
Optional if language = "SQL"; required otherwise. 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.

Returns:
value or null for none








setReturnType
public Routine setReturnType(StandardSqlDataType returnType)
Optional if language = "SQL"; required otherwise. 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.

Parameters:
returnType - returnType or null for none








getRoutineReference
public RoutineReference getRoutineReference()
Required. Reference describing the ID of this routine.

Returns:
value or null for none








setRoutineReference
public Routine setRoutineReference(RoutineReference routineReference)
Required. Reference describing the ID of this routine.

Parameters:
routineReference - routineReference or null for none








getRoutineType
public String getRoutineType()
Required. The type of routine.

Returns:
value or null for none








setRoutineType
public Routine setRoutineType(String routineType)
Required. The type of routine.

Parameters:
routineType - routineType or null for none








set
public Routine set(String fieldName,
                   Object value)

Overrides:
set in class GenericJson








clone
public Routine clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.

Modifier and Type	Method and Description
`Routine`	`clone()`
`List<Argument>`	`getArguments()` Optional.
`Long`	`getCreationTime()` Output only.
`String`	`getDefinitionBody()` Required.
`String`	`getDescription()` Optional.
`String`	`getDeterminismLevel()` Optional.
`String`	`getEtag()` Output only.
`List<String>`	`getImportedLibraries()` Optional.
`String`	`getLanguage()` Optional.
`Long`	`getLastModifiedTime()` Output only.
`StandardSqlDataType`	`getReturnType()` Optional if language = "SQL"; required otherwise.
`RoutineReference`	`getRoutineReference()` Required.
`String`	`getRoutineType()` Required.
`Routine`	`set(String fieldName, Object value)`
`Routine`	`setArguments(List<Argument> arguments)` Optional.
`Routine`	`setCreationTime(Long creationTime)` Output only.
`Routine`	`setDefinitionBody(String definitionBody)` Required.
`Routine`	`setDescription(String description)` Optional.
`Routine`	`setDeterminismLevel(String determinismLevel)` Optional.
`Routine`	`setEtag(String etag)` Output only.
`Routine`	`setImportedLibraries(List<String> importedLibraries)` Optional.
`Routine`	`setLanguage(String language)` Optional.
`Routine`	`setLastModifiedTime(Long lastModifiedTime)` Output only.
`Routine`	`setReturnType(StandardSqlDataType returnType)` Optional if language = "SQL"; required otherwise.
`Routine`	`setRoutineReference(RoutineReference routineReference)` Required.
`Routine`	`setRoutineType(String routineType)` Required.