1. class
  2. Google
  3. \
  4. Service
  5. \
  6. BigQueryReservation
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsReservations

ProjectsLocationsReservations

class ProjectsLocationsReservations extends Resource (View source)

The "reservations" collection of methods.

Typical usage is:

 $bigqueryreservationService = new Google\Service\BigQueryReservation(...);
 $reservations = $bigqueryreservationService->projects_locations_reservations;

Methods

Reservation
create(string $parent, Reservation $postBody, array $optParams = [])

Creates a new reservation resource. (reservations.create)

BigqueryreservationEmpty
delete(string $name, array $optParams = [])

Deletes a reservation. Returns google.rpc.Code.FAILED_PRECONDITION when reservation has assignments. (reservations.delete)

Reservation
failoverReservation(string $name, FailoverReservationRequest $postBody, array $optParams = [])

Failover a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location will fail with the error code google.rpc.Code.FAILED_PRECONDITION. (reservations.failoverReservation)

Reservation
get(string $name, array $optParams = [])

Returns information about the reservation. (reservations.get)

ListReservationsResponse
listProjectsLocationsReservations(string $parent, array $optParams = [])

Lists all the reservations for the project in the specified location.

Reservation
patch(string $name, Reservation $postBody, array $optParams = [])

Updates an existing reservation resource. (reservations.patch)

Details

at line 49
Reservation create(string $parent, Reservation $postBody, array $optParams = [])

Creates a new reservation resource. (reservations.create)

Parameters

string $parent

Required. Project, location. E.g., projects/myproject/locations/US
Reservation $postBody
array $optParams

Optional parameters.

Return Value

Reservation

Exceptions

Exception

at line 65
BigqueryreservationEmpty delete(string $name, array $optParams = [])

Deletes a reservation. Returns google.rpc.Code.FAILED_PRECONDITION when reservation has assignments. (reservations.delete)

Parameters

string $name

Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod
array $optParams

Optional parameters.

Return Value

BigqueryreservationEmpty

Exceptions

Exception

at line 85
Reservation failoverReservation(string $name, FailoverReservationRequest $postBody, array $optParams = [])

Failover a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location will fail with the error code google.rpc.Code.FAILED_PRECONDITION. (reservations.failoverReservation)

Parameters

string $name

Required. Resource name of the reservation to failover. E.g., projects/myproject/locations/US/reservations/team1-prod
FailoverReservationRequest $postBody
array $optParams

Optional parameters.

Return Value

Reservation

Exceptions

Exception

at line 100
Reservation get(string $name, array $optParams = [])

Returns information about the reservation. (reservations.get)

Parameters

string $name

Required. Resource name of the reservation to retrieve. E.g., projects/myproject/locations/US/reservations/team1-prod
array $optParams

Optional parameters.

Return Value

Reservation

Exceptions

Exception

at line 120
ListReservationsResponse listProjectsLocationsReservations(string $parent, array $optParams = [])

Lists all the reservations for the project in the specified location.

(reservations.listProjectsLocationsReservations)

Parameters

string $parent

Required. The parent resource name containing project and location, e.g.: projects/myproject/locations/US
array $optParams

Optional parameters.

Return Value

ListReservationsResponse

Exceptions

Exception

at line 141
Reservation patch(string $name, Reservation $postBody, array $optParams = [])

Updates an existing reservation resource. (reservations.patch)

Parameters

string $name

The resource name of the reservation, e.g., projects/locations/reservations/team1-prod. The reservation_id must only contain lower case alphanumeric characters or dashes. It must start with a letter and must not end with a dash. Its maximum length is 64 characters.
Reservation $postBody
array $optParams

Optional parameters.

Return Value

Reservation

Exceptions

Exception