288 строки
14 KiB
YAML
288 строки
14 KiB
YAML
### YamlMime:ManagedReference
|
|
items:
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information
|
|
id: _receiver_runtime_information
|
|
parent: com.microsoft.azure.eventhubs
|
|
children:
|
|
- com.microsoft.azure.eventhubs._receiver_runtime_information.getLastEnqueuedOffset()
|
|
- com.microsoft.azure.eventhubs._receiver_runtime_information.getLastEnqueuedSequenceNumber()
|
|
- com.microsoft.azure.eventhubs._receiver_runtime_information.getLastEnqueuedTime()
|
|
- com.microsoft.azure.eventhubs._receiver_runtime_information.getPartitionId()
|
|
- com.microsoft.azure.eventhubs._receiver_runtime_information.getRetrievalTime()
|
|
- com.microsoft.azure.eventhubs._receiver_runtime_information.ReceiverRuntimeInformation(final String)
|
|
- com.microsoft.azure.eventhubs._receiver_runtime_information.setRuntimeInformation(final long,final Instant,final String)
|
|
href: com.microsoft.azure.eventhubs._receiver_runtime_information.yml
|
|
langs:
|
|
- java
|
|
name: ReceiverRuntimeInformation
|
|
nameWithType: ReceiverRuntimeInformation
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation
|
|
type: Class
|
|
source:
|
|
remote: &o0
|
|
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/ReceiverRuntimeInformation.java
|
|
branch: master
|
|
repo: https://github.com/Azure/azure-event-hubs-java
|
|
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/ReceiverRuntimeInformation.java
|
|
startLine: 11
|
|
package: com.microsoft.azure.eventhubs
|
|
summary: <p>Represents the temporal end of stream information of an EventHubs Partition. </p>
|
|
syntax:
|
|
content: public class ReceiverRuntimeInformation
|
|
inheritance:
|
|
- java.lang.Object
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information.getLastEnqueuedOffset()
|
|
id: getLastEnqueuedOffset()
|
|
parent: com.microsoft.azure.eventhubs._receiver_runtime_information
|
|
href: com.microsoft.azure.eventhubs._receiver_runtime_information.yml
|
|
langs:
|
|
- java
|
|
name: getLastEnqueuedOffset()
|
|
nameWithType: ReceiverRuntimeInformation.getLastEnqueuedOffset()
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation.getLastEnqueuedOffset()
|
|
overload: com.microsoft.azure.eventhubs._receiver_runtime_information.getLastEnqueuedOffset*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/ReceiverRuntimeInformation.java
|
|
startLine: 60
|
|
package: com.microsoft.azure.eventhubs
|
|
summary: >-
|
|
<p>The last enqueued <xref uid="com.microsoft.azure.eventhubs._event_data" data-throw-if-not-resolved="false">EventData</xref>'s offset on this EventHubs Partition</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public String getLastEnqueuedOffset()
|
|
return:
|
|
type: "26831127"
|
|
description: <p>offset </p>
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information.getLastEnqueuedSequenceNumber()
|
|
id: getLastEnqueuedSequenceNumber()
|
|
parent: com.microsoft.azure.eventhubs._receiver_runtime_information
|
|
href: com.microsoft.azure.eventhubs._receiver_runtime_information.yml
|
|
langs:
|
|
- java
|
|
name: getLastEnqueuedSequenceNumber()
|
|
nameWithType: ReceiverRuntimeInformation.getLastEnqueuedSequenceNumber()
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation.getLastEnqueuedSequenceNumber()
|
|
overload: com.microsoft.azure.eventhubs._receiver_runtime_information.getLastEnqueuedSequenceNumber*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/ReceiverRuntimeInformation.java
|
|
startLine: 40
|
|
package: com.microsoft.azure.eventhubs
|
|
summary: >-
|
|
<p>The last enqueued <xref uid="com.microsoft.azure.eventhubs._event_data" data-throw-if-not-resolved="false">EventData</xref>'s sequence number on this EventHubs Partition</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public long getLastEnqueuedSequenceNumber()
|
|
return:
|
|
type: 0364520f
|
|
description: <p>last enqueued sequence number </p>
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information.getLastEnqueuedTime()
|
|
id: getLastEnqueuedTime()
|
|
parent: com.microsoft.azure.eventhubs._receiver_runtime_information
|
|
href: com.microsoft.azure.eventhubs._receiver_runtime_information.yml
|
|
langs:
|
|
- java
|
|
name: getLastEnqueuedTime()
|
|
nameWithType: ReceiverRuntimeInformation.getLastEnqueuedTime()
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation.getLastEnqueuedTime()
|
|
overload: com.microsoft.azure.eventhubs._receiver_runtime_information.getLastEnqueuedTime*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/ReceiverRuntimeInformation.java
|
|
startLine: 50
|
|
package: com.microsoft.azure.eventhubs
|
|
summary: >-
|
|
<p>The last enqueued <xref uid="com.microsoft.azure.eventhubs._event_data" data-throw-if-not-resolved="false">EventData</xref>'s enqueue time stamp on this EventHubs Partition</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public Instant getLastEnqueuedTime()
|
|
return:
|
|
type: 328f8254
|
|
description: <p>last enqueued time </p>
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information.getPartitionId()
|
|
id: getPartitionId()
|
|
parent: com.microsoft.azure.eventhubs._receiver_runtime_information
|
|
href: com.microsoft.azure.eventhubs._receiver_runtime_information.yml
|
|
langs:
|
|
- java
|
|
name: getPartitionId()
|
|
nameWithType: ReceiverRuntimeInformation.getPartitionId()
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation.getPartitionId()
|
|
overload: com.microsoft.azure.eventhubs._receiver_runtime_information.getPartitionId*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/ReceiverRuntimeInformation.java
|
|
startLine: 30
|
|
package: com.microsoft.azure.eventhubs
|
|
summary: >-
|
|
<p>The Event Hubs partition id to which this information belongs to</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public String getPartitionId()
|
|
return:
|
|
type: "26831127"
|
|
description: <p>the partition identifier </p>
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information.getRetrievalTime()
|
|
id: getRetrievalTime()
|
|
parent: com.microsoft.azure.eventhubs._receiver_runtime_information
|
|
href: com.microsoft.azure.eventhubs._receiver_runtime_information.yml
|
|
langs:
|
|
- java
|
|
name: getRetrievalTime()
|
|
nameWithType: ReceiverRuntimeInformation.getRetrievalTime()
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation.getRetrievalTime()
|
|
overload: com.microsoft.azure.eventhubs._receiver_runtime_information.getRetrievalTime*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/ReceiverRuntimeInformation.java
|
|
startLine: 70
|
|
package: com.microsoft.azure.eventhubs
|
|
summary: >-
|
|
<p>The value indicating when this information was retrieved from the Event Hubs service</p>
|
|
|
|
<p></p>
|
|
syntax:
|
|
content: public Instant getRetrievalTime()
|
|
return:
|
|
type: 328f8254
|
|
description: <p>retrieval time </p>
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information.ReceiverRuntimeInformation(final String)
|
|
id: ReceiverRuntimeInformation(final String)
|
|
parent: com.microsoft.azure.eventhubs._receiver_runtime_information
|
|
href: com.microsoft.azure.eventhubs._receiver_runtime_information.yml
|
|
langs:
|
|
- java
|
|
name: ReceiverRuntimeInformation(final String partitionId)
|
|
nameWithType: ReceiverRuntimeInformation.ReceiverRuntimeInformation(final String partitionId)
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation.ReceiverRuntimeInformation(final String partitionId)
|
|
overload: com.microsoft.azure.eventhubs._receiver_runtime_information.ReceiverRuntimeInformation*
|
|
type: Constructor
|
|
source:
|
|
remote: *o0
|
|
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/ReceiverRuntimeInformation.java
|
|
startLine: 20
|
|
package: com.microsoft.azure.eventhubs
|
|
syntax:
|
|
content: public ReceiverRuntimeInformation(final String partitionId)
|
|
parameters:
|
|
- id: partitionId
|
|
type: 3d93591e
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information.setRuntimeInformation(final long,final Instant,final String)
|
|
id: setRuntimeInformation(final long,final Instant,final String)
|
|
parent: com.microsoft.azure.eventhubs._receiver_runtime_information
|
|
href: com.microsoft.azure.eventhubs._receiver_runtime_information.yml
|
|
langs:
|
|
- java
|
|
name: setRuntimeInformation(final long sequenceNumber, final Instant enqueuedTime, final String offset)
|
|
nameWithType: ReceiverRuntimeInformation.setRuntimeInformation(final long sequenceNumber, final Instant enqueuedTime, final String offset)
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation.setRuntimeInformation(final long sequenceNumber, final Instant enqueuedTime, final String offset)
|
|
overload: com.microsoft.azure.eventhubs._receiver_runtime_information.setRuntimeInformation*
|
|
type: Method
|
|
source:
|
|
remote: *o0
|
|
path: azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/ReceiverRuntimeInformation.java
|
|
startLine: 75
|
|
package: com.microsoft.azure.eventhubs
|
|
syntax:
|
|
content: public void setRuntimeInformation(final long sequenceNumber, final Instant enqueuedTime, final String offset)
|
|
parameters:
|
|
- id: sequenceNumber
|
|
type: 4c60ae65
|
|
- id: enqueuedTime
|
|
type: 57532c1c
|
|
- id: offset
|
|
type: 3d93591e
|
|
references:
|
|
- uid: 3d93591e
|
|
spec.java:
|
|
- name: final String
|
|
fullName: final String
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information.ReceiverRuntimeInformation*
|
|
name: ReceiverRuntimeInformation
|
|
nameWithType: ReceiverRuntimeInformation.ReceiverRuntimeInformation
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation.ReceiverRuntimeInformation
|
|
package: com.microsoft.azure.eventhubs
|
|
- uid: "26831127"
|
|
spec.java:
|
|
- name: String
|
|
fullName: String
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information.getPartitionId*
|
|
name: getPartitionId
|
|
nameWithType: ReceiverRuntimeInformation.getPartitionId
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation.getPartitionId
|
|
package: com.microsoft.azure.eventhubs
|
|
- uid: 0364520f
|
|
spec.java:
|
|
- name: long
|
|
fullName: long
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information.getLastEnqueuedSequenceNumber*
|
|
name: getLastEnqueuedSequenceNumber
|
|
nameWithType: ReceiverRuntimeInformation.getLastEnqueuedSequenceNumber
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation.getLastEnqueuedSequenceNumber
|
|
package: com.microsoft.azure.eventhubs
|
|
- uid: 328f8254
|
|
spec.java:
|
|
- name: Instant
|
|
fullName: Instant
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information.getLastEnqueuedTime*
|
|
name: getLastEnqueuedTime
|
|
nameWithType: ReceiverRuntimeInformation.getLastEnqueuedTime
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation.getLastEnqueuedTime
|
|
package: com.microsoft.azure.eventhubs
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information.getLastEnqueuedOffset*
|
|
name: getLastEnqueuedOffset
|
|
nameWithType: ReceiverRuntimeInformation.getLastEnqueuedOffset
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation.getLastEnqueuedOffset
|
|
package: com.microsoft.azure.eventhubs
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information.getRetrievalTime*
|
|
name: getRetrievalTime
|
|
nameWithType: ReceiverRuntimeInformation.getRetrievalTime
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation.getRetrievalTime
|
|
package: com.microsoft.azure.eventhubs
|
|
- uid: 4c60ae65
|
|
spec.java:
|
|
- name: final long
|
|
fullName: final long
|
|
- uid: 57532c1c
|
|
spec.java:
|
|
- name: final Instant
|
|
fullName: final Instant
|
|
- uid: com.microsoft.azure.eventhubs._receiver_runtime_information.setRuntimeInformation*
|
|
name: setRuntimeInformation
|
|
nameWithType: ReceiverRuntimeInformation.setRuntimeInformation
|
|
fullName: com.microsoft.azure.eventhubs.ReceiverRuntimeInformation.setRuntimeInformation
|
|
package: com.microsoft.azure.eventhubs
|
|
- uid: com.microsoft.azure.eventhubs._event_data
|
|
parent: com.microsoft.azure.eventhubs
|
|
href: com.microsoft.azure.eventhubs._event_data.yml
|
|
name: EventData
|
|
nameWithType: EventData
|
|
fullName: com.microsoft.azure.eventhubs.EventData
|
|
type: Interface
|
|
summary: >-
|
|
<p>The data structure encapsulating the Event being sent-to and received-from EventHubs. Each EventHubs partition can be visualized as a Stream of <xref uid="com.microsoft.azure.eventhubs._event_data" data-throw-if-not-resolved="false">EventData</xref>. </p>
|
|
|
|
<p>Serializing a received <xref uid="com.microsoft.azure.eventhubs._event_data" data-throw-if-not-resolved="false">EventData</xref> with AMQP sections other than ApplicationProperties (with primitive java types) and Data section is not supported. </p>
|
|
|
|
<p>Here's how AMQP message sections map to <xref uid="com.microsoft.azure.eventhubs._event_data" data-throw-if-not-resolved="false">EventData</xref>. Here's the reference used for AMQP 1.0 specification: <a href="http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-complete-v1.0-os.pdf">http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-complete-v1.0-os.pdf</a><pre>
|
|
|
|
i. <xref uid="com.microsoft.azure.eventhubs._event_data.getProperties()" data-throw-if-not-resolved="false">getProperties()</xref> - AMQPMessage.ApplicationProperties section
|
|
|
|
ii. <xref uid="com.microsoft.azure.eventhubs._event_data.getBytes()" data-throw-if-not-resolved="false">getBytes()</xref> - if AMQPMessage.Body has Data section
|
|
|
|
iii. <xref uid="com.microsoft.azure.eventhubs._event_data.getObject()" data-throw-if-not-resolved="false">getObject()</xref> - if AMQPMessage.Body has AMQPValue or AMQPSequence sections
|
|
|
|
</pre> While using client libraries released by Microsoft Azure EventHubs, sections (i) and (ii) alone are sufficient. Section (iii) is used for advanced scenarios, where the sending application uses third-party AMQP library to send the message to EventHubs and the receiving application uses this client library to receive <xref uid="com.microsoft.azure.eventhubs._event_data" data-throw-if-not-resolved="false">EventData</xref>. </p>
|
|
syntax:
|
|
content: public interface EventData
|