Class ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource
The "assignments" collection of methods.
Inheritance
Inherited Members
Namespace: Google.Apis.BigQueryReservation.v1
Assembly: Google.Apis.BigQueryReservation.v1.dll
Syntax
public class AssignmentsResourceConstructors
AssignmentsResource(IClientService)
Constructs a new resource.
Declaration
public AssignmentsResource(IClientService service)Parameters
| Type | Name | Description |
|---|---|---|
| Google.Apis.Services.IClientService | service |
Methods
Create(Assignment, String)
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.
Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.CreateRequest Create(Assignment body, string parent)Parameters
| Type | Name | Description |
|---|---|---|
| Assignment | body | The body of the request. |
| System.String | parent | Required. The parent resource name of the assignment E.g.
|
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.CreateRequest |
Delete(String)
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:
andIn this example, deletion of theassignment won't affect the other assignment. After said deletion, queries fromproject1will still useres1while queries fromproject2will switch to use on-demand mode.
Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.DeleteRequest Delete(string name)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | Required. Name of the resource, e.g.
|
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.DeleteRequest |
List(String)
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.
Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.ListRequest List(string parent)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | parent | Required. The parent resource name e.g.:
|
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.ListRequest |
Move(MoveAssignmentRequest, String)
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.
Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.MoveRequest Move(MoveAssignmentRequest body, string name)Parameters
| Type | Name | Description |
|---|---|---|
| MoveAssignmentRequest | body | The body of the request. |
| System.String | name | Required. The resource name of the assignment, e.g.
|
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.MoveRequest |
Patch(Assignment, String)
Updates an existing assignment. Only the priority field can be updated.
Declaration
public virtual ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.PatchRequest Patch(Assignment body, string name)Parameters
| Type | Name | Description |
|---|---|---|
| Assignment | body | The body of the request. |
| System.String | name | Output only. Name of the resource. E.g.:
|
Returns
| Type | Description |
|---|---|
| ProjectsResource.LocationsResource.ReservationsResource.AssignmentsResource.PatchRequest |