com.google.pubsub.v1.PubsubMessageOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-pubsub-v1 Show documentation
PROTO library for proto-google-cloud-pubsub-v1
There is a newer version: 1.116.2
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/pubsub/v1/pubsub.proto

package com.google.pubsub.v1;

public interface PubsubMessageOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.pubsub.v1.PubsubMessage)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * The message data field. If this field is empty, the message must contain
   * at least one attribute.
   * 
   *
   * bytes data = 1;
   */
  com.google.protobuf.ByteString getData();

  /**
   *
   *
   *    * Optional attributes for this message.
   * 
   *
   * map<string, string> attributes = 2;
   */
  int getAttributesCount();
  /**
   *
   *
   *    * Optional attributes for this message.
   * 
   *
   * map<string, string> attributes = 2;
   */
  boolean containsAttributes(java.lang.String key);
  /** Use {@link #getAttributesMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getAttributes();
  /**
   *
   *
   *    * Optional attributes for this message.
   * 
   *
   * map<string, string> attributes = 2;
   */
  java.util.Map getAttributesMap();
  /**
   *
   *
   *    * Optional attributes for this message.
   * 
   *
   * map<string, string> attributes = 2;
   */
  java.lang.String getAttributesOrDefault(java.lang.String key, java.lang.String defaultValue);
  /**
   *
   *
   *    * Optional attributes for this message.
   * 
   *
   * map<string, string> attributes = 2;
   */
  java.lang.String getAttributesOrThrow(java.lang.String key);

  /**
   *
   *
   *    * ID of this message, assigned by the server when the message is published.
   * Guaranteed to be unique within the topic. This value may be read by a
   * subscriber that receives a `PubsubMessage` via a `Pull` call or a push
   * delivery. It must not be populated by the publisher in a `Publish` call.
   * 
   *
   * string message_id = 3;
   */
  java.lang.String getMessageId();
  /**
   *
   *
   *    * ID of this message, assigned by the server when the message is published.
   * Guaranteed to be unique within the topic. This value may be read by a
   * subscriber that receives a `PubsubMessage` via a `Pull` call or a push
   * delivery. It must not be populated by the publisher in a `Publish` call.
   * 
   *
   * string message_id = 3;
   */
  com.google.protobuf.ByteString getMessageIdBytes();

  /**
   *
   *
   *    * The time at which the message was published, populated by the server when
   * it receives the `Publish` call. It must not be populated by the
   * publisher in a `Publish` call.
   * 
   *
   * .google.protobuf.Timestamp publish_time = 4;
   */
  boolean hasPublishTime();
  /**
   *
   *
   *    * The time at which the message was published, populated by the server when
   * it receives the `Publish` call. It must not be populated by the
   * publisher in a `Publish` call.
   * 
   *
   * .google.protobuf.Timestamp publish_time = 4;
   */
  com.google.protobuf.Timestamp getPublishTime();
  /**
   *
   *
   *    * The time at which the message was published, populated by the server when
   * it receives the `Publish` call. It must not be populated by the
   * publisher in a `Publish` call.
   * 
   *
   * .google.protobuf.Timestamp publish_time = 4;
   */
  com.google.protobuf.TimestampOrBuilder getPublishTimeOrBuilder();

  /**
   *
   *
   *    * Identifies related messages for which publish order should be respected.
   * If a `Subscription` has `enable_message_ordering` set to `true`, messages
   * published with the same `ordering_key` value will be delivered to
   * subscribers in the order in which they are received by the Pub/Sub system.
   * <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
   * API might be changed in backward-incompatible ways and is not recommended
   * for production use. It is not subject to any SLA or deprecation policy.
   * 
   *
   * string ordering_key = 5;
   */
  java.lang.String getOrderingKey();
  /**
   *
   *
   *    * Identifies related messages for which publish order should be respected.
   * If a `Subscription` has `enable_message_ordering` set to `true`, messages
   * published with the same `ordering_key` value will be delivered to
   * subscribers in the order in which they are received by the Pub/Sub system.
   * <b>EXPERIMENTAL:</b> This feature is part of a closed alpha release. This
   * API might be changed in backward-incompatible ways and is not recommended
   * for production use. It is not subject to any SLA or deprecation policy.
   * 
   *
   * string ordering_key = 5;
   */
  com.google.protobuf.ByteString getOrderingKeyBytes();
}