• Home
• com.google.apis
• google-api-services-bigqueryreservation
• v1-rev20230326-2.0.0
• source code
• BigQueryReservation.Projects.Locations.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.bigqueryreservation.v1.BigQueryReservation.Projects.Locations.html Maven / Gradle / Ivy

Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.bigqueryreservation.v1
Class BigQueryReservation.Projects.Locations



java.lang.Object


com.google.api.services.bigqueryreservation.v1.BigQueryReservation.Projects.Locations







Enclosing class:
BigQueryReservation.Projects




public class BigQueryReservation.Projects.Locations
extends Object
The "locations" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
BigQueryReservation.Projects.Locations.CapacityCommitments
The "capacityCommitments" collection of methods.



class 
BigQueryReservation.Projects.Locations.GetBiReservation 


class 
BigQueryReservation.Projects.Locations.Reservations
The "reservations" collection of methods.



class 
BigQueryReservation.Projects.Locations.SearchAllAssignments 


class 
BigQueryReservation.Projects.Locations.SearchAssignments 


class 
BigQueryReservation.Projects.Locations.UpdateBiReservation 









Constructor Summary

Constructors 

Constructor and Description


Locations() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BigQueryReservation.Projects.Locations.CapacityCommitments
capacityCommitments()
An accessor for creating requests from the CapacityCommitments collection.



BigQueryReservation.Projects.Locations.GetBiReservation
getBiReservation(String name)
Retrieves a BI reservation.



BigQueryReservation.Projects.Locations.Reservations
reservations()
An accessor for creating requests from the Reservations collection.



BigQueryReservation.Projects.Locations.SearchAllAssignments
searchAllAssignments(String parent)
Looks up assignments for a specified resource for a particular region.



BigQueryReservation.Projects.Locations.SearchAssignments
searchAssignments(String parent)
Deprecated: Looks up assignments for a specified resource for a particular region.



BigQueryReservation.Projects.Locations.UpdateBiReservation
updateBiReservation(String name,
                   BiReservation content)
Updates a BI reservation.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





Locations
public Locations()









Method Detail





getBiReservation
public BigQueryReservation.Projects.Locations.GetBiReservation getBiReservation(String name)
                                                                         throws IOException
Retrieves a BI reservation.

 Create a request for the method "locations.getBiReservation".

 This request holds the parameters needed by the bigqueryreservation server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
name - Required. Name of the requested reservation, for example:
        `projects/{project_id}/locations/{location_id}/biReservation`
Returns:
the request
Throws:
IOException








searchAllAssignments
public BigQueryReservation.Projects.Locations.SearchAllAssignments searchAllAssignments(String parent)
                                                                                 throws IOException
Looks up assignments for a specified resource for a particular region. If the request is about a
 project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise
 assignments created on the closest ancestor will be returned. 3. Assignments for different
 JobTypes will all be returned. The same logic applies if the request is about a folder. If the
 request is about an organization, then assignments created on the organization will be returned
 (organization doesn't have ancestors). Comparing to ListAssignments, there are some behavior
 differences: 1. permission on the assignee will be verified in this API. 2. Hierarchy lookup
 (project->folder->organization) happens in this API. 3. Parent here is `projects/locations`,
 instead of `projects/locationsreservations`.

 Create a request for the method "locations.searchAllAssignments".

 This request holds the parameters needed by the bigqueryreservation server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
parent - Required. The resource name with location (project name could be the wildcard '-'), e.g.:
        `projects/-/locations/US`.
Returns:
the request
Throws:
IOException








searchAssignments
public BigQueryReservation.Projects.Locations.SearchAssignments searchAssignments(String parent)
                                                                           throws IOException
Deprecated: Looks up assignments for a specified resource for a particular region. If the request
 is about a project: 1. Assignments created on the project will be returned if they exist. 2.
 Otherwise assignments created on the closest ancestor will be returned. 3. Assignments for
 different JobTypes will all be returned. The same logic applies if the request is about a folder.
 If the request is about an organization, then assignments created on the organization will be
 returned (organization doesn't have ancestors). Comparing to ListAssignments, there are some
 behavior differences: 1. permission on the assignee will be verified in this API. 2. Hierarchy
 lookup (project->folder->organization) happens in this API. 3. Parent here is
 `projects/locations`, instead of `projects/locationsreservations`. **Note** "-" cannot be used
 for projects nor locations.

 Create a request for the method "locations.searchAssignments".

 This request holds the parameters needed by the bigqueryreservation server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
parent - Required. The resource name of the admin project(containing project and location), e.g.:
        `projects/myproject/locations/US`.
Returns:
the request
Throws:
IOException








updateBiReservation
public BigQueryReservation.Projects.Locations.UpdateBiReservation updateBiReservation(String name,
                                                                                      BiReservation content)
                                                                               throws IOException
Updates a BI reservation. Only fields specified in the `field_mask` are updated. A singleton BI
 reservation always exists with default size 0. In order to reserve BI capacity it needs to be
 updated to an amount greater than 0. In order to release BI capacity reservation size must be set
 to 0.

 Create a request for the method "locations.updateBiReservation".

 This request holds the parameters needed by the bigqueryreservation server.  After setting any
 optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote
 operation.

Parameters:
name - The resource name of the singleton BI reservation. Reservation names have the form
        `projects/{project_id}/locations/{location_id}/biReservation`.
content - the BiReservation
Returns:
the request
Throws:
IOException








capacityCommitments
public BigQueryReservation.Projects.Locations.CapacityCommitments capacityCommitments()
An accessor for creating requests from the CapacityCommitments collection.

 
The typical use is:
 
    BigQueryReservation bigqueryreservation = new BigQueryReservation(...);
    BigQueryReservation.CapacityCommitments.List request = bigqueryreservation.capacityCommitments().list(parameters ...)
 

Returns:
the resource collection








reservations
public BigQueryReservation.Projects.Locations.Reservations reservations()
An accessor for creating requests from the Reservations collection.

 
The typical use is:
 
    BigQueryReservation bigqueryreservation = new BigQueryReservation(...);
    BigQueryReservation.Reservations.List request = bigqueryreservation.reservations().list(parameters ...)
 

Returns:
the resource collection














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2023 Google. All rights reserved.