docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/bigquery_v2.routines.html b/docs/dyn/bigquery_v2.routines.html
index 91364b2..229ee52 100644
--- a/docs/dyn/bigquery_v2.routines.html
+++ b/docs/dyn/bigquery_v2.routines.html
@@ -84,7 +84,7 @@
<code><a href="#insert">insert(projectId, datasetId, body=None)</a></code></p>
<p class="firstline">Creates a new routine in the dataset.</p>
<p class="toc_element">
- <code><a href="#list">list(projectId, datasetId, filter=None, pageToken=None, maxResults=None, readMask=None)</a></code></p>
+ <code><a href="#list">list(projectId, datasetId, readMask=None, filter=None, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">Lists all routines in the specified dataset. Requires the READER dataset</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -119,49 +119,13 @@
An object of the form:
{ # A user-defined function or a stored procedure.
- "routineType": "A String", # Required. The type of routine.
- "description": "A String", # Optional. [Experimental] The description of the routine if defined.
- "language": "A String", # Optional. Defaults to "SQL".
- "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
- # the epoch.
- "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
+ "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
# imported JAVASCRIPT libraries.
- "A String",
+ "A String",
],
- "routineReference": { # Required. Reference describing the ID of this routine.
- "projectId": "A String", # [Required] The ID of the project containing this routine.
- "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
- },
- "etag": "A String", # Output only. A hash of this resource.
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- },
- "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
- "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
- "mode": "A String", # Optional. Specifies whether the argument is input or output.
- # Can be set for procedures only.
- },
- ],
- "returnType": { # The type of a variable, e.g., a function argument. # Optional if language = "SQL"; required otherwise.
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
+ # since the epoch.
+ "returnType": { # The type of a variable, e.g., a function argument. # 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
@@ -175,7 +139,7 @@
#
# * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));`
#
- # The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and
+ # 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
@@ -184,26 +148,27 @@
# Then the inferred return type of `Increment` is automatically changed to
# INT64 at query time, while the return type of `Decrement` remains FLOAT64.
# Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
+ # INT64: {type_kind="INT64"}
+ # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
# STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
+ # {type_kind="STRUCT",
# struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
+ # {name="x", type={type_kind="STRING"}},
+ # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
# ]}}
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
# Object with schema name: StandardSqlField
],
},
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field.
+ # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
- "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
- # since the epoch.
- "definitionBody": "A String", # Required. The body of the routine.
+ "language": "A String", # Optional. Defaults to "SQL".
+ "description": "A String", # Optional. [Experimental] The description of the routine if defined.
+ "etag": "A String", # Output only. A hash of this resource.
+ "definitionBody": "A String", # Required. The body of the routine.
#
# For functions, this is the expression in the AS clause.
#
@@ -211,21 +176,56 @@
# parentheses. For example, for the function created with the following
# statement:
#
- # `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))`
+ # `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
+ # 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'`
+ # `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'`
#
# The definition_body is
#
- # `return "\n";\n`
+ # `return "\n";\n`
#
# Note that both \n are replaced with linebreaks.
+ "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
+ # the epoch.
+ "routineType": "A String", # Required. The type of routine.
+ "routineReference": { # Required. Reference describing the ID of this routine.
+ "projectId": "A String", # [Required] The ID of the project containing this routine.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
+ "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
+ },
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
+ "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
+ "mode": "A String", # Optional. Specifies whether the argument is input or output.
+ # Can be set for procedures only.
+ "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
+ # Examples:
+ # INT64: {type_kind="INT64"}
+ # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
+ # STRUCT<x STRING, y ARRAY<DATE>>:
+ # {type_kind="STRUCT",
+ # struct_type={fields=[
+ # {name="x", type={type_kind="STRING"}},
+ # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
+ # ]}}
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
+ ],
+ },
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field.
+ # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ },
+ ],
}</pre>
</div>
@@ -240,49 +240,13 @@
The object takes the form of:
{ # A user-defined function or a stored procedure.
- "routineType": "A String", # Required. The type of routine.
- "description": "A String", # Optional. [Experimental] The description of the routine if defined.
- "language": "A String", # Optional. Defaults to "SQL".
- "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
- # the epoch.
- "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
+ "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
# imported JAVASCRIPT libraries.
- "A String",
+ "A String",
],
- "routineReference": { # Required. Reference describing the ID of this routine.
- "projectId": "A String", # [Required] The ID of the project containing this routine.
- "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
- },
- "etag": "A String", # Output only. A hash of this resource.
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- },
- "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
- "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
- "mode": "A String", # Optional. Specifies whether the argument is input or output.
- # Can be set for procedures only.
- },
- ],
- "returnType": { # The type of a variable, e.g., a function argument. # Optional if language = "SQL"; required otherwise.
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
+ # since the epoch.
+ "returnType": { # The type of a variable, e.g., a function argument. # 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
@@ -296,7 +260,7 @@
#
# * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));`
#
- # The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and
+ # 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
@@ -305,26 +269,27 @@
# Then the inferred return type of `Increment` is automatically changed to
# INT64 at query time, while the return type of `Decrement` remains FLOAT64.
# Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
+ # INT64: {type_kind="INT64"}
+ # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
# STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
+ # {type_kind="STRUCT",
# struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
+ # {name="x", type={type_kind="STRING"}},
+ # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
# ]}}
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
# Object with schema name: StandardSqlField
],
},
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field.
+ # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
- "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
- # since the epoch.
- "definitionBody": "A String", # Required. The body of the routine.
+ "language": "A String", # Optional. Defaults to "SQL".
+ "description": "A String", # Optional. [Experimental] The description of the routine if defined.
+ "etag": "A String", # Output only. A hash of this resource.
+ "definitionBody": "A String", # Required. The body of the routine.
#
# For functions, this is the expression in the AS clause.
#
@@ -332,21 +297,56 @@
# parentheses. For example, for the function created with the following
# statement:
#
- # `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))`
+ # `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
+ # 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'`
+ # `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'`
#
# The definition_body is
#
- # `return "\n";\n`
+ # `return "\n";\n`
#
# Note that both \n are replaced with linebreaks.
+ "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
+ # the epoch.
+ "routineType": "A String", # Required. The type of routine.
+ "routineReference": { # Required. Reference describing the ID of this routine.
+ "projectId": "A String", # [Required] The ID of the project containing this routine.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
+ "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
+ },
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
+ "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
+ "mode": "A String", # Optional. Specifies whether the argument is input or output.
+ # Can be set for procedures only.
+ "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
+ # Examples:
+ # INT64: {type_kind="INT64"}
+ # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
+ # STRUCT<x STRING, y ARRAY<DATE>>:
+ # {type_kind="STRUCT",
+ # struct_type={fields=[
+ # {name="x", type={type_kind="STRING"}},
+ # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
+ # ]}}
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
+ ],
+ },
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field.
+ # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ },
+ ],
}
@@ -354,49 +354,13 @@
An object of the form:
{ # A user-defined function or a stored procedure.
- "routineType": "A String", # Required. The type of routine.
- "description": "A String", # Optional. [Experimental] The description of the routine if defined.
- "language": "A String", # Optional. Defaults to "SQL".
- "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
- # the epoch.
- "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
+ "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
# imported JAVASCRIPT libraries.
- "A String",
+ "A String",
],
- "routineReference": { # Required. Reference describing the ID of this routine.
- "projectId": "A String", # [Required] The ID of the project containing this routine.
- "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
- },
- "etag": "A String", # Output only. A hash of this resource.
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- },
- "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
- "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
- "mode": "A String", # Optional. Specifies whether the argument is input or output.
- # Can be set for procedures only.
- },
- ],
- "returnType": { # The type of a variable, e.g., a function argument. # Optional if language = "SQL"; required otherwise.
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
+ # since the epoch.
+ "returnType": { # The type of a variable, e.g., a function argument. # 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
@@ -410,7 +374,7 @@
#
# * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));`
#
- # The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and
+ # 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
@@ -419,26 +383,27 @@
# Then the inferred return type of `Increment` is automatically changed to
# INT64 at query time, while the return type of `Decrement` remains FLOAT64.
# Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
+ # INT64: {type_kind="INT64"}
+ # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
# STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
+ # {type_kind="STRUCT",
# struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
+ # {name="x", type={type_kind="STRING"}},
+ # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
# ]}}
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
# Object with schema name: StandardSqlField
],
},
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field.
+ # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
- "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
- # since the epoch.
- "definitionBody": "A String", # Required. The body of the routine.
+ "language": "A String", # Optional. Defaults to "SQL".
+ "description": "A String", # Optional. [Experimental] The description of the routine if defined.
+ "etag": "A String", # Output only. A hash of this resource.
+ "definitionBody": "A String", # Required. The body of the routine.
#
# For functions, this is the expression in the AS clause.
#
@@ -446,99 +411,97 @@
# parentheses. For example, for the function created with the following
# statement:
#
- # `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))`
+ # `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
+ # 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'`
+ # `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'`
#
# The definition_body is
#
- # `return "\n";\n`
+ # `return "\n";\n`
#
# Note that both \n are replaced with linebreaks.
+ "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
+ # the epoch.
+ "routineType": "A String", # Required. The type of routine.
+ "routineReference": { # Required. Reference describing the ID of this routine.
+ "projectId": "A String", # [Required] The ID of the project containing this routine.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
+ "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
+ },
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
+ "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
+ "mode": "A String", # Optional. Specifies whether the argument is input or output.
+ # Can be set for procedures only.
+ "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
+ # Examples:
+ # INT64: {type_kind="INT64"}
+ # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
+ # STRUCT<x STRING, y ARRAY<DATE>>:
+ # {type_kind="STRUCT",
+ # struct_type={fields=[
+ # {name="x", type={type_kind="STRING"}},
+ # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
+ # ]}}
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
+ ],
+ },
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field.
+ # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ },
+ ],
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(projectId, datasetId, filter=None, pageToken=None, maxResults=None, readMask=None)</code>
+ <code class="details" id="list">list(projectId, datasetId, readMask=None, filter=None, pageToken=None, maxResults=None)</code>
<pre>Lists all routines in the specified dataset. Requires the READER dataset
role.
Args:
projectId: string, Required. Project ID of the routines to list (required)
datasetId: string, Required. Dataset ID of the routines to list (required)
- filter: string, If set, then only the Routines matching this filter are returned.
-The current supported form is either "routine_type:<RoutineType>" or
-"routineType:<RoutineType>", where <RoutineType> is a RoutineType enum.
-Example: "routineType:SCALAR_FUNCTION".
- pageToken: string, Page token, returned by a previous call, to request the next page of
-results
- maxResults: integer, The maximum number of results to return in a single response page.
-Leverage the page tokens to iterate through the entire collection.
readMask: string, If set, then only the Routine fields in the field mask, as well as
project_id, dataset_id and routine_id, are returned in the response.
If unset, then the following Routine fields are returned:
etag, project_id, dataset_id, routine_id, routine_type, creation_time,
last_modified_time, and language.
+ filter: string, If set, then only the Routines matching this filter are returned.
+The current supported form is either "routine_type:<RoutineType>" or
+"routineType:<RoutineType>", where <RoutineType> is a RoutineType enum.
+Example: "routineType:SCALAR_FUNCTION".
+ pageToken: string, Page token, returned by a previous call, to request the next page of
+results
+ maxResults: integer, The maximum number of results to return in a single response page.
+Leverage the page tokens to iterate through the entire collection.
Returns:
An object of the form:
{
- "nextPageToken": "A String", # A token to request the next page of results.
- "routines": [ # Routines in the requested dataset. Unless read_mask is set in the request,
+ "routines": [ # Routines in the requested dataset. Unless read_mask is set in the request,
# only the following fields are populated:
# etag, project_id, dataset_id, routine_id, routine_type, creation_time,
# last_modified_time, and language.
{ # A user-defined function or a stored procedure.
- "routineType": "A String", # Required. The type of routine.
- "description": "A String", # Optional. [Experimental] The description of the routine if defined.
- "language": "A String", # Optional. Defaults to "SQL".
- "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
- # the epoch.
- "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
+ "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
# imported JAVASCRIPT libraries.
- "A String",
+ "A String",
],
- "routineReference": { # Required. Reference describing the ID of this routine.
- "projectId": "A String", # [Required] The ID of the project containing this routine.
- "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
- },
- "etag": "A String", # Output only. A hash of this resource.
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- },
- "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
- "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
- "mode": "A String", # Optional. Specifies whether the argument is input or output.
- # Can be set for procedures only.
- },
- ],
- "returnType": { # The type of a variable, e.g., a function argument. # Optional if language = "SQL"; required otherwise.
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
+ # since the epoch.
+ "returnType": { # The type of a variable, e.g., a function argument. # 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
@@ -552,7 +515,7 @@
#
# * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));`
#
- # The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and
+ # 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
@@ -561,26 +524,27 @@
# Then the inferred return type of `Increment` is automatically changed to
# INT64 at query time, while the return type of `Decrement` remains FLOAT64.
# Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
+ # INT64: {type_kind="INT64"}
+ # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
# STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
+ # {type_kind="STRUCT",
# struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
+ # {name="x", type={type_kind="STRING"}},
+ # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
# ]}}
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
# Object with schema name: StandardSqlField
],
},
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field.
+ # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
- "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
- # since the epoch.
- "definitionBody": "A String", # Required. The body of the routine.
+ "language": "A String", # Optional. Defaults to "SQL".
+ "description": "A String", # Optional. [Experimental] The description of the routine if defined.
+ "etag": "A String", # Output only. A hash of this resource.
+ "definitionBody": "A String", # Required. The body of the routine.
#
# For functions, this is the expression in the AS clause.
#
@@ -588,23 +552,59 @@
# parentheses. For example, for the function created with the following
# statement:
#
- # `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))`
+ # `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
+ # 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'`
+ # `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'`
#
# The definition_body is
#
- # `return "\n";\n`
+ # `return "\n";\n`
#
# Note that both \n are replaced with linebreaks.
+ "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
+ # the epoch.
+ "routineType": "A String", # Required. The type of routine.
+ "routineReference": { # Required. Reference describing the ID of this routine.
+ "projectId": "A String", # [Required] The ID of the project containing this routine.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
+ "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
+ },
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
+ "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
+ "mode": "A String", # Optional. Specifies whether the argument is input or output.
+ # Can be set for procedures only.
+ "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
+ # Examples:
+ # INT64: {type_kind="INT64"}
+ # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
+ # STRUCT<x STRING, y ARRAY<DATE>>:
+ # {type_kind="STRUCT",
+ # struct_type={fields=[
+ # {name="x", type={type_kind="STRING"}},
+ # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
+ # ]}}
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
+ ],
+ },
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field.
+ # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ },
+ ],
},
],
+ "nextPageToken": "A String", # A token to request the next page of results.
}</pre>
</div>
@@ -617,7 +617,7 @@
previous_response: The response from the request for the previous page. (required)
Returns:
- A request object that you can call 'execute()' on to request the next
+ A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
@@ -635,49 +635,13 @@
The object takes the form of:
{ # A user-defined function or a stored procedure.
- "routineType": "A String", # Required. The type of routine.
- "description": "A String", # Optional. [Experimental] The description of the routine if defined.
- "language": "A String", # Optional. Defaults to "SQL".
- "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
- # the epoch.
- "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
+ "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
# imported JAVASCRIPT libraries.
- "A String",
+ "A String",
],
- "routineReference": { # Required. Reference describing the ID of this routine.
- "projectId": "A String", # [Required] The ID of the project containing this routine.
- "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
- },
- "etag": "A String", # Output only. A hash of this resource.
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- },
- "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
- "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
- "mode": "A String", # Optional. Specifies whether the argument is input or output.
- # Can be set for procedures only.
- },
- ],
- "returnType": { # The type of a variable, e.g., a function argument. # Optional if language = "SQL"; required otherwise.
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
+ # since the epoch.
+ "returnType": { # The type of a variable, e.g., a function argument. # 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
@@ -691,7 +655,7 @@
#
# * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));`
#
- # The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and
+ # 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
@@ -700,26 +664,27 @@
# Then the inferred return type of `Increment` is automatically changed to
# INT64 at query time, while the return type of `Decrement` remains FLOAT64.
# Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
+ # INT64: {type_kind="INT64"}
+ # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
# STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
+ # {type_kind="STRUCT",
# struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
+ # {name="x", type={type_kind="STRING"}},
+ # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
# ]}}
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
# Object with schema name: StandardSqlField
],
},
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field.
+ # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
- "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
- # since the epoch.
- "definitionBody": "A String", # Required. The body of the routine.
+ "language": "A String", # Optional. Defaults to "SQL".
+ "description": "A String", # Optional. [Experimental] The description of the routine if defined.
+ "etag": "A String", # Output only. A hash of this resource.
+ "definitionBody": "A String", # Required. The body of the routine.
#
# For functions, this is the expression in the AS clause.
#
@@ -727,21 +692,56 @@
# parentheses. For example, for the function created with the following
# statement:
#
- # `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))`
+ # `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
+ # 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'`
+ # `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'`
#
# The definition_body is
#
- # `return "\n";\n`
+ # `return "\n";\n`
#
# Note that both \n are replaced with linebreaks.
+ "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
+ # the epoch.
+ "routineType": "A String", # Required. The type of routine.
+ "routineReference": { # Required. Reference describing the ID of this routine.
+ "projectId": "A String", # [Required] The ID of the project containing this routine.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
+ "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
+ },
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
+ "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
+ "mode": "A String", # Optional. Specifies whether the argument is input or output.
+ # Can be set for procedures only.
+ "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
+ # Examples:
+ # INT64: {type_kind="INT64"}
+ # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
+ # STRUCT<x STRING, y ARRAY<DATE>>:
+ # {type_kind="STRUCT",
+ # struct_type={fields=[
+ # {name="x", type={type_kind="STRING"}},
+ # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
+ # ]}}
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
+ ],
+ },
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field.
+ # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ },
+ ],
}
@@ -749,49 +749,13 @@
An object of the form:
{ # A user-defined function or a stored procedure.
- "routineType": "A String", # Required. The type of routine.
- "description": "A String", # Optional. [Experimental] The description of the routine if defined.
- "language": "A String", # Optional. Defaults to "SQL".
- "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
- # the epoch.
- "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
+ "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the
# imported JAVASCRIPT libraries.
- "A String",
+ "A String",
],
- "routineReference": { # Required. Reference describing the ID of this routine.
- "projectId": "A String", # [Required] The ID of the project containing this routine.
- "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
- "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
- },
- "etag": "A String", # Output only. A hash of this resource.
- "arguments": [ # Optional.
- { # Input/output argument of a function or a stored procedure.
- "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
- # Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
- # STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
- # struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
- # ]}}
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
- # Object with schema name: StandardSqlField
- ],
- },
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
- },
- "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
- "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
- "mode": "A String", # Optional. Specifies whether the argument is input or output.
- # Can be set for procedures only.
- },
- ],
- "returnType": { # The type of a variable, e.g., a function argument. # Optional if language = "SQL"; required otherwise.
+ "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
+ # since the epoch.
+ "returnType": { # The type of a variable, e.g., a function argument. # 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
@@ -805,7 +769,7 @@
#
# * `CREATE FUNCTION Decrement(x FLOAT64) RETURNS FLOAT64 AS (Add(x, -1));`
#
- # The return_type is `{type_kind: "FLOAT64"}` for `Add` and `Decrement`, and
+ # 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
@@ -814,26 +778,27 @@
# Then the inferred return type of `Increment` is automatically changed to
# INT64 at query time, while the return type of `Decrement` remains FLOAT64.
# Examples:
- # INT64: {type_kind="INT64"}
- # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
+ # INT64: {type_kind="INT64"}
+ # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
# STRUCT<x STRING, y ARRAY<DATE>>:
- # {type_kind="STRUCT",
+ # {type_kind="STRUCT",
# struct_type={fields=[
- # {name="x", type={type_kind="STRING"}},
- # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
+ # {name="x", type={type_kind="STRING"}},
+ # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
# ]}}
- "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
- "fields": [
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
# Object with schema name: StandardSqlField
],
},
- "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
- "typeKind": "A String", # Required. The top level type of this field.
- # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field.
+ # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
},
- "lastModifiedTime": "A String", # Output only. The time when this routine was last modified, in milliseconds
- # since the epoch.
- "definitionBody": "A String", # Required. The body of the routine.
+ "language": "A String", # Optional. Defaults to "SQL".
+ "description": "A String", # Optional. [Experimental] The description of the routine if defined.
+ "etag": "A String", # Output only. A hash of this resource.
+ "definitionBody": "A String", # Required. The body of the routine.
#
# For functions, this is the expression in the AS clause.
#
@@ -841,21 +806,56 @@
# parentheses. For example, for the function created with the following
# statement:
#
- # `CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y))`
+ # `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
+ # 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'`
+ # `CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n'`
#
# The definition_body is
#
- # `return "\n";\n`
+ # `return "\n";\n`
#
# Note that both \n are replaced with linebreaks.
+ "creationTime": "A String", # Output only. The time when this routine was created, in milliseconds since
+ # the epoch.
+ "routineType": "A String", # Required. The type of routine.
+ "routineReference": { # Required. Reference describing the ID of this routine.
+ "projectId": "A String", # [Required] The ID of the project containing this routine.
+ "datasetId": "A String", # [Required] The ID of the dataset containing this routine.
+ "routineId": "A String", # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
+ },
+ "arguments": [ # Optional.
+ { # Input/output argument of a function or a stored procedure.
+ "name": "A String", # Optional. The name of this argument. Can be absent for function return argument.
+ "argumentKind": "A String", # Optional. Defaults to FIXED_TYPE.
+ "mode": "A String", # Optional. Specifies whether the argument is input or output.
+ # Can be set for procedures only.
+ "dataType": { # The type of a variable, e.g., a function argument. # Required unless argument_kind = ANY_TYPE.
+ # Examples:
+ # INT64: {type_kind="INT64"}
+ # ARRAY<STRING>: {type_kind="ARRAY", array_element_type="STRING"}
+ # STRUCT<x STRING, y ARRAY<DATE>>:
+ # {type_kind="STRUCT",
+ # struct_type={fields=[
+ # {name="x", type={type_kind="STRING"}},
+ # {name="y", type={type_kind="ARRAY", array_element_type="DATE"}}
+ # ]}}
+ "structType": { # The fields of this struct, in order, if type_kind = "STRUCT".
+ "fields": [
+ # Object with schema name: StandardSqlField
+ ],
+ },
+ "arrayElementType": # Object with schema name: StandardSqlDataType # The type of the array's elements, if type_kind = "ARRAY".
+ "typeKind": "A String", # Required. The top level type of this field.
+ # Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").
+ },
+ },
+ ],
}</pre>
</div>