• Home
• com.google.apis
• google-api-services-bigqueryreservation
• v1-rev20230326-2.0.0
• source code
• BigQueryReservation.Projects.Locations.Reservations.Assignments.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.Reservations.Assignments.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.Reservations.Assignments



java.lang.Object


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







Enclosing class:
BigQueryReservation.Projects.Locations.Reservations




public class BigQueryReservation.Projects.Locations.Reservations.Assignments
extends Object
The "assignments" collection of methods.











Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


class 
BigQueryReservation.Projects.Locations.Reservations.Assignments.Create 


class 
BigQueryReservation.Projects.Locations.Reservations.Assignments.Delete 


class 
BigQueryReservation.Projects.Locations.Reservations.Assignments.List 


class 
BigQueryReservation.Projects.Locations.Reservations.Assignments.Move 


class 
BigQueryReservation.Projects.Locations.Reservations.Assignments.Patch 









Constructor Summary

Constructors 

Constructor and Description


Assignments() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BigQueryReservation.Projects.Locations.Reservations.Assignments.Create
create(String parent,
      Assignment content)
Creates an assignment object which allows the given project to submit jobs of a certain type
 using slots from the specified reservation.



BigQueryReservation.Projects.Locations.Reservations.Assignments.Delete
delete(String name)
Deletes a assignment.



BigQueryReservation.Projects.Locations.Reservations.Assignments.List
list(String parent)
Lists assignments.



BigQueryReservation.Projects.Locations.Reservations.Assignments.Move
move(String name,
    MoveAssignmentRequest content)
Moves an assignment under a new reservation.



BigQueryReservation.Projects.Locations.Reservations.Assignments.Patch
patch(String name,
     Assignment content)
Updates an existing assignment.







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














Constructor Detail





Assignments
public Assignments()









Method Detail





create
public BigQueryReservation.Projects.Locations.Reservations.Assignments.Create create(String parent,
                                                                                     Assignment content)
                                                                              throws IOException
Creates an assignment object which allows the given project to submit jobs of a certain type
 using slots from the specified reservation. Currently a resource (project, folder, organization)
 can only have one assignment per each (job_type, location) combination, and that reservation will
 be used for all jobs of the matching type. Different assignments can be created on different
 levels of the projects, folders or organization hierarchy. During query execution, the assignment
 is looked up at the project, folder and organization levels in that order. The first assignment
 found is applied to the query. When creating assignments, it does not matter if other assignments
 exist at higher levels. Example: * The organization `organizationA` contains two projects,
 `project1` and `project2`. * Assignments for all three entities (`organizationA`, `project1`, and
 `project2`) could all be created and mapped to the same or different reservations. "None"
 assignments represent an absence of the assignment. Projects assigned to None use on-demand
 pricing. To create a "None" assignment, use "none" as a reservation_id in the parent. Example
 parent: `projects/myproject/locations/US/reservations/none`. Returns
 `google.rpc.Code.PERMISSION_DENIED` if user does not have 'bigquery.admin' permissions on the
 project using the reservation and the project that owns this reservation. Returns
 `google.rpc.Code.INVALID_ARGUMENT` when location of the assignment does not match location of the
 reservation.

 Create a request for the method "assignments.create".

 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 parent resource name of the assignment E.g.
        `projects/myproject/locations/US/reservations/team1-prod`
content - the Assignment
Returns:
the request
Throws:
IOException








delete
public BigQueryReservation.Projects.Locations.Reservations.Assignments.Delete delete(String name)
                                                                              throws IOException
Deletes a assignment. No expansion will happen. Example: * Organization `organizationA` contains
 two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously.
 * CreateAssignment was used previously to define the following associations between entities and
 reservations: `` and `` In this example, deletion of the `` assignment won't affect the other
 assignment ``. After said deletion, queries from `project1` will still use `res1` while queries
 from `project2` will switch to use on-demand mode.

 Create a request for the method "assignments.delete".

 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 resource, e.g.
        `projects/myproject/locations/US/reservations/team1-prod/assignments/123`
Returns:
the request
Throws:
IOException








list
public BigQueryReservation.Projects.Locations.Reservations.Assignments.List list(String parent)
                                                                          throws IOException
Lists assignments. Only explicitly created assignments will be returned. Example: * Organization
 `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and
 was created previously. * CreateAssignment was used previously to define the following
 associations between entities and reservations: `` and `` In this example, ListAssignments will
 just return the above two assignments for reservation `res1`, and no expansion/merge will happen.
 The wildcard "-" can be used for reservations in the request. In that case all assignments
 belongs to the specified project and location will be listed. **Note** "-" cannot be used for
 projects nor locations.

 Create a request for the method "assignments.list".

 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 parent resource name e.g.: `projects/myproject/locations/US/reservations/team1-prod`
        Or: `projects/myproject/locations/US/reservations/-`
Returns:
the request
Throws:
IOException








move
public BigQueryReservation.Projects.Locations.Reservations.Assignments.Move move(String name,
                                                                                 MoveAssignmentRequest content)
                                                                          throws IOException
Moves an assignment under a new reservation. This differs from removing an existing assignment
 and recreating a new one by providing a transactional change that ensures an assignee always has
 an associated reservation.

 Create a request for the method "assignments.move".

 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. The resource name of the assignment, e.g.
        `projects/myproject/locations/US/reservations/team1-prod/assignments/123`
content - the MoveAssignmentRequest
Returns:
the request
Throws:
IOException








patch
public BigQueryReservation.Projects.Locations.Reservations.Assignments.Patch patch(String name,
                                                                                   Assignment content)
                                                                            throws IOException
Updates an existing assignment. Only the `priority` field can be updated.

 Create a request for the method "assignments.patch".

 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 - Output only. Name of the resource. E.g.:
        `projects/myproject/locations/US/reservations/team1-prod/assignments/123`. The
        assignment_id must only contain lower case alphanumeric characters or dashes and the max
        length is 64 characters.
content - the Assignment
Returns:
the request
Throws:
IOException














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.