174 строки
11 KiB
YAML
174 строки
11 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.eventhubs.EventPosition"
|
|
fullName: "com.microsoft.azure.eventhubs.EventPosition"
|
|
name: "EventPosition"
|
|
nameWithType: "EventPosition"
|
|
summary: "Defines a position of an <xref uid=\"com.microsoft.azure.eventhubs.EventData\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventData\"></xref> in the event hub partition."
|
|
syntax: "public interface **EventPosition**</br> extends <a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html\">Serializable</a>"
|
|
methods:
|
|
- uid: "com.microsoft.azure.eventhubs.EventPosition.fromEndOfStream()"
|
|
fullName: "com.microsoft.azure.eventhubs.EventPosition.fromEndOfStream()"
|
|
name: "fromEndOfStream()"
|
|
nameWithType: "EventPosition.fromEndOfStream()"
|
|
summary: "Returns the position for the end of a stream."
|
|
modifiers:
|
|
- "static"
|
|
syntax: "public static EventPosition fromEndOfStream()"
|
|
desc: "Returns the position for the end of a stream. Provide this position in receiver creation to start receiving from the next available event in the partition after the receiver is created."
|
|
returns:
|
|
description: "An <xref uid=\"com.microsoft.azure.eventhubs.EventPosition\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventPosition\"></xref> set to the end of an Event Hubs stream."
|
|
type: "<xref href=\"com.microsoft.azure.eventhubs.EventPosition?alt=com.microsoft.azure.eventhubs.EventPosition&text=EventPosition\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventhubs.EventPosition.fromEnqueuedTime(java.time.Instant)"
|
|
fullName: "com.microsoft.azure.eventhubs.EventPosition.fromEnqueuedTime(Instant dateTime)"
|
|
name: "fromEnqueuedTime(Instant dateTime)"
|
|
nameWithType: "EventPosition.fromEnqueuedTime(Instant dateTime)"
|
|
summary: "Creates a position at the given <xref uid=\"java.time.Instant\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Instant\"></xref>."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "is the enqueued time of the event."
|
|
name: "dateTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Instant.html\">Instant</a>"
|
|
syntax: "public static EventPosition fromEnqueuedTime(Instant dateTime)"
|
|
desc: "Creates a position at the given <xref uid=\"java.time.Instant\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Instant\"></xref>."
|
|
returns:
|
|
description: "An <xref uid=\"com.microsoft.azure.eventhubs.EventPosition\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventPosition\"></xref> object."
|
|
type: "<xref href=\"com.microsoft.azure.eventhubs.EventPosition?alt=com.microsoft.azure.eventhubs.EventPosition&text=EventPosition\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventhubs.EventPosition.fromOffset(java.lang.String)"
|
|
fullName: "com.microsoft.azure.eventhubs.EventPosition.fromOffset(String offset)"
|
|
name: "fromOffset(String offset)"
|
|
nameWithType: "EventPosition.fromOffset(String offset)"
|
|
summary: "Creates a position at the given offset."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "is the byte offset of the event."
|
|
name: "offset"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public static EventPosition fromOffset(String offset)"
|
|
desc: "Creates a position at the given offset. The specified event will not be included. Instead, the next event is returned."
|
|
returns:
|
|
description: "An <xref uid=\"com.microsoft.azure.eventhubs.EventPosition\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventPosition\"></xref> object."
|
|
type: "<xref href=\"com.microsoft.azure.eventhubs.EventPosition?alt=com.microsoft.azure.eventhubs.EventPosition&text=EventPosition\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventhubs.EventPosition.fromOffset(java.lang.String,boolean)"
|
|
fullName: "com.microsoft.azure.eventhubs.EventPosition.fromOffset(String offset, boolean inclusiveFlag)"
|
|
name: "fromOffset(String offset, boolean inclusiveFlag)"
|
|
nameWithType: "EventPosition.fromOffset(String offset, boolean inclusiveFlag)"
|
|
summary: "Creates a position at the given offset."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "is the byte offset of the event."
|
|
name: "offset"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "will include the specified event when set to true; otherwise, the next event is returned."
|
|
name: "inclusiveFlag"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static EventPosition fromOffset(String offset, boolean inclusiveFlag)"
|
|
desc: "Creates a position at the given offset."
|
|
returns:
|
|
description: "An <xref uid=\"com.microsoft.azure.eventhubs.EventPosition\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventPosition\"></xref> object."
|
|
type: "<xref href=\"com.microsoft.azure.eventhubs.EventPosition?alt=com.microsoft.azure.eventhubs.EventPosition&text=EventPosition\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventhubs.EventPosition.fromSequenceNumber(java.lang.Long)"
|
|
fullName: "com.microsoft.azure.eventhubs.EventPosition.fromSequenceNumber(Long sequenceNumber)"
|
|
name: "fromSequenceNumber(Long sequenceNumber)"
|
|
nameWithType: "EventPosition.fromSequenceNumber(Long sequenceNumber)"
|
|
summary: "Creates a position at the given sequence number."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "is the sequence number of the event."
|
|
name: "sequenceNumber"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
syntax: "public static EventPosition fromSequenceNumber(Long sequenceNumber)"
|
|
desc: "Creates a position at the given sequence number. The specified event will not be included. Instead, the next event is returned."
|
|
returns:
|
|
description: "An <xref uid=\"com.microsoft.azure.eventhubs.EventPosition\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventPosition\"></xref> object."
|
|
type: "<xref href=\"com.microsoft.azure.eventhubs.EventPosition?alt=com.microsoft.azure.eventhubs.EventPosition&text=EventPosition\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventhubs.EventPosition.fromSequenceNumber(java.lang.Long,boolean)"
|
|
fullName: "com.microsoft.azure.eventhubs.EventPosition.fromSequenceNumber(Long sequenceNumber, boolean inclusiveFlag)"
|
|
name: "fromSequenceNumber(Long sequenceNumber, boolean inclusiveFlag)"
|
|
nameWithType: "EventPosition.fromSequenceNumber(Long sequenceNumber, boolean inclusiveFlag)"
|
|
summary: "Creates a position at the given sequence number."
|
|
modifiers:
|
|
- "static"
|
|
parameters:
|
|
- description: "is the sequence number of the event."
|
|
name: "sequenceNumber"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
- description: "will include the specified event when set to true; otherwise, the next event is returned."
|
|
name: "inclusiveFlag"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public static EventPosition fromSequenceNumber(Long sequenceNumber, boolean inclusiveFlag)"
|
|
desc: "Creates a position at the given sequence number. The specified event will not be included. Instead, the next event is returned."
|
|
returns:
|
|
description: "An <xref uid=\"com.microsoft.azure.eventhubs.EventPosition\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventPosition\"></xref> object."
|
|
type: "<xref href=\"com.microsoft.azure.eventhubs.EventPosition?alt=com.microsoft.azure.eventhubs.EventPosition&text=EventPosition\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventhubs.EventPosition.fromStartOfStream()"
|
|
fullName: "com.microsoft.azure.eventhubs.EventPosition.fromStartOfStream()"
|
|
name: "fromStartOfStream()"
|
|
nameWithType: "EventPosition.fromStartOfStream()"
|
|
summary: "Returns the position for the start of a stream."
|
|
modifiers:
|
|
- "static"
|
|
syntax: "public static EventPosition fromStartOfStream()"
|
|
desc: "Returns the position for the start of a stream. Provide this position in receiver creation to start receiving from the first available event in the partition."
|
|
returns:
|
|
description: "An <xref uid=\"com.microsoft.azure.eventhubs.EventPosition\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventPosition\"></xref> set to the start of an Event Hubs stream."
|
|
type: "<xref href=\"com.microsoft.azure.eventhubs.EventPosition?alt=com.microsoft.azure.eventhubs.EventPosition&text=EventPosition\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventhubs.EventPosition.getEnqueuedTime()"
|
|
fullName: "com.microsoft.azure.eventhubs.EventPosition.getEnqueuedTime()"
|
|
name: "getEnqueuedTime()"
|
|
nameWithType: "EventPosition.getEnqueuedTime()"
|
|
summary: "Gets the enqueued time."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Instant getEnqueuedTime()"
|
|
desc: "Gets the enqueued time."
|
|
returns:
|
|
description: "the enqueued time."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Instant.html\">Instant</a>"
|
|
- uid: "com.microsoft.azure.eventhubs.EventPosition.getInclusiveFlag()"
|
|
fullName: "com.microsoft.azure.eventhubs.EventPosition.getInclusiveFlag()"
|
|
name: "getInclusiveFlag()"
|
|
nameWithType: "EventPosition.getInclusiveFlag()"
|
|
summary: "Gets the inclusive value."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract boolean getInclusiveFlag()"
|
|
desc: "Gets the inclusive value."
|
|
returns:
|
|
description: "the inclusive value."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventhubs.EventPosition.getOffset()"
|
|
fullName: "com.microsoft.azure.eventhubs.EventPosition.getOffset()"
|
|
name: "getOffset()"
|
|
nameWithType: "EventPosition.getOffset()"
|
|
summary: "Gets the offset."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract String getOffset()"
|
|
desc: "Gets the offset."
|
|
returns:
|
|
description: "the offset."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.eventhubs.EventPosition.getSequenceNumber()"
|
|
fullName: "com.microsoft.azure.eventhubs.EventPosition.getSequenceNumber()"
|
|
name: "getSequenceNumber()"
|
|
nameWithType: "EventPosition.getSequenceNumber()"
|
|
summary: "Gets the sequence number."
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract Long getSequenceNumber()"
|
|
desc: "Gets the sequence number."
|
|
returns:
|
|
description: "the sequence number."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
type: "interface"
|
|
desc: "Defines a position of an <xref uid=\"com.microsoft.azure.eventhubs.EventData\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventData\"></xref> in the event hub partition. The position can be an Offset, Sequence Number, or EnqueuedTime."
|
|
implements:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html\">Serializable</a>"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.eventhubs"
|
|
artifact: com.microsoft.azure:azure-eventhubs:3.2.2
|