Obtén versiones específicas de los recursos

Todos los recursos tienen un campo de versión que cambia cada vez que el recurso cambia: el campo etag. Las ETag son una parte estándar de HTTP y se admiten en la API de Calendar en dos casos:

  • En las modificaciones de recursos para garantizar que no se haya realizado ninguna otra escritura en este recurso mientras tanto (modificación condicional)
  • En la recuperación de recursos, para recuperar solo los datos del recurso si este cambió (recuperación condicional)

Modificación condicional

Si deseas actualizar o borrar un recurso solo si no ha cambiado desde la última vez que lo recuperaste, puedes especificar un encabezado If-Match que contenga el valor de la ETag de la recuperación anterior. Esto es muy útil para evitar la pérdida de modificaciones en los recursos. Los clientes tienen la opción de volver a recuperar el recurso y volver a aplicar los cambios.

Si la entrada (y su ETag) no cambiaron desde la última recuperación, la modificación se realiza correctamente y se devuelve la nueva versión del recurso con la nueva ETag. De lo contrario, recibirás un código de respuesta 412 (Precondition failed).

En el siguiente fragmento de código de ejemplo, se muestra cómo realizar modificaciones condicionales con la biblioteca cliente de 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

Recuperación condicional

Si deseas recuperar un recurso solo si cambió desde la última vez que lo recuperaste, puedes especificar un encabezado If-None-Match que contenga el valor del ETag de la recuperación anterior. Si la entrada (y, por lo tanto, su ETag) cambió desde la última recuperación, se devolverá la nueva versión del recurso con la nueva ETag. De lo contrario, recibirás un código de respuesta 304 (Not Modified).

En el siguiente fragmento de código de ejemplo, se muestra cómo realizar una recuperación condicional con la biblioteca cliente de 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