الحصول على إصدارات محددة من الموارد

يحتوي كل مورد على حقل إصدار يتغير في كل مرة يتم فيها تعديل المورد التغييرات - الحقل etag. العلامات الإلكترونية هي جزء عادي من HTTP مدعومة في واجهة برمجة تطبيقات التقويم حالتين:

• حول تعديلات الموارد للتأكّد من عدم كتابة أي رسالة أخرى في هذا المورد في هذه الأثناء (تعديل مشروط)
• عند استرجاع الموارد لاسترداد بيانات المورد فقط في حال تغير المورد (استرداد مشروط)

تعديل شرطي

إذا كنت تريد تحديث مورد أو حذفه فقط إذا لم يتغير بعد آخر مرة استرجعتها، يمكنك تحديد عنوان If-Match يحتوي على قيمة العلامة etag من الاسترداد السابق. هذا مفيد جدًا لمنع التعديلات المفقودة على الموارد. لدى العملاء خيار إعادة استرداد المورد وإعادة تطبيق التغييرات.

إذا لم يتغير الإدخال (وعلامته الإلكترونية) منذ آخر استرجاع، نجاح التعديل والإصدار الجديد من المورد الذي يحتوي على العلامة etag الجديدة عاد. بخلاف ذلك، ستحصل على رمز الاستجابة 412 (تعذَّر إكمال الشرط المسبق).

يوضح مقتطف نموذج التعليمة البرمجية أدناه كيفية تنفيذ شرطي والتعديلات مع مكتبة برامج Java

  private static void run() throws IOException {
    // Create a test event.
    Event event = Utils.createTestEvent(client, "Test Event");
    System.out.println(String.format("Event created: %s", event.getHtmlLink()));

    // Pause while the user modifies the event in the Calendar UI.
    System.out.println("Modify the event's description and hit enter to continue.");
    System.in.read();

    // Modify the local copy of the event.
    event.setSummary("Updated Test Event");

    // Update the event, making sure that we don't overwrite other changes.
    int numAttempts = 0;
    boolean isUpdated = false;
    do {
      Calendar.Events.Update request = client.events().update("primary", event.getId(), event);
      request.setRequestHeaders(new HttpHeaders().setIfMatch(event.getEtag()));
      try {
        event = request.execute();
        isUpdated = true;
      } catch (GoogleJsonResponseException e) {
        if (e.getStatusCode() == 412) {
          // A 412 status code, "Precondition failed", indicates that the etag values didn't
          // match, and the event was updated on the server since we last retrieved it. Use
          // {@link Calendar.Events.Get} to retrieve the latest version.
          Event latestEvent = client.events().get("primary", event.getId()).execute();

          // You may want to have more complex logic here to resolve conflicts. In this sample we're
          // simply overwriting the summary.
          latestEvent.setSummary(event.getSummary());
          event = latestEvent;
        } else {
          throw e;
        }
      }
      numAttempts++;
    } while (!isUpdated && numAttempts <= MAX_UPDATE_ATTEMPTS);

    if (isUpdated) {
      System.out.println("Event updated.");
    } else {
      System.out.println(String.format("Failed to update event after %d attempts.", numAttempts));
    }
  }
ConditionalModificationSample.java

الاسترجاع المشروط

إذا كنت تريد استرداد مورد فقط إذا تم تغييره منذ آخر مرة لاسترداده، يمكنك تحديد عنوان If-None-Match يحتوي على قيمة العلامة etag من الاسترداد السابق. إذا كان الإدخال (وبالتالي علامته الإلكترونية) منذ آخر استرجاع، هو الإصدار الجديد من المورد الذي يحتوي على سيتم عرض علامة etag جديدة. وبخلاف ذلك، ستحصل على خطأ 304 (لم يتم تعديله) رمز الاستجابة السريعة.

يوضح مقتطف نموذج التعليمة البرمجية أدناه كيفية تنفيذ شرطي استرداد باستخدام مكتبة برامج Java

  private static void run() throws IOException {
    // Create a test event.
    Event event = Utils.createTestEvent(client, "Test Event");
    System.out.println(String.format("Event created: %s", event.getHtmlLink()));

    // Pause while the user modifies the event in the Calendar UI.
    System.out.println("Modify the event's description and hit enter to continue.");
    System.in.read();

    // Fetch the event again if it's been modified.
    Calendar.Events.Get getRequest = client.events().get("primary", event.getId());
    getRequest.setRequestHeaders(new HttpHeaders().setIfNoneMatch(event.getEtag()));
    try {
      event = getRequest.execute();
      System.out.println("The event was modified, retrieved latest version.");
    } catch (GoogleJsonResponseException e) {
      if (e.getStatusCode() == 304) {
        // A 304 status code, "Not modified", indicates that the etags match, and the event has
        // not been modified since we last retrieved it.
        System.out.println("The event was not modified, using local version.");
      } else {
        throw e;
      }
    }
  }
ConditionalRetrievalSample.java