com.google.cloud.pubsub.v1.PublisherInterface Maven / Gradle / Ivy

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

Java idiomatic client for Google Cloud Pub/Sub

The newest version!

/*
 * Copyright 2020 Google LLC
 *
 * 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
 *
 *       http://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.pubsub.v1;

import com.google.api.core.ApiFuture;
import com.google.pubsub.v1.PubsubMessage;

/**
 * An interface for a Cloud Pub/Sub publisher.
 */
public interface PublisherInterface {
  /**
   * Schedules the publishing of a message. The future will be returned with the message ID on
   * success or an exception on failure.
   *
   * Some implementations of this method may block in the downcall until allowed by flow control.
   *
   * 
Example of publishing a message.
   *
   * 
{@code
   * String message = "my_message";
   * ByteString data = ByteString.copyFromUtf8(message);
   * PubsubMessage pubsubMessage = PubsubMessage.newBuilder().setData(data).build();
   * ApiFuture messageIdFuture = publisher.publish(pubsubMessage);
   * ApiFutures.addCallback(messageIdFuture, new ApiFutureCallback() {
   *   public void onSuccess(String messageId) {
   *     System.out.println("published with message id: " + messageId);
   *   }
   *
   *   public void onFailure(Throwable t) {
   *     System.out.println("failed to publish: " + t);
   *   }
   * }, MoreExecutors.directExecutor());
   * }
   *
   * @param message the message to publish.
   * @return the message ID wrapped in a future.
   */
  ApiFuture publish(PubsubMessage message);
}