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

AdminProjectsLocationsReservations

class AdminProjectsLocationsReservations extends Resource (View source)

The "reservations" collection of methods.

Typical usage is:

 $pubsubliteService = new Google\Service\PubsubLite(...);
 $reservations = $pubsubliteService->admin_projects_locations_reservations;

Methods

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

Creates a new reservation. (reservations.create)

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

Deletes the specified reservation. (reservations.delete)

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

Returns the reservation configuration. (reservations.get)

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

Returns the list of reservations for the given project.

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

Updates properties of the specified reservation. (reservations.patch)

Details

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

Creates a new reservation. (reservations.create)

Parameters

string $parent

Required. The parent location in which to create the reservation. Structured like projects/{project_number}/locations/{location}.
Reservation $postBody
array $optParams

Optional parameters.

Return Value

Reservation

Exceptions

Exception

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

Deletes the specified reservation. (reservations.delete)

Parameters

string $name

Required. The name of the reservation to delete. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
array $optParams

Optional parameters.

Return Value

PubsubliteEmpty

Exceptions

Exception

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

Returns the reservation configuration. (reservations.get)

Parameters

string $name

Required. The name of the reservation whose configuration to return. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
array $optParams

Optional parameters.

Return Value

Reservation

Exceptions

Exception

at line 105
ListReservationsResponse listAdminProjectsLocationsReservations(string $parent, array $optParams = [])

Returns the list of reservations for the given project.

(reservations.listAdminProjectsLocationsReservations)

Parameters

string $parent

Required. The parent whose reservations are to be listed. Structured like projects/{project_number}/locations/{location}.
array $optParams

Optional parameters.

Return Value

ListReservationsResponse

Exceptions

Exception

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

Updates properties of the specified reservation. (reservations.patch)

Parameters

string $name

The name of the reservation. Structured like: projects/{project_number}/locations/{location}/reservations/{reservation_id}
Reservation $postBody
array $optParams

Optional parameters.

Return Value

Reservation

Exceptions

Exception