Получите определенные версии ресурсов

Every resource has a version field that changes every time the resource changes — the etag field. Etags are a standard part of HTTP and are supported in the calendar API for two cases:

  • при изменении ресурса, чтобы гарантировать отсутствие других записей в этот ресурс за это время (условное изменение).
  • При извлечении ресурсов следует извлекать данные о ресурсе только в том случае, если ресурс изменился (условное извлечение).

Conditional modification

Если вы хотите обновить или удалить ресурс только в том случае, если он не изменился с момента последнего его получения, вы можете указать заголовок If-Match , содержащий значение etag из предыдущего получения. Это очень полезно для предотвращения потери изменений в ресурсах. Клиенты имеют возможность повторно получить ресурс и повторно применить изменения.

Если запись (и её etag) не изменилась с момента последнего получения, изменение прошло успешно, и возвращается новая версия ресурса с новым etag. В противном случае вы получите код ответа 412 (Precondition failed).

Приведённый ниже фрагмент кода демонстрирует, как выполнять условные изменения с помощью клиентской библиотеки 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) изменилась с момента последнего получения, будет возвращена новая версия ресурса с новым etag. В противном случае вы получите код ответа 304 (Not Modified).

Приведённый ниже фрагмент кода демонстрирует, как выполнять условное извлечение данных с помощью клиентской библиотеки 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