45 строки
3.5 KiB
YAML
45 строки
3.5 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.eventhubs.EventDataBatch"
|
|
fullName: "com.microsoft.azure.eventhubs.EventDataBatch"
|
|
name: "EventDataBatch"
|
|
nameWithType: "EventDataBatch"
|
|
summary: "Helper for creating a batch/collection of Event<wbr>Data objects to be used while Sending to Event<wbr>Hubs"
|
|
syntax: "public interface **EventDataBatch**"
|
|
methods:
|
|
- uid: "com.microsoft.azure.eventhubs.EventDataBatch.getSize()"
|
|
fullName: "com.microsoft.azure.eventhubs.EventDataBatch.getSize()"
|
|
name: "getSize()"
|
|
nameWithType: "EventDataBatch.getSize()"
|
|
summary: "Get the number of events present in this <xref uid=\"com.microsoft.azure.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventDataBatch\"></xref>"
|
|
modifiers:
|
|
- "abstract"
|
|
syntax: "public abstract int getSize()"
|
|
desc: "Get the number of events present in this <xref uid=\"com.microsoft.azure.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventDataBatch\"></xref>"
|
|
returns:
|
|
description: "the EventDataBatch size"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.eventhubs.EventDataBatch.tryAdd(com.microsoft.azure.eventhubs.EventData)"
|
|
fullName: "com.microsoft.azure.eventhubs.EventDataBatch.tryAdd(EventData eventData)"
|
|
name: "tryAdd(EventData eventData)"
|
|
nameWithType: "EventDataBatch.tryAdd(EventData eventData)"
|
|
summary: "Add's <xref uid=\"com.microsoft.azure.eventhubs.EventData\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventData\"></xref> to <xref uid=\"com.microsoft.azure.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventDataBatch\"></xref>, if permitted by the batch's size limit."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The <xref uid=\"com.microsoft.azure.eventhubs.EventData\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventData\"></xref> to add."
|
|
name: "eventData"
|
|
type: "<xref href=\"com.microsoft.azure.eventhubs.EventData?alt=com.microsoft.azure.eventhubs.EventData&text=EventData\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract boolean tryAdd(EventData eventData)"
|
|
exceptions:
|
|
- description: "when a single <xref uid=\"EventData\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventData\"></xref> instance exceeds maximum allowed size of the batch"
|
|
type: "<xref href=\"com.microsoft.azure.eventhubs.PayloadSizeExceededException?alt=com.microsoft.azure.eventhubs.PayloadSizeExceededException&text=PayloadSizeExceededException\" data-throw-if-not-resolved=\"False\" />"
|
|
desc: "Add's <xref uid=\"com.microsoft.azure.eventhubs.EventData\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventData\"></xref> to <xref uid=\"com.microsoft.azure.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventDataBatch\"></xref>, if permitted by the batch's size limit. This method is not thread-safe."
|
|
returns:
|
|
description: "A boolean value indicating if the <xref uid=\"com.microsoft.azure.eventhubs.EventData\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventData\"></xref> addition to this batch/collection was successful or not."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "interface"
|
|
desc: "Helper for creating a batch/collection of EventData objects to be used while Sending to EventHubs"
|
|
metadata: {}
|
|
package: "com.microsoft.azure.eventhubs"
|
|
artifact: com.microsoft.azure:azure-eventhubs:3.2.2
|