Get a reservation group

Retrieves a specific reservation group resource from the BigQuery Reservation API by its name.

Code sample

Node.js

Before trying this sample, follow the Node.js setup instructions in the BigQuery quickstart using client libraries. For more information, see the BigQuery Node.js API reference documentation.

To authenticate to BigQuery, set up Application Default Credentials. For more information, see Set up authentication for client libraries.

const {ReservationServiceClient} =
  require('@google-cloud/bigquery-reservation').v1;
const {status} = require('@grpc/grpc-js');

const client = new ReservationServiceClient();

/**
 * Gets the specified reservation group.
 *
 * A reservation group is a container for reservations.
 *
 * @param projectId Google Cloud Project ID, for example 'example-project-id'.
 * @param location Google Cloud Location, for example 'us-central1'.
 * @param reservationGroupId the ID of the reservation group to get, for example 'example-reservation-group-id'.
 */
async function getReservationGroup(
  projectId,
  location = 'us-central1',
  reservationGroupId = 'example-group-reservation',
) {
  const request = {
    name: client.reservationGroupPath(projectId, location, reservationGroupId),
  };

  try {
    const [reservationGroup] = await client.getReservationGroup(request);
    console.log(`Got reservation group: ${reservationGroup.name}`);
  } catch (err) {
    if (err.code === status.NOT_FOUND) {
      console.log(
        `Reservation group '${reservationGroupId}' not found in project '${projectId}' at location '${location}'.`,
      );
    } else {
      console.error(
        `Error getting reservation group '${reservationGroupId}':`,
        err,
      );
    }
  }
}

Python

Before trying this sample, follow the Python setup instructions in the BigQuery quickstart using client libraries. For more information, see the BigQuery Python API reference documentation.

To authenticate to BigQuery, set up Application Default Credentials. For more information, see Set up authentication for client libraries.

from google.api_core import exceptions
from google.cloud import bigquery_reservation_v1


client = bigquery_reservation_v1.ReservationServiceClient()


def get_reservation_group(project_id: str, location: str, reservation_group_id: str):
    """Gets information about a reservation group.

    A reservation group is a container for reservations.

    Args:
        project_id: The Google Cloud project ID.
        location: The geographic location of the reservation group, for example, us-central1.
        reservation_group_id: The ID of the reservation group to retrieve.
    """
    name = client.reservation_group_path(project_id, location, reservation_group_id)

    try:
        reservation_group = client.get_reservation_group(name=name)
        print(f"Retrieved reservation group: {reservation_group.name}")
    except exceptions.NotFound:
        print(f"Reservation group '{name}' not found.")

What's next

To search and filter code samples for other Google Cloud products, see the Google Cloud sample browser.