apache.rocketmq.v2.SystemPropertiesOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of rocketmq-proto Show documentation
Common Protocol APIs of Apache RocketMQ
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: apache/rocketmq/v2/definition.proto

package apache.rocketmq.v2;

public interface SystemPropertiesOrBuilder extends
    // @@protoc_insertion_point(interface_extends:apache.rocketmq.v2.SystemProperties)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Tag, which is optional.
   * 
   *
   * optional string tag = 1;
   * @return Whether the tag field is set.
   */
  boolean hasTag();
  /**
   *    * Tag, which is optional.
   * 
   *
   * optional string tag = 1;
   * @return The tag.
   */
  java.lang.String getTag();
  /**
   *    * Tag, which is optional.
   * 
   *
   * optional string tag = 1;
   * @return The bytes for tag.
   */
  com.google.protobuf.ByteString
      getTagBytes();

  /**
   *    * Message keys
   * 
   *
   * repeated string keys = 2;
   * @return A list containing the keys.
   */
  java.util.List
      getKeysList();
  /**
   *    * Message keys
   * 
   *
   * repeated string keys = 2;
   * @return The count of keys.
   */
  int getKeysCount();
  /**
   *    * Message keys
   * 
   *
   * repeated string keys = 2;
   * @param index The index of the element to return.
   * @return The keys at the given index.
   */
  java.lang.String getKeys(int index);
  /**
   *    * Message keys
   * 
   *
   * repeated string keys = 2;
   * @param index The index of the value to return.
   * @return The bytes of the keys at the given index.
   */
  com.google.protobuf.ByteString
      getKeysBytes(int index);

  /**
   *    * Message identifier, client-side generated, remains unique.
   * if message_id is empty, the send message request will be aborted with
   * status `INVALID_ARGUMENT`
   * 
   *
   * string message_id = 3;
   * @return The messageId.
   */
  java.lang.String getMessageId();
  /**
   *    * Message identifier, client-side generated, remains unique.
   * if message_id is empty, the send message request will be aborted with
   * status `INVALID_ARGUMENT`
   * 
   *
   * string message_id = 3;
   * @return The bytes for messageId.
   */
  com.google.protobuf.ByteString
      getMessageIdBytes();

  /**
   *    * Message body digest
   * 
   *
   * .apache.rocketmq.v2.Digest body_digest = 4;
   * @return Whether the bodyDigest field is set.
   */
  boolean hasBodyDigest();
  /**
   *    * Message body digest
   * 
   *
   * .apache.rocketmq.v2.Digest body_digest = 4;
   * @return The bodyDigest.
   */
  apache.rocketmq.v2.Digest getBodyDigest();
  /**
   *    * Message body digest
   * 
   *
   * .apache.rocketmq.v2.Digest body_digest = 4;
   */
  apache.rocketmq.v2.DigestOrBuilder getBodyDigestOrBuilder();

  /**
   *    * Message body encoding. Candidate options are identity, gzip, snappy etc.
   * 
   *
   * .apache.rocketmq.v2.Encoding body_encoding = 5;
   * @return The enum numeric value on the wire for bodyEncoding.
   */
  int getBodyEncodingValue();
  /**
   *    * Message body encoding. Candidate options are identity, gzip, snappy etc.
   * 
   *
   * .apache.rocketmq.v2.Encoding body_encoding = 5;
   * @return The bodyEncoding.
   */
  apache.rocketmq.v2.Encoding getBodyEncoding();

  /**
   *    * Message type, normal, FIFO or transactional.
   * 
   *
   * .apache.rocketmq.v2.MessageType message_type = 6;
   * @return The enum numeric value on the wire for messageType.
   */
  int getMessageTypeValue();
  /**
   *    * Message type, normal, FIFO or transactional.
   * 
   *
   * .apache.rocketmq.v2.MessageType message_type = 6;
   * @return The messageType.
   */
  apache.rocketmq.v2.MessageType getMessageType();

  /**
   *    * Message born time-point.
   * 
   *
   * .google.protobuf.Timestamp born_timestamp = 7;
   * @return Whether the bornTimestamp field is set.
   */
  boolean hasBornTimestamp();
  /**
   *    * Message born time-point.
   * 
   *
   * .google.protobuf.Timestamp born_timestamp = 7;
   * @return The bornTimestamp.
   */
  com.google.protobuf.Timestamp getBornTimestamp();
  /**
   *    * Message born time-point.
   * 
   *
   * .google.protobuf.Timestamp born_timestamp = 7;
   */
  com.google.protobuf.TimestampOrBuilder getBornTimestampOrBuilder();

  /**
   *    * Message born host. Valid options are IPv4, IPv6 or client host domain name.
   * 
   *
   * string born_host = 8;
   * @return The bornHost.
   */
  java.lang.String getBornHost();
  /**
   *    * Message born host. Valid options are IPv4, IPv6 or client host domain name.
   * 
   *
   * string born_host = 8;
   * @return The bytes for bornHost.
   */
  com.google.protobuf.ByteString
      getBornHostBytes();

  /**
   *    * Time-point at which the message is stored in the broker, which is absent
   * for message publishing.
   * 
   *
   * optional .google.protobuf.Timestamp store_timestamp = 9;
   * @return Whether the storeTimestamp field is set.
   */
  boolean hasStoreTimestamp();
  /**
   *    * Time-point at which the message is stored in the broker, which is absent
   * for message publishing.
   * 
   *
   * optional .google.protobuf.Timestamp store_timestamp = 9;
   * @return The storeTimestamp.
   */
  com.google.protobuf.Timestamp getStoreTimestamp();
  /**
   *    * Time-point at which the message is stored in the broker, which is absent
   * for message publishing.
   * 
   *
   * optional .google.protobuf.Timestamp store_timestamp = 9;
   */
  com.google.protobuf.TimestampOrBuilder getStoreTimestampOrBuilder();

  /**
   *    * The broker that stores this message. It may be broker name, IP or arbitrary
   * identifier that uniquely identify the server.
   * 
   *
   * string store_host = 10;
   * @return The storeHost.
   */
  java.lang.String getStoreHost();
  /**
   *    * The broker that stores this message. It may be broker name, IP or arbitrary
   * identifier that uniquely identify the server.
   * 
   *
   * string store_host = 10;
   * @return The bytes for storeHost.
   */
  com.google.protobuf.ByteString
      getStoreHostBytes();

  /**
   *    * Time-point at which broker delivers to clients, which is optional.
   * 
   *
   * optional .google.protobuf.Timestamp delivery_timestamp = 11;
   * @return Whether the deliveryTimestamp field is set.
   */
  boolean hasDeliveryTimestamp();
  /**
   *    * Time-point at which broker delivers to clients, which is optional.
   * 
   *
   * optional .google.protobuf.Timestamp delivery_timestamp = 11;
   * @return The deliveryTimestamp.
   */
  com.google.protobuf.Timestamp getDeliveryTimestamp();
  /**
   *    * Time-point at which broker delivers to clients, which is optional.
   * 
   *
   * optional .google.protobuf.Timestamp delivery_timestamp = 11;
   */
  com.google.protobuf.TimestampOrBuilder getDeliveryTimestampOrBuilder();

  /**
   *    * If a message is acquired by way of POP, this field holds the receipt,
   * which is absent for message publishing.
   * Clients use the receipt to acknowledge or negatively acknowledge the
   * message.
   * 
   *
   * optional string receipt_handle = 12;
   * @return Whether the receiptHandle field is set.
   */
  boolean hasReceiptHandle();
  /**
   *    * If a message is acquired by way of POP, this field holds the receipt,
   * which is absent for message publishing.
   * Clients use the receipt to acknowledge or negatively acknowledge the
   * message.
   * 
   *
   * optional string receipt_handle = 12;
   * @return The receiptHandle.
   */
  java.lang.String getReceiptHandle();
  /**
   *    * If a message is acquired by way of POP, this field holds the receipt,
   * which is absent for message publishing.
   * Clients use the receipt to acknowledge or negatively acknowledge the
   * message.
   * 
   *
   * optional string receipt_handle = 12;
   * @return The bytes for receiptHandle.
   */
  com.google.protobuf.ByteString
      getReceiptHandleBytes();

  /**
   *    * Message queue identifier in which a message is physically stored.
   * 
   *
   * int32 queue_id = 13;
   * @return The queueId.
   */
  int getQueueId();

  /**
   *    * Message-queue offset at which a message is stored, which is absent for
   * message publishing.
   * 
   *
   * optional int64 queue_offset = 14;
   * @return Whether the queueOffset field is set.
   */
  boolean hasQueueOffset();
  /**
   *    * Message-queue offset at which a message is stored, which is absent for
   * message publishing.
   * 
   *
   * optional int64 queue_offset = 14;
   * @return The queueOffset.
   */
  long getQueueOffset();

  /**
   *    * Period of time servers would remain invisible once a message is acquired.
   * 
   *
   * optional .google.protobuf.Duration invisible_duration = 15;
   * @return Whether the invisibleDuration field is set.
   */
  boolean hasInvisibleDuration();
  /**
   *    * Period of time servers would remain invisible once a message is acquired.
   * 
   *
   * optional .google.protobuf.Duration invisible_duration = 15;
   * @return The invisibleDuration.
   */
  com.google.protobuf.Duration getInvisibleDuration();
  /**
   *    * Period of time servers would remain invisible once a message is acquired.
   * 
   *
   * optional .google.protobuf.Duration invisible_duration = 15;
   */
  com.google.protobuf.DurationOrBuilder getInvisibleDurationOrBuilder();

  /**
   *    * Business code may failed to process messages for the moment. Hence, clients
   * may request servers to deliver them again using certain back-off strategy,
   * the attempt is 1 not 0 if message is delivered first time, and it is absent
   * for message publishing.
   * 
   *
   * optional int32 delivery_attempt = 16;
   * @return Whether the deliveryAttempt field is set.
   */
  boolean hasDeliveryAttempt();
  /**
   *    * Business code may failed to process messages for the moment. Hence, clients
   * may request servers to deliver them again using certain back-off strategy,
   * the attempt is 1 not 0 if message is delivered first time, and it is absent
   * for message publishing.
   * 
   *
   * optional int32 delivery_attempt = 16;
   * @return The deliveryAttempt.
   */
  int getDeliveryAttempt();

  /**
   *    * Define the group name of message in the same topic, which is optional.
   * 
   *
   * optional string message_group = 17;
   * @return Whether the messageGroup field is set.
   */
  boolean hasMessageGroup();
  /**
   *    * Define the group name of message in the same topic, which is optional.
   * 
   *
   * optional string message_group = 17;
   * @return The messageGroup.
   */
  java.lang.String getMessageGroup();
  /**
   *    * Define the group name of message in the same topic, which is optional.
   * 
   *
   * optional string message_group = 17;
   * @return The bytes for messageGroup.
   */
  com.google.protobuf.ByteString
      getMessageGroupBytes();

  /**
   *    * Trace context for each message, which is optional.
   * 
   *
   * optional string trace_context = 18;
   * @return Whether the traceContext field is set.
   */
  boolean hasTraceContext();
  /**
   *    * Trace context for each message, which is optional.
   * 
   *
   * optional string trace_context = 18;
   * @return The traceContext.
   */
  java.lang.String getTraceContext();
  /**
   *    * Trace context for each message, which is optional.
   * 
   *
   * optional string trace_context = 18;
   * @return The bytes for traceContext.
   */
  com.google.protobuf.ByteString
      getTraceContextBytes();

  /**
   *    * If a transactional message stay unresolved for more than
   * `transaction_orphan_threshold`, it would be regarded as an
   * orphan. Servers that manages orphan messages would pick up
   * a capable publisher to resolve
   * 
   *
   * optional .google.protobuf.Duration orphaned_transaction_recovery_duration = 19;
   * @return Whether the orphanedTransactionRecoveryDuration field is set.
   */
  boolean hasOrphanedTransactionRecoveryDuration();
  /**
   *    * If a transactional message stay unresolved for more than
   * `transaction_orphan_threshold`, it would be regarded as an
   * orphan. Servers that manages orphan messages would pick up
   * a capable publisher to resolve
   * 
   *
   * optional .google.protobuf.Duration orphaned_transaction_recovery_duration = 19;
   * @return The orphanedTransactionRecoveryDuration.
   */
  com.google.protobuf.Duration getOrphanedTransactionRecoveryDuration();
  /**
   *    * If a transactional message stay unresolved for more than
   * `transaction_orphan_threshold`, it would be regarded as an
   * orphan. Servers that manages orphan messages would pick up
   * a capable publisher to resolve
   * 
   *
   * optional .google.protobuf.Duration orphaned_transaction_recovery_duration = 19;
   */
  com.google.protobuf.DurationOrBuilder getOrphanedTransactionRecoveryDurationOrBuilder();

  /**
   *    * Information to identify whether this message is from dead letter queue.
   * 
   *
   * optional .apache.rocketmq.v2.DeadLetterQueue dead_letter_queue = 20;
   * @return Whether the deadLetterQueue field is set.
   */
  boolean hasDeadLetterQueue();
  /**
   *    * Information to identify whether this message is from dead letter queue.
   * 
   *
   * optional .apache.rocketmq.v2.DeadLetterQueue dead_letter_queue = 20;
   * @return The deadLetterQueue.
   */
  apache.rocketmq.v2.DeadLetterQueue getDeadLetterQueue();
  /**
   *    * Information to identify whether this message is from dead letter queue.
   * 
   *
   * optional .apache.rocketmq.v2.DeadLetterQueue dead_letter_queue = 20;
   */
  apache.rocketmq.v2.DeadLetterQueueOrBuilder getDeadLetterQueueOrBuilder();
}