Метод UpdateBooking

Запрос

UpdateBookingRequest

Сообщение запроса содержит обновленное значение поля в записи о бронировании. Кроме того, в поле update_mask указываются пути всех полей записи о бронировании, которые требуется изменить. Например, в запросе, переносящем существующее бронирование на другое время, поле update_mask будет содержать следующие два пути:

  paths: "start_time"
  paths: "duration"

Более подробные сведения приведены в описании типа FieldMask.

Возвращаемое значение

UpdateBookingResponse

Канонические коды ошибок gRPC

• INVALID_ARGUMENT  – если указанный элемент FieldMask содержит недействительные значения или какое-либо из полей обновляемой записи Booking недействительно. Этот вариант используется и в случае, когда бизнес-логика не допускает обновления поля (например, отменять бронирование слишком поздно).
• NOT_FOUND – если указанный идентификатор записи о бронировании неизвестен.
• RESOURCE_EXHAUSTED – если временной интервал, соответствующий обновленному времени начала, недоступен для бронирования.

// Request to update a [ext.maps.booking.partner.v0.Booking]
export message UpdateBookingRequest {
  option features.(pb.java).nest_in_file_class = YES;

  // Field mask of all booking fields to be updated
  google.protobuf.FieldMask update_mask = 1;

  // The booking to be updated
  // The following fields can be set in a booking:
  // - status, to cancel a booking.
  // - start_time and duration to reschedule a booking.
  Booking booking = 2;
}

// Response with the updated [ext.maps.booking.partner.v0.Booking]
export message UpdateBookingResponse {
  option features.(pb.java).nest_in_file_class = YES;

  // The updated booking
  Booking booking = 1;

  // The updated user payment option originally used to pay for this booking.
  // This should be set if the UpdateBookingRequest results in a change to
  // the UserPaymentOption.
  // For instance, if the booking is canceled, the UserPaymentOption should
  // reflect an additional credit to the user. In the case of a multi-use
  // payment option, the current_count should be increased by one to
  // allow the user to create another booking with this payment option. In the
  // case of a single-use payment option, a new single-use user payment option
  // should be returned.
  UserPaymentOption user_payment_option = 2;
}