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
/*
 * Copyright 2024 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
 *
 *     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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/pubsub/v1/pubsub.proto

// Protobuf Java Version: 3.25.3
package com.google.pubsub.v1;

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

  /**
   *
   *
   *    * Optional. The message data field. If this field is empty, the message must
   * contain at least one attribute.
   * 
   *
   * bytes data = 1 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The data.
   */
  com.google.protobuf.ByteString getData();

  /**
   *
   *
   *    * Optional. Attributes for this message. If this field is empty, the message
   * must contain non-empty data. This can be used to filter messages on the
   * subscription.
   * 
   *
   * map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  int getAttributesCount();
  /**
   *
   *
   *    * Optional. Attributes for this message. If this field is empty, the message
   * must contain non-empty data. This can be used to filter messages on the
   * subscription.
   * 
   *
   * map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  boolean containsAttributes(java.lang.String key);
  /** Use {@link #getAttributesMap()} instead. */
  @java.lang.Deprecated
  java.util.Map getAttributes();
  /**
   *
   *
   *    * Optional. Attributes for this message. If this field is empty, the message
   * must contain non-empty data. This can be used to filter messages on the
   * subscription.
   * 
   *
   * map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  java.util.Map getAttributesMap();
  /**
   *
   *
   *    * Optional. Attributes for this message. If this field is empty, the message
   * must contain non-empty data. This can be used to filter messages on the
   * subscription.
   * 
   *
   * map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  /* nullable */
  java.lang.String getAttributesOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   *    * Optional. Attributes for this message. If this field is empty, the message
   * must contain non-empty data. This can be used to filter messages on the
   * subscription.
   * 
   *
   * map<string, string> attributes = 2 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  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;
   *
   * @return The messageId.
   */
  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;
   *
   * @return The bytes for messageId.
   */
  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;
   *
   * @return Whether the publishTime field is set.
   */
  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;
   *
   * @return The publishTime.
   */
  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();

  /**
   *
   *
   *    * Optional. If non-empty, 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 non-empty `ordering_key` value
   * will be delivered to subscribers in the order in which they are received by
   * the Pub/Sub system. All `PubsubMessage`s published in a given
   * `PublishRequest` must specify the same `ordering_key` value. For more
   * information, see [ordering
   * messages](https://cloud.google.com/pubsub/docs/ordering).
   * 
   *
   * string ordering_key = 5 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The orderingKey.
   */
  java.lang.String getOrderingKey();
  /**
   *
   *
   *    * Optional. If non-empty, 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 non-empty `ordering_key` value
   * will be delivered to subscribers in the order in which they are received by
   * the Pub/Sub system. All `PubsubMessage`s published in a given
   * `PublishRequest` must specify the same `ordering_key` value. For more
   * information, see [ordering
   * messages](https://cloud.google.com/pubsub/docs/ordering).
   * 
   *
   * string ordering_key = 5 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for orderingKey.
   */
  com.google.protobuf.ByteString getOrderingKeyBytes();
}