Mendapatkan versi resource tertentu

Setiap resource memiliki kolom versi yang berubah setiap kali resource berubah — kolom etag. ETag adalah bagian standar dari HTTP dan didukung di Calendar API untuk dua kasus:

• pada modifikasi resource untuk memastikan bahwa tidak ada penulisan lain ke resource ini untuk sementara (modifikasi bersyarat)
• saat pengambilan resource untuk hanya mengambil data resource jika resource telah berubah (pengambilan bersyarat)

Modifikasi bersyarat

Jika ingin mengupdate atau menghapus resource hanya jika resource tersebut tidak berubah sejak terakhir kali Anda mengambilnya, Anda dapat menentukan header If-Match yang berisi nilai etag dari pengambilan sebelumnya. Hal ini sangat berguna untuk mencegah modifikasi yang hilang pada resource. Klien memiliki opsi untuk mengambil ulang resource dan menerapkan kembali perubahan.

Jika entri (dan etag-nya) tidak berubah sejak pengambilan terakhir, modifikasi berhasil dan versi baru resource dengan etag baru akan ditampilkan. Jika tidak, Anda akan mendapatkan kode respons 412 (Kondisi prasyarat gagal).

Penting: Tidak ada dukungan untuk modifikasi bersyarat untuk operasi penyisipan. Sebagai gantinya, dijamin bahwa jika Anda diizinkan untuk memberikan ID resource, maka operasi hanya akan berhasil jika tidak ada entri yang ada yang memiliki ID tersebut.

Cuplikan kode contoh di bawah menunjukkan cara melakukan modifikasi bersyarat dengan library klien 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

Pengambilan bersyarat

Jika Anda ingin mengambil resource hanya jika resource tersebut telah berubah sejak terakhir kali Anda mengambilnya, Anda dapat menentukan header If-None-Match yang berisi nilai etag dari pengambilan sebelumnya. Jika entri (dan dengan demikian etag-nya) telah berubah sejak pengambilan terakhir, versi baru resource dengan etag baru akan ditampilkan. Jika tidak, Anda akan mendapatkan kode respons 304 (Tidak Dimodifikasi).

Catatan: Ada kasus khusus saat etag tidak akan berubah, seperti saat salah satu kolom hanya baca dari entri calendarList berubah (misalnya, properti kalender atau ACL).

Cuplikan kode contoh di bawah menunjukkan cara melakukan pengambilan bersyarat dengan library klien 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