Class RoutineServiceClient (2.31.0-rc)

RoutineService provides management access to BigQuery routines.

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

RoutineServiceClient(RoutineServiceClient const &)

Copy and move support

Parameter
Name	Description
	`RoutineServiceClient const &`

RoutineServiceClient(RoutineServiceClient &&)

Copy and move support

Parameter
Name	Description
	`RoutineServiceClient &&`

RoutineServiceClient(std::shared_ptr< RoutineServiceConnection >, Options)

Parameters
Name	Description
`connection`	`std::shared_ptr< RoutineServiceConnection >`
`opts`	`Options`

Operators

operator=(RoutineServiceClient const &)

Copy and move support

Parameter
Name	Description
	`RoutineServiceClient const &`

Returns
Type	Description
`RoutineServiceClient &`

operator=(RoutineServiceClient &&)

Copy and move support

Parameter
Name	Description
	`RoutineServiceClient &&`

Returns
Type	Description
`RoutineServiceClient &`

Functions

GetRoutine(google::cloud::bigquery::v2::GetRoutineRequest const &, Options)

Gets the specified routine resource by routine ID.

Parameters
Name	Description
`request`	`google::cloud::bigquery::v2::GetRoutineRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.v2.GetRoutineRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::v2::Routine >`	the result of the RPC. The response message type (google.cloud.bigquery.v2.Routine) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

InsertRoutine(google::cloud::bigquery::v2::InsertRoutineRequest const &, Options)

Creates a new routine in the dataset.

Parameters
Name	Description
`request`	`google::cloud::bigquery::v2::InsertRoutineRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.v2.InsertRoutineRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::v2::Routine >`	the result of the RPC. The response message type (google.cloud.bigquery.v2.Routine) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

UpdateRoutine(google::cloud::bigquery::v2::UpdateRoutineRequest const &, Options)

Updates information in an existing routine.

The update method replaces the entire Routine resource.

Parameters
Name	Description
`request`	`google::cloud::bigquery::v2::UpdateRoutineRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.v2.UpdateRoutineRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::v2::Routine >`	the result of the RPC. The response message type (google.cloud.bigquery.v2.Routine) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

PatchRoutine(google::cloud::bigquery::v2::PatchRoutineRequest const &, Options)

Patches information in an existing routine.

The patch method does a partial update to an existing Routine resource.

Parameters
Name	Description
`request`	`google::cloud::bigquery::v2::PatchRoutineRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.v2.PatchRoutineRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::v2::Routine >`	the result of the RPC. The response message type (google.cloud.bigquery.v2.Routine) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.

DeleteRoutine(google::cloud::bigquery::v2::DeleteRoutineRequest const &, Options)

Deletes the routine specified by routineId from the dataset.

Parameters
Name	Description
`request`	`google::cloud::bigquery::v2::DeleteRoutineRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.v2.DeleteRoutineRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`Status`	a `Status` object. If the request failed, the status contains the details of the failure.

ListRoutines(google::cloud::bigquery::v2::ListRoutinesRequest const &, Options)

Lists all routines in the specified dataset.

Requires the READER dataset role.

Parameters
Name	Description
`request`	`google::cloud::bigquery::v2::ListRoutinesRequest const &` Unary RPCs, such as the one wrapped by this function, receive a single `request` proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.bigquery.v2.ListRoutinesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
`opts`	`Options` Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
`StatusOr< google::cloud::bigquery::v2::ListRoutinesResponse >`	the result of the RPC. The response message type (google.cloud.bigquery.v2.ListRoutinesResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the `StatusOr` contains the error details.