com.google.cloud.spring.pubsub.support.AcknowledgeablePubsubMessage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spring-cloud-gcp-pubsub Show documentation

Spring Framework on Google Cloud Pub/Sub Module

The newest version!

/*
 * Copyright 2017-2018 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.cloud.spring.pubsub.support;

import java.util.concurrent.CompletableFuture;

/**
 * An extension of {@link BasicAcknowledgeablePubsubMessage} that exposes ack ID and subscription
 * name of the message. It also allows modification of the ack deadline and acknowledgement of
 * multiple messages at once using {@link
 * com.google.cloud.spring.pubsub.core.subscriber.PubSubSubscriberOperations#ack(java.util.Collection)}.
 */
public interface AcknowledgeablePubsubMessage extends BasicAcknowledgeablePubsubMessage {

  /**
   * Accessor for the ack ID of the Pub/Sub message.
   *
   * @return ack ID
   */
  String getAckId();

  /**
   * Modify the ack deadline of the message. Once the ack deadline expires, the message is
   * automatically nacked.
   *
   * @param ackDeadlineSeconds the new ack deadline in seconds. A deadline of 0 effectively nacks
   *     the message.
   * @return {@code CompletableFuture}
   * @since 1.1
   */
  CompletableFuture modifyAckDeadline(int ackDeadlineSeconds);
}