class ProjectsLocations extends Resource (View source)

The "locations" collection of methods.

Typical usage is:

 $bigqueryreservationService = new Google\Service\BigQueryReservation(...);
 $locations = $bigqueryreservationService->projects_locations;

Methods

getBiReservation(string $name, array $optParams = [])

Retrieves a BI reservation. (locations.getBiReservation)

searchAllAssignments(string $parent, array $optParams = [])

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).

searchAssignments(string $parent, array $optParams = [])

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).

updateBiReservation(string $name, BiReservation $postBody, array $optParams = [])

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

  1. In order to release BI capacity reservation size must be set to 0.

Details

BiReservation getBiReservation(string $name, array $optParams = [])

Retrieves a BI reservation. (locations.getBiReservation)

Parameters

string $name

Required. Name of the requested reservation, for example: projects/{project_id}/locations/{location_id}/biReservation

array $optParams

Optional parameters.

Return Value

BiReservation

Exceptions

Exception

SearchAllAssignmentsResponse searchAllAssignments(string $parent, array $optParams = [])

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. (locations.searchAllAssignments)

Parameters

string $parent

Required. The resource name with location (project name could be the wildcard '-'), e.g.: projects/-/locations/US.

array $optParams

Optional parameters.

Return Value

SearchAllAssignmentsResponse

Exceptions

Exception

SearchAssignmentsResponse searchAssignments(string $parent, array $optParams = [])

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. (locations.searchAssignments)

Parameters

string $parent

Required. The resource name of the admin project(containing project and location), e.g.: projects/myproject/locations/US.

array $optParams

Optional parameters.

Return Value

SearchAssignmentsResponse

Exceptions

Exception

BiReservation updateBiReservation(string $name, BiReservation $postBody, array $optParams = [])

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

  1. In order to release BI capacity reservation size must be set to 0.

(locations.updateBiReservation)

Parameters

string $name

The resource name of the singleton BI reservation. Reservation names have the form projects/{project_id}/locations/{location_id}/biReservation.

BiReservation $postBody
array $optParams

Optional parameters.

Return Value

BiReservation

Exceptions

Exception