110 строки
9.8 KiB
YAML
110 строки
9.8 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.messaging.eventhubs.models.CreateBatchOptions"
|
|
fullName: "com.azure.messaging.eventhubs.models.CreateBatchOptions"
|
|
name: "CreateBatchOptions"
|
|
nameWithType: "CreateBatchOptions"
|
|
summary: "The set of options that can be specified when creating an <xref uid=\"com.azure.messaging.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventDataBatch\"></xref>."
|
|
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 class **CreateBatchOptions**"
|
|
constructors:
|
|
- uid: "com.azure.messaging.eventhubs.models.CreateBatchOptions.CreateBatchOptions()"
|
|
fullName: "com.azure.messaging.eventhubs.models.CreateBatchOptions.CreateBatchOptions()"
|
|
name: "CreateBatchOptions()"
|
|
nameWithType: "CreateBatchOptions.CreateBatchOptions()"
|
|
summary: "Creates a new instance."
|
|
syntax: "public CreateBatchOptions()"
|
|
desc: "Creates a new instance."
|
|
methods:
|
|
- uid: "com.azure.messaging.eventhubs.models.CreateBatchOptions.getMaximumSizeInBytes()"
|
|
fullName: "com.azure.messaging.eventhubs.models.CreateBatchOptions.getMaximumSizeInBytes()"
|
|
name: "getMaximumSizeInBytes()"
|
|
nameWithType: "CreateBatchOptions.getMaximumSizeInBytes()"
|
|
summary: "Gets the maximum size to allow for the batch of events, in bytes."
|
|
syntax: "public int getMaximumSizeInBytes()"
|
|
desc: "Gets the maximum size to allow for the batch of events, in bytes."
|
|
returns:
|
|
description: "The maximum size to allow for a single batch of events, in bytes."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventhubs.models.CreateBatchOptions.getPartitionId()"
|
|
fullName: "com.azure.messaging.eventhubs.models.CreateBatchOptions.getPartitionId()"
|
|
name: "getPartitionId()"
|
|
nameWithType: "CreateBatchOptions.getPartitionId()"
|
|
summary: "Gets the identifier of the Event Hub partition that the events in the <xref uid=\"com.azure.messaging.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventDataBatch\"></xref> will be sent to."
|
|
syntax: "public String getPartitionId()"
|
|
desc: "Gets the identifier of the Event Hub partition that the events in the <xref uid=\"com.azure.messaging.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventDataBatch\"></xref> will be sent to. If the identifier is not specified, the Event Hubs service will be responsible for routing events that are sent to an available partition."
|
|
returns:
|
|
description: "The identifier of the Event Hub partition that the <xref uid=\"com.azure.messaging.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventDataBatch\"></xref> will be set to. <code>null</code> or\n an empty string if Event Hubs service is responsible for routing events."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.eventhubs.models.CreateBatchOptions.getPartitionKey()"
|
|
fullName: "com.azure.messaging.eventhubs.models.CreateBatchOptions.getPartitionKey()"
|
|
name: "getPartitionKey()"
|
|
nameWithType: "CreateBatchOptions.getPartitionKey()"
|
|
summary: "Gets the partition routing key on an event batch."
|
|
syntax: "public String getPartitionKey()"
|
|
desc: "Gets the partition routing key on an event batch. If specified, tells the Event Hubs service that these events belong to the same group and should belong to the same partition."
|
|
returns:
|
|
description: "The partition hashing key to associate with the event or batch of events."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.eventhubs.models.CreateBatchOptions.setMaximumSizeInBytes(int)"
|
|
fullName: "com.azure.messaging.eventhubs.models.CreateBatchOptions.setMaximumSizeInBytes(int maximumSizeInBytes)"
|
|
name: "setMaximumSizeInBytes(int maximumSizeInBytes)"
|
|
nameWithType: "CreateBatchOptions.setMaximumSizeInBytes(int maximumSizeInBytes)"
|
|
summary: "Sets the maximum size for the <xref uid=\"com.azure.messaging.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"batch of events\"></xref>, in bytes."
|
|
parameters:
|
|
- description: "The maximum size to allow for the <xref uid=\"com.azure.messaging.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"batch of events\"></xref>."
|
|
name: "maximumSizeInBytes"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public CreateBatchOptions setMaximumSizeInBytes(int maximumSizeInBytes)"
|
|
desc: "Sets the maximum size for the <xref uid=\"com.azure.messaging.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"batch of events\"></xref>, in bytes."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.messaging.eventhubs.models.CreateBatchOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CreateBatchOptions\"></xref> object."
|
|
type: "<xref href=\"com.azure.messaging.eventhubs.models.CreateBatchOptions?alt=com.azure.messaging.eventhubs.models.CreateBatchOptions&text=CreateBatchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventhubs.models.CreateBatchOptions.setPartitionId(java.lang.String)"
|
|
fullName: "com.azure.messaging.eventhubs.models.CreateBatchOptions.setPartitionId(String partitionId)"
|
|
name: "setPartitionId(String partitionId)"
|
|
nameWithType: "CreateBatchOptions.setPartitionId(String partitionId)"
|
|
summary: "Sets the identifier of the Event Hub partition that the events in the <xref uid=\"com.azure.messaging.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventDataBatch\"></xref> will be sent to."
|
|
parameters:
|
|
- description: "The identifier of the Event Hub partition that the <xref uid=\"com.azure.messaging.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"batch's\"></xref> events\n will be sent to. <code>null</code> or an empty string if Event Hubs service is responsible for routing events."
|
|
name: "partitionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CreateBatchOptions setPartitionId(String partitionId)"
|
|
desc: "Sets the identifier of the Event Hub partition that the events in the <xref uid=\"com.azure.messaging.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventDataBatch\"></xref> will be sent to. If the identifier is not specified, the Event Hubs service will be responsible for routing events that are sent to an available partition."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.messaging.eventhubs.models.CreateBatchOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CreateBatchOptions\"></xref> object."
|
|
type: "<xref href=\"com.azure.messaging.eventhubs.models.CreateBatchOptions?alt=com.azure.messaging.eventhubs.models.CreateBatchOptions&text=CreateBatchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventhubs.models.CreateBatchOptions.setPartitionKey(java.lang.String)"
|
|
fullName: "com.azure.messaging.eventhubs.models.CreateBatchOptions.setPartitionKey(String partitionKey)"
|
|
name: "setPartitionKey(String partitionKey)"
|
|
nameWithType: "CreateBatchOptions.setPartitionKey(String partitionKey)"
|
|
summary: "Sets a hashing key to be provided for the batch of events."
|
|
parameters:
|
|
- description: "The partition hashing key to associate with the event or batch of events."
|
|
name: "partitionKey"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public CreateBatchOptions setPartitionKey(String partitionKey)"
|
|
desc: "Sets a hashing key to be provided for the batch of events. Events with the same `partitionKey` are hashed and sent to the same partition."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.messaging.eventhubs.models.CreateBatchOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"CreateBatchOptions\"></xref> object."
|
|
type: "<xref href=\"com.azure.messaging.eventhubs.models.CreateBatchOptions?alt=com.azure.messaging.eventhubs.models.CreateBatchOptions&text=CreateBatchOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The set of options that can be specified when creating an <xref uid=\"com.azure.messaging.eventhubs.EventDataBatch\" data-throw-if-not-resolved=\"false\" data-raw-source=\"EventDataBatch\"></xref>."
|
|
metadata: {}
|
|
package: "com.azure.messaging.eventhubs.models"
|
|
artifact: com.azure:azure-messaging-eventhubs:5.19.1
|