com.azure.messaging.servicebus.models.ServiceBusReceiveMode.yml

### YamlMime:JavaEnum
uid: "com.azure.messaging.servicebus.models.ServiceBusReceiveMode"
fullName: "com.azure.messaging.servicebus.models.ServiceBusReceiveMode"
name: "ServiceBusReceiveMode"
nameWithType: "ServiceBusReceiveMode"
summary: "Defines the modes for receiving messages."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Enum?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-\">valueOf</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo-E-\">compareTo</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass--\">getDeclaringClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name--\">name</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal--\">ordinal</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString--\">toString</a>"
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public enum **ServiceBusReceiveMode**</br> extends <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html\">Enum</a>&lt;<xref href=\"com.azure.messaging.servicebus.models.ServiceBusReceiveMode?alt=com.azure.messaging.servicebus.models.ServiceBusReceiveMode&text=ServiceBusReceiveMode\" data-throw-if-not-resolved=\"False\" />&gt;"
fields:
- uid: "com.azure.messaging.servicebus.models.ServiceBusReceiveMode.PEEK_LOCK"
  fullName: "com.azure.messaging.servicebus.models.ServiceBusReceiveMode.PEEK_LOCK"
  name: "PEEK_LOCK"
  nameWithType: "ServiceBusReceiveMode.PEEK_LOCK"
  summary: "In this mode, the received message is not deleted from the queue or subscription, instead it is temporarily locked to the receiver, making it invisible to other receivers."
  desc: "In this mode, the received message is not deleted from the queue or subscription, instead it is temporarily locked to the receiver, making it invisible to other receivers. Then the service waits for one of the following events:\n\n *  If the receiver processes the message successfully, it calls <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceiverClient.complete(com.azure.messaging.servicebus.ServiceBusReceivedMessage)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusReceiverClient#complete(ServiceBusReceivedMessage)\"></xref> or <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient.complete(com.azure.messaging.servicebus.ServiceBusReceivedMessage)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusReceiverAsyncClient#complete(ServiceBusReceivedMessage)\"></xref> and the message will be deleted.\n *  If the receiver decides that it can't process the message successfully, it calls <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceiverClient.abandon(com.azure.messaging.servicebus.ServiceBusReceivedMessage)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusReceiverClient#abandon(ServiceBusReceivedMessage)\"></xref> or <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient.abandon(com.azure.messaging.servicebus.ServiceBusReceivedMessage)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusReceiverAsyncClient#abandon(ServiceBusReceivedMessage)\"></xref> and the message will be unlocked and made available to other receivers.\n *  If the receiver wants to defer the processing of the message to a later point in time, it calls <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceiverClient.defer(com.azure.messaging.servicebus.ServiceBusReceivedMessage)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusReceiverClient#defer(ServiceBusReceivedMessage)\"></xref> or <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient.defer(com.azure.messaging.servicebus.ServiceBusReceivedMessage)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusReceiverAsyncClient#defer(ServiceBusReceivedMessage)\"></xref> and the message will be deferred. A deferred can only be received by its sequence number.\n *  If the receiver wants to dead-letter the message, it calls <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceiverClient.deadLetter(com.azure.messaging.servicebus.ServiceBusReceivedMessage)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusReceiverClient#deadLetter(ServiceBusReceivedMessage)\"></xref> or <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceiverAsyncClient.deadLetter(com.azure.messaging.servicebus.ServiceBusReceivedMessage)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusReceiverAsyncClient#deadLetter(ServiceBusReceivedMessage)\"></xref> and the message will be moved to a special sub-queue called dead-letter queue.\n *  If the receiver calls neither of these methods within a configurable period of time (by default, 60 seconds), the service assumes the receiver has failed. In this case, it behaves as if the receiver had called `abandon`, making the message available to other receivers"
- uid: "com.azure.messaging.servicebus.models.ServiceBusReceiveMode.RECEIVE_AND_DELETE"
  fullName: "com.azure.messaging.servicebus.models.ServiceBusReceiveMode.RECEIVE_AND_DELETE"
  name: "RECEIVE_AND_DELETE"
  nameWithType: "ServiceBusReceiveMode.RECEIVE_AND_DELETE"
  summary: "In this mode, received message is removed from the queue or subscription and immediately deleted."
  desc: "In this mode, received message is removed from the queue or subscription and immediately deleted. This option is simple, but if the receiver crashes before it finishes processing the message, the message is lost. Because it has been removed from the queue, no other receiver can access it."
methods:
- uid: "com.azure.messaging.servicebus.models.ServiceBusReceiveMode.valueOf(java.lang.String)"
  fullName: "com.azure.messaging.servicebus.models.ServiceBusReceiveMode.valueOf(String name)"
  name: "valueOf(String name)"
  nameWithType: "ServiceBusReceiveMode.valueOf(String name)"
  modifiers:
  - "static"
  parameters:
  - name: "name"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public static ServiceBusReceiveMode valueOf(String name)"
  returns:
    type: "<xref href=\"com.azure.messaging.servicebus.models.ServiceBusReceiveMode?alt=com.azure.messaging.servicebus.models.ServiceBusReceiveMode&text=ServiceBusReceiveMode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.messaging.servicebus.models.ServiceBusReceiveMode.values()"
  fullName: "com.azure.messaging.servicebus.models.ServiceBusReceiveMode.values()"
  name: "values()"
  nameWithType: "ServiceBusReceiveMode.values()"
  modifiers:
  - "static"
  syntax: "public static ServiceBusReceiveMode[] values()"
  returns:
    type: "<xref href=\"com.azure.messaging.servicebus.models.ServiceBusReceiveMode?alt=com.azure.messaging.servicebus.models.ServiceBusReceiveMode&text=ServiceBusReceiveMode\" data-throw-if-not-resolved=\"False\" />[]"
desc: "Defines the modes for receiving messages."
metadata: {}
package: "com.azure.messaging.servicebus.models"
artifact: com.azure:azure-messaging-servicebus:7.17.1