Routine (BigQuery API v2 (Rev. 459) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.bigquery.model.Routine

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Routine
extends com.google.api.client.json.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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Routine()

Constructors
Constructor and Description
`Routine()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Routine`	`clone()`
`java.util.List<Argument>`	`getArguments()` Optional.
`java.lang.Long`	`getCreationTime()` Output only.
`java.lang.String`	`getDefinitionBody()` Required.
`java.lang.String`	`getDescription()` Optional.
`java.lang.String`	`getEtag()` Output only.
`java.util.List<java.lang.String>`	`getImportedLibraries()` Optional.
`java.lang.String`	`getLanguage()` Optional.
`java.lang.Long`	`getLastModifiedTime()` Output only.
`StandardSqlDataType`	`getReturnType()` Optional if language = "SQL"; required otherwise.
`RoutineReference`	`getRoutineReference()` Required.
`java.lang.String`	`getRoutineType()` Required.
`Routine`	`set(java.lang.String fieldName, java.lang.Object value)`
`Routine`	`setArguments(java.util.List<Argument> arguments)` Optional.
`Routine`	`setCreationTime(java.lang.Long creationTime)` Output only.
`Routine`	`setDefinitionBody(java.lang.String definitionBody)` Required.
`Routine`	`setDescription(java.lang.String description)` Optional.
`Routine`	`setEtag(java.lang.String etag)` Output only.
`Routine`	`setImportedLibraries(java.util.List<java.lang.String> importedLibraries)` Optional.
`Routine`	`setLanguage(java.lang.String language)` Optional.
`Routine`	`setLastModifiedTime(java.lang.Long lastModifiedTime)` Output only.
`Routine`	`setReturnType(StandardSqlDataType returnType)` Optional if language = "SQL"; required otherwise.
`Routine`	`setRoutineReference(RoutineReference routineReference)` Required.
`Routine`	`setRoutineType(java.lang.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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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 java.util.List<Argument> getArguments()
```
    Optional.
    
    Returns:
    
    value or null for none
  - setArguments
```
public Routine setArguments(java.util.List<Argument> arguments)
```
    Optional.
    
    Parameters:
    
    arguments - arguments or null for none
  - getCreationTime
```
public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.String getDescription()
```
    Optional. [Experimental] The description of the routine if defined.
    
    Returns:
    
    value or null for none
  - setDescription
```
public Routine setDescription(java.lang.String description)
```
    Optional. [Experimental] The description of the routine if defined.
    
    Parameters:
    
    description - description or null for none
  - getEtag
```
public java.lang.String getEtag()
```
    Output only. A hash of this resource.
    
    Returns:
    
    value or null for none
  - setEtag
```
public Routine setEtag(java.lang.String etag)
```
    Output only. A hash of this resource.
    
    Parameters:
    
    etag - etag or null for none
  - getImportedLibraries
```
public java.util.List<java.lang.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(java.util.List<java.lang.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 java.lang.String getLanguage()
```
    Optional. Defaults to "SQL".
    
    Returns:
    
    value or null for none
  - setLanguage
```
public Routine setLanguage(java.lang.String language)
```
    Optional. Defaults to "SQL".
    
    Parameters:
    
    language - language or null for none
  - getLastModifiedTime
```
public java.lang.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(java.lang.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 java.lang.String getRoutineType()
```
    Required. The type of routine.
    
    Returns:
    
    value or null for none
  - setRoutineType
```
public Routine setRoutineType(java.lang.String routineType)
```
    Required. The type of routine.
    
    Parameters:
    
    routineType - routineType or null for none
  - set
```
public Routine set(java.lang.String fieldName,
                   java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Routine clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

BigQuery API v2 (revision 459)

Class Routine

Nested Class Summary

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

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Routine

Method Detail

getArguments

setArguments

getCreationTime

setCreationTime

getDefinitionBody

setDefinitionBody

getDescription

setDescription

getEtag

setEtag

getImportedLibraries

setImportedLibraries

getLanguage

setLanguage

getLastModifiedTime

setLastModifiedTime

getReturnType

setReturnType

getRoutineReference

setRoutineReference

getRoutineType

setRoutineType

set

clone