132 строки
12 KiB
YAML
132 строки
12 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext"
|
|
name: "ServiceBusReceivedMessageContext"
|
|
nameWithType: "ServiceBusReceivedMessageContext"
|
|
summary: "The Service Bus processor message context that holds a received message and additional methods to settle the message."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- 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#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<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#hashCode--\">hashCode</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#toString--\">toString</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 final class **ServiceBusReceivedMessageContext**"
|
|
methods:
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.abandon()"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.abandon()"
|
|
name: "abandon()"
|
|
nameWithType: "ServiceBusReceivedMessageContext.abandon()"
|
|
summary: "Abandons the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
syntax: "public void abandon()"
|
|
desc: "Abandons the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.abandon(com.azure.messaging.servicebus.models.AbandonOptions)"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.abandon(AbandonOptions options)"
|
|
name: "abandon(AbandonOptions options)"
|
|
nameWithType: "ServiceBusReceivedMessageContext.abandon(AbandonOptions options)"
|
|
summary: "Abandons the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
parameters:
|
|
- description: "Additional options for abandoning the message."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.messaging.servicebus.models.AbandonOptions?alt=com.azure.messaging.servicebus.models.AbandonOptions&text=AbandonOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void abandon(AbandonOptions options)"
|
|
desc: "Abandons the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.complete()"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.complete()"
|
|
name: "complete()"
|
|
nameWithType: "ServiceBusReceivedMessageContext.complete()"
|
|
summary: "Completes the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
syntax: "public void complete()"
|
|
desc: "Completes the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.complete(com.azure.messaging.servicebus.models.CompleteOptions)"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.complete(CompleteOptions options)"
|
|
name: "complete(CompleteOptions options)"
|
|
nameWithType: "ServiceBusReceivedMessageContext.complete(CompleteOptions options)"
|
|
summary: "Completes the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
parameters:
|
|
- description: "Additional options for completing the message."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.messaging.servicebus.models.CompleteOptions?alt=com.azure.messaging.servicebus.models.CompleteOptions&text=CompleteOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void complete(CompleteOptions options)"
|
|
desc: "Completes the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.deadLetter()"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.deadLetter()"
|
|
name: "deadLetter()"
|
|
nameWithType: "ServiceBusReceivedMessageContext.deadLetter()"
|
|
summary: "Dead-letters the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
syntax: "public void deadLetter()"
|
|
desc: "Dead-letters the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.deadLetter(com.azure.messaging.servicebus.models.DeadLetterOptions)"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.deadLetter(DeadLetterOptions options)"
|
|
name: "deadLetter(DeadLetterOptions options)"
|
|
nameWithType: "ServiceBusReceivedMessageContext.deadLetter(DeadLetterOptions options)"
|
|
summary: "Dead-letters the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
parameters:
|
|
- description: "Additional options for dead-lettering the message."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.messaging.servicebus.models.DeadLetterOptions?alt=com.azure.messaging.servicebus.models.DeadLetterOptions&text=DeadLetterOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void deadLetter(DeadLetterOptions options)"
|
|
desc: "Dead-letters the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.defer()"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.defer()"
|
|
name: "defer()"
|
|
nameWithType: "ServiceBusReceivedMessageContext.defer()"
|
|
summary: "Defers the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
syntax: "public void defer()"
|
|
desc: "Defers the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.defer(com.azure.messaging.servicebus.models.DeferOptions)"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.defer(DeferOptions options)"
|
|
name: "defer(DeferOptions options)"
|
|
nameWithType: "ServiceBusReceivedMessageContext.defer(DeferOptions options)"
|
|
summary: "Defers the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
parameters:
|
|
- description: "Additional options for deferring the message."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.messaging.servicebus.models.DeferOptions?alt=com.azure.messaging.servicebus.models.DeferOptions&text=DeferOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public void defer(DeferOptions options)"
|
|
desc: "Defers the <xref uid=\"com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"message\"></xref> in this context."
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getEntityPath()"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getEntityPath()"
|
|
name: "getEntityPath()"
|
|
nameWithType: "ServiceBusReceivedMessageContext.getEntityPath()"
|
|
summary: "Gets the Service Bus resource this instance of <xref uid=\"com.azure.messaging.servicebus.ServiceBusProcessorClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusProcessorClient\"></xref> interacts with."
|
|
syntax: "public String getEntityPath()"
|
|
desc: "Gets the Service Bus resource this instance of <xref uid=\"com.azure.messaging.servicebus.ServiceBusProcessorClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusProcessorClient\"></xref> interacts with."
|
|
returns:
|
|
description: "The Service Bus resource this instance of <xref uid=\"com.azure.messaging.servicebus.ServiceBusProcessorClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusProcessorClient\"></xref> interacts with."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getFullyQualifiedNamespace()"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getFullyQualifiedNamespace()"
|
|
name: "getFullyQualifiedNamespace()"
|
|
nameWithType: "ServiceBusReceivedMessageContext.getFullyQualifiedNamespace()"
|
|
summary: "Gets the fully qualified Service Bus namespace that this instance of <xref uid=\"com.azure.messaging.servicebus.ServiceBusProcessorClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusProcessorClient\"></xref> is associated with."
|
|
syntax: "public String getFullyQualifiedNamespace()"
|
|
desc: "Gets the fully qualified Service Bus namespace that this instance of <xref uid=\"com.azure.messaging.servicebus.ServiceBusProcessorClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusProcessorClient\"></xref> is associated with. This is likely similar to `{yournamespace}.servicebus.windows.net`."
|
|
returns:
|
|
description: "The fully qualified Service Bus namespace that this instance of <xref uid=\"com.azure.messaging.servicebus.ServiceBusProcessorClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusProcessorClient\"></xref>\n is associated with."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()"
|
|
fullName: "com.azure.messaging.servicebus.ServiceBusReceivedMessageContext.getMessage()"
|
|
name: "getMessage()"
|
|
nameWithType: "ServiceBusReceivedMessageContext.getMessage()"
|
|
summary: "Gets the message received from Service Bus."
|
|
syntax: "public ServiceBusReceivedMessage getMessage()"
|
|
desc: "Gets the message received from Service Bus."
|
|
returns:
|
|
description: "The message received from Service Bus."
|
|
type: "<xref href=\"com.azure.messaging.servicebus.ServiceBusReceivedMessage?alt=com.azure.messaging.servicebus.ServiceBusReceivedMessage&text=ServiceBusReceivedMessage\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The Service Bus processor message context that holds a received message and additional methods to settle the message."
|
|
metadata: {}
|
|
package: "com.azure.messaging.servicebus"
|
|
artifact: com.azure:azure-messaging-servicebus:7.17.5
|