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

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.114.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 ReceivedMessageOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.pubsub.v1.ReceivedMessage)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * Optional. This ID can be used to acknowledge the received message.
   * 
   *
   * string ack_id = 1 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The ackId.
   */
  java.lang.String getAckId();
  /**
   *
   *
   *    * Optional. This ID can be used to acknowledge the received message.
   * 
   *
   * string ack_id = 1 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for ackId.
   */
  com.google.protobuf.ByteString getAckIdBytes();

  /**
   *
   *
   *    * Optional. The message.
   * 
   *
   * .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the message field is set.
   */
  boolean hasMessage();
  /**
   *
   *
   *    * Optional. The message.
   * 
   *
   * .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The message.
   */
  com.google.pubsub.v1.PubsubMessage getMessage();
  /**
   *
   *
   *    * Optional. The message.
   * 
   *
   * .google.pubsub.v1.PubsubMessage message = 2 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.pubsub.v1.PubsubMessageOrBuilder getMessageOrBuilder();

  /**
   *
   *
   *    * Optional. The approximate number of times that Pub/Sub has attempted to
   * deliver the associated message to a subscriber.
   *
   * More precisely, this is 1 + (number of NACKs) +
   * (number of ack_deadline exceeds) for this message.
   *
   * A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline
   * exceeds event is whenever a message is not acknowledged within
   * ack_deadline. Note that ack_deadline is initially
   * Subscription.ackDeadlineSeconds, but may get extended automatically by
   * the client library.
   *
   * Upon the first delivery of a given message, `delivery_attempt` will have a
   * value of 1. The value is calculated at best effort and is approximate.
   *
   * If a DeadLetterPolicy is not set on the subscription, this will be 0.
   * 
   *
   * int32 delivery_attempt = 3 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The deliveryAttempt.
   */
  int getDeliveryAttempt();
}