Class RoutineReference (3.21.0)

RoutineReference()

A pointer to a routine.

Properties

str: ID of dataset containing the routine.

str: URL path for the routine's APIs.

str: ID of the project containing the routine.

str: The routine ID.

__eq__(other)

Two RoutineReferences are equal if they point to the same routine.

__str__()

String representation of the reference.

This is a fully-qualified ID, including the project ID and dataset ID.

from_api_repr(
    resource: dict,
) -> google.cloud.bigquery.routine.routine.RoutineReference

Factory: construct a routine reference given its API representation.

Parameter
Name	Description
`resource`	`Dict[str, object]` Routine reference representation returned from the API.

Returns
Type	Description
`google.cloud.bigquery.routine.RoutineReference`	Routine reference parsed from `resource`.

from_string(
    routine_id: str, default_project: typing.Optional[str] = None
) -> google.cloud.bigquery.routine.routine.RoutineReference

Factory: construct a routine reference from routine ID string.

Parameters
Name	Description
`routine_id`	`str` A routine ID in standard SQL format. If `default_project` is not specified, this must included a project ID, dataset ID, and routine ID, each separated by `.`.
`default_project`	`Optional[str]` The project ID to use when `routine_id` does not include a project ID.

Exceptions
Type	Description
`ValueError`	If `routine_id` is not a fully-qualified routine ID in standard SQL format.

Returns
Type	Description
`google.cloud.bigquery.routine.RoutineReference`	Routine reference parsed from `routine_id`.

to_api_repr() -> dict

Construct the API resource representation of this routine reference.

Returns
Type	Description
`Dict[str, object]`	Routine reference represented as an API resource.