روش UpdateBooking

درخواست

درخواست رزرو به‌روزرسانی

یک پیام درخواست شامل اطلاعات به‌روزرسانی‌شده در فیلد رزرو است و مسیرهای تمام فیلدهای رزرو که باید به‌روزرسانی شوند را در فیلد update_mask فهرست می‌کند. برای مثال، فیلد update_mask درخواستی که رزرو موجود را مجدداً برنامه‌ریزی می‌کند، شامل دو مسیر زیر است:

  paths: "start_time"
  paths: "duration"

برای اطلاعات بیشتر به FieldMask مراجعه کنید.

مقدار بازگشتی

به‌روزرسانی پاسخ رزرو

کدهای خطای gRPC کانونیکال

• INVALID_ARGUMENT اگر ماسک فیلد ارائه شده حاوی مقادیر نامعتبر باشد یا هر یک از فیلدهای رزرو به‌روزرسانی‌شده نامعتبر باشند. این شامل مواردی می‌شود که به‌روزرسانی فیلد طبق منطق کسب‌وکار مجاز نباشد، مثلاً به این دلیل که برای لغو خیلی دیر شده است.
• اگر شناسه رزرو ارائه شده ناشناخته باشد، NOT_FOUND می‌شود.
• RESOURCE_EXHAUSTED اگر بازه زمانی مربوط به زمان شروع به‌روزرسانی‌شده برای رزرو در دسترس نباشد.

// Request to update a [ext.maps.booking.partner.v0.Booking]
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]
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;
}