Report capacity commitments and reservations

List all capacity commitments and reservations in a particular project and location. Print the results to the Cloud Console.

Explore further

For detailed documentation that includes this code sample, see the following:

BigQuery Reservation API Client Libraries

Code sample

Go

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

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

  // The bigquery_reservation_quickstart application demonstrates usage of the 
 // BigQuery reservation API by enumerating some of the resources that can be 
 // associated with a cloud project. 
 package 
  
 main 
 import 
  
 ( 
  
 "bytes" 
  
 "context" 
  
 "flag" 
  
 "fmt" 
  
 "log" 
  
 reservation 
  
 "cloud.google.com/go/bigquery/reservation/apiv1" 
  
 "cloud.google.com/go/bigquery/reservation/apiv1/reservationpb" 
  
 "google.golang.org/api/iterator" 
 ) 
 func 
  
 main 
 () 
  
 { 
  
 // Define two command line flags for controlling the behavior of this quickstart. 
  
 var 
  
 ( 
  
 projectID 
  
 = 
  
 flag 
 . 
 String 
 ( 
 "project_id" 
 , 
  
 "" 
 , 
  
 "Cloud Project ID, used for session creation." 
 ) 
  
 location 
  
 = 
  
 flag 
 . 
 String 
 ( 
 "location" 
 , 
  
 "US" 
 , 
  
 "BigQuery location used for interactions." 
 ) 
  
 ) 
  
 // Parse flags and do some minimal validation. 
  
 flag 
 . 
 Parse 
 () 
  
 if 
  
 * 
 projectID 
  
 == 
  
 "" 
  
 { 
  
 log 
 . 
 Fatal 
 ( 
 "empty --project_id specified, please provide a valid project ID" 
 ) 
  
 } 
  
 if 
  
 * 
 location 
  
 == 
  
 "" 
  
 { 
  
 log 
 . 
 Fatal 
 ( 
 "empty --location specified, please provide a valid location" 
 ) 
  
 } 
  
 ctx 
  
 := 
  
 context 
 . 
 Background 
 () 
  
 bqResClient 
 , 
  
 err 
  
 := 
  
 reservation 
 . 
  NewClient 
 
 ( 
 ctx 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 log 
 . 
 Fatalf 
 ( 
 "NewClient: %v" 
 , 
  
 err 
 ) 
  
 } 
  
 defer 
  
 bqResClient 
 . 
  Close 
 
 () 
  
 s 
 , 
  
 err 
  
 := 
  
 reportCapacityCommitments 
 ( 
 ctx 
 , 
  
 bqResClient 
 , 
  
 * 
 projectID 
 , 
  
 * 
 location 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 log 
 . 
 Fatalf 
 ( 
 "printCapacityCommitments: %v" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Println 
 ( 
 s 
 ) 
  
 s 
 , 
  
 err 
  
 = 
  
 reportReservations 
 ( 
 ctx 
 , 
  
 bqResClient 
 , 
  
 * 
 projectID 
 , 
  
 * 
 location 
 ) 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 log 
 . 
 Fatalf 
 ( 
 "printReservations: %v" 
 , 
  
 err 
 ) 
  
 } 
  
 fmt 
 . 
 Println 
 ( 
 s 
 ) 
 } 
 // printCapacityCommitments iterates through the capacity commitments and returns a byte buffer with details. 
 func 
  
 reportCapacityCommitments 
 ( 
 ctx 
  
 context 
 . 
 Context 
 , 
  
 client 
  
 * 
 reservation 
 . 
  Client 
 
 , 
  
 projectID 
 , 
  
 location 
  
 string 
 ) 
  
 ( 
 string 
 , 
  
 error 
 ) 
  
 { 
  
 var 
  
 buf 
  
 bytes 
 . 
 Buffer 
  
 fmt 
 . 
 Fprintf 
 ( 
& buf 
 , 
  
 "Capacity commitments in project %s in location %s:\n" 
 , 
  
 projectID 
 , 
  
 location 
 ) 
  
 req 
  
 := 
  
& reservationpb 
 . 
 ListCapacityCommitmentsRequest 
 { 
  
 Parent 
 : 
  
 fmt 
 . 
 Sprintf 
 ( 
 "projects/%s/locations/%s" 
 , 
  
 projectID 
 , 
  
 location 
 ), 
  
 } 
  
 totalCommitments 
  
 := 
  
 0 
  
 it 
  
 := 
  
 client 
 . 
 ListCapacityCommitments 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 for 
  
 { 
  
 commitment 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 "" 
 , 
  
 err 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
& buf 
 , 
  
 "\tCommitment %s in state %s\n" 
 , 
  
 commitment 
 . 
 GetName 
 (), 
  
 commitment 
 . 
 GetState 
 (). 
 String 
 ()) 
  
 totalCommitments 
 ++ 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
& buf 
 , 
  
 "\n%d commitments processed.\n" 
 , 
  
 totalCommitments 
 ) 
  
 return 
  
 buf 
 . 
 String 
 (), 
  
 nil 
 } 
 // printReservations iterates through reservations defined in an admin project. 
 func 
  
 reportReservations 
 ( 
 ctx 
  
 context 
 . 
 Context 
 , 
  
 client 
  
 * 
 reservation 
 . 
  Client 
 
 , 
  
 projectID 
 , 
  
 location 
  
 string 
 ) 
  
 ( 
 string 
 , 
  
 error 
 ) 
  
 { 
  
 var 
  
 buf 
  
 bytes 
 . 
 Buffer 
  
 fmt 
 . 
 Fprintf 
 ( 
& buf 
 , 
  
 "Reservations in project %s in location %s:\n" 
 , 
  
 projectID 
 , 
  
 location 
 ) 
  
 req 
  
 := 
  
& reservationpb 
 . 
 ListReservationsRequest 
 { 
  
 Parent 
 : 
  
 fmt 
 . 
 Sprintf 
 ( 
 "projects/%s/locations/%s" 
 , 
  
 projectID 
 , 
  
 location 
 ), 
  
 } 
  
 totalReservations 
  
 := 
  
 0 
  
 it 
  
 := 
  
 client 
 . 
 ListReservations 
 ( 
 ctx 
 , 
  
 req 
 ) 
  
 for 
  
 { 
  
 reservation 
 , 
  
 err 
  
 := 
  
 it 
 . 
 Next 
 () 
  
 if 
  
 err 
  
 == 
  
 iterator 
 . 
 Done 
  
 { 
  
 break 
  
 } 
  
 if 
  
 err 
  
 != 
  
 nil 
  
 { 
  
 return 
  
 "" 
 , 
  
 err 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
& buf 
 , 
  
 "\tReservation %s has %d slot capacity.\n" 
 , 
  
 reservation 
 . 
 GetName 
 (), 
  
 reservation 
 . 
 GetSlotCapacity 
 ()) 
  
 totalReservations 
 ++ 
  
 } 
  
 fmt 
 . 
 Fprintf 
 ( 
& buf 
 , 
  
 "\n%d reservations processed.\n" 
 , 
  
 totalReservations 
 ) 
  
 return 
  
 buf 
 . 
 String 
 (), 
  
 nil 
 }

Java

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

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

  import 
  
 com.google.cloud.bigquery.reservation.v1. ReservationServiceClient 
 
 ; 
 import 
  
 java.io.IOException 
 ; 
 public 
  
 class 
 QuickstartSample 
  
 { 
  
 public 
  
 static 
  
 void 
  
 main 
 ( 
 String 
 ... 
  
 args 
 ) 
  
 throws 
  
 Exception 
  
 { 
  
 // TODO(developer): Replace these variables before running the sample. 
  
 String 
  
 projectId 
  
 = 
  
 "YOUR_PROJECT_ID" 
 ; 
  
 String 
  
 location 
  
 = 
  
 "LOCATION" 
 ; 
  
 quickStartSample 
 ( 
 projectId 
 , 
  
 location 
 ); 
  
 } 
  
 public 
  
 static 
  
 void 
  
 quickStartSample 
 ( 
 String 
  
 projectId 
 , 
  
 String 
  
 location 
 ) 
  
 throws 
  
 IOException 
  
 { 
  
 try 
  
 ( 
  ReservationServiceClient 
 
  
 client 
  
 = 
  
  ReservationServiceClient 
 
 . 
 create 
 ()) 
  
 { 
  
 // list reservations in the project 
  
 String 
  
 parent 
  
 = 
  
 String 
 . 
 format 
 ( 
 "projects/%s/locations/%s" 
 , 
  
 projectId 
 , 
  
 location 
 ); 
  
 client 
  
 . 
 listReservations 
 ( 
 parent 
 ) 
  
 . 
 iterateAll 
 () 
  
 . 
 forEach 
 ( 
 res 
  
 - 
>  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Reservation resource name: " 
  
 + 
  
 res 
 . 
 getName 
 ())); 
  
 // list capacity commitments in the project 
  
 client 
  
 . 
 listCapacityCommitments 
 ( 
 parent 
 ) 
  
 . 
 iterateAll 
 () 
  
 . 
 forEach 
 ( 
  
 commitment 
  
 - 
>  
 System 
 . 
 out 
 . 
 println 
 ( 
 "Capacity commitment resource name: " 
  
 + 
  
 commitment 
 . 
 getName 
 ())); 
  
 } 
  
 } 
 }

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 .

  // Imports the Google Cloud client library 
 const 
  
 { 
  
 ReservationServiceClient 
 , 
 } 
  
 = 
  
 require 
 ( 
 ' @google-cloud/bigquery-reservation 
' 
 ); 
 // Creates a client 
 const 
  
 client 
  
 = 
  
 new 
  
  ReservationServiceClient 
 
 (); 
 // project = 'my-project' // Project to list reservations for. 
 // location = 'US' // BigQuery location. 
 async 
  
 function 
  
 listReservations 
 () 
  
 { 
  
 const 
  
 [ 
 reservations 
 ] 
  
 = 
  
 await 
  
 client 
 . 
 listReservations 
 ({ 
  
 parent 
 : 
  
 `projects/ 
 ${ 
 project 
 } 
 /locations/ 
 ${ 
 location 
 } 
 ` 
 , 
  
 }); 
  
 console 
 . 
 info 
 ( 
 `found 
 ${ 
 reservations 
 . 
 length 
 } 
 reservations` 
 ); 
  
 console 
 . 
 info 
 ( 
 reservations 
 ); 
 } 
 async 
  
 function 
  
 listCapacityCommitments 
 () 
  
 { 
  
 const 
  
 [ 
 commitments 
 ] 
  
 = 
  
 await 
  
 client 
 . 
 listCapacityCommitments 
 ({ 
  
 parent 
 : 
  
 `projects/ 
 ${ 
 project 
 } 
 /locations/ 
 ${ 
 location 
 } 
 ` 
 , 
  
 }); 
  
 console 
 . 
 info 
 ( 
 `found 
 ${ 
 commitments 
 . 
 length 
 } 
 commitments` 
 ); 
  
 console 
 . 
 info 
 ( 
 commitments 
 ); 
 } 
 listReservations 
 (); 
 listCapacityCommitments 
 ();

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 .

  import 
  
 argparse 
 from 
  
 google.cloud 
  
 import 
  bigquery_reservation_v1 
 
 def 
  
 main 
 ( 
 project_id 
 : 
 str 
 = 
 "your-project-id" 
 , 
 location 
 : 
 str 
 = 
 "US" 
 , 
 transport 
 : 
 str 
 = 
 "grpc" 
 ) 
 - 
> None 
 : 
 # Constructs the client for interacting with the service. 
 client 
 = 
  bigquery_reservation_v1 
 
 . 
  ReservationServiceClient 
 
 ( 
 transport 
 = 
 transport 
 ) 
 report_reservations 
 ( 
 client 
 , 
 project_id 
 , 
 location 
 ) 
 def 
  
 report_reservations 
 ( 
 client 
 : 
  bigquery_reservation_v1 
 
 . 
  ReservationServiceClient 
 
 , 
 project_id 
 : 
 str 
 , 
 location 
 : 
 str 
 , 
 ) 
 - 
> None 
 : 
  
 """Prints details and summary information about reservations defined within 
 a given admin project and location. 
 """ 
 print 
 ( 
 "Reservations in project 
 {} 
 in location 
 {} 
 " 
 . 
 format 
 ( 
 project_id 
 , 
 location 
 )) 
 req 
 = 
  bigquery_reservation_v1 
 
 . 
  ListReservationsRequest 
 
 ( 
 parent 
 = 
 client 
 . 
  common_location_path 
 
 ( 
 project_id 
 , 
 location 
 ) 
 ) 
 total_reservations 
 = 
 0 
 for 
 reservation 
 in 
 client 
 . 
  list_reservations 
 
 ( 
 request 
 = 
 req 
 ): 
 print 
 ( 
 f 
 " 
 \t 
 Reservation 
 { 
 reservation 
 . 
 name 
 } 
 " 
 f 
 "has 
 { 
 reservation 
 . 
 slot_capacity 
 } 
 slot capacity." 
 ) 
 total_reservations 
 = 
 total_reservations 
 + 
 1 
 print 
 ( 
 f 
 " 
 \n 
 { 
 total_reservations 
 } 
 reservations processed." 
 ) 
 if 
 __name__ 
 == 
 "__main__" 
 : 
 parser 
 = 
 argparse 
 . 
 ArgumentParser 
 () 
 parser 
 . 
 add_argument 
 ( 
 "--project_id" 
 , 
 type 
 = 
 str 
 ) 
 parser 
 . 
 add_argument 
 ( 
 "--location" 
 , 
 default 
 = 
 "US" 
 , 
 type 
 = 
 str 
 ) 
 args 
 = 
 parser 
 . 
 parse_args 
 () 
 main 
 ( 
 project_id 
 = 
 args 
 . 
 project_id 
 , 
 location 
 = 
 args 
 . 
 location 
 )

What's next

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

Report capacity commitments and reservations Stay organized with collections Save and categorize content based on your preferences.

Explore further

Code sample

Go

Java

Node.js

Python

What's next

Report capacity commitments and reservations