86 строки
7.9 KiB
YAML
86 строки
7.9 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.messaging.eventhubs.models.SendOptions"
|
|
fullName: "com.azure.messaging.eventhubs.models.SendOptions"
|
|
name: "SendOptions"
|
|
nameWithType: "SendOptions"
|
|
summary: "The set of options that can be specified when sending a set of events to influence the way in which events are sent to the Event Hubs service."
|
|
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 **SendOptions**"
|
|
constructors:
|
|
- uid: "com.azure.messaging.eventhubs.models.SendOptions.SendOptions()"
|
|
fullName: "com.azure.messaging.eventhubs.models.SendOptions.SendOptions()"
|
|
name: "SendOptions()"
|
|
nameWithType: "SendOptions.SendOptions()"
|
|
summary: "Creates a new instance."
|
|
syntax: "public SendOptions()"
|
|
desc: "Creates a new instance."
|
|
methods:
|
|
- uid: "com.azure.messaging.eventhubs.models.SendOptions.getPartitionId()"
|
|
fullName: "com.azure.messaging.eventhubs.models.SendOptions.getPartitionId()"
|
|
name: "getPartitionId()"
|
|
nameWithType: "SendOptions.getPartitionId()"
|
|
summary: "Gets the identifier of the Event Hub partition that the <xref uid=\"com.azure.messaging.eventhubs.EventData\" data-throw-if-not-resolved=\"false\" data-raw-source=\"events\"></xref> will be sent to."
|
|
syntax: "public String getPartitionId()"
|
|
desc: "Gets the identifier of the Event Hub partition that the <xref uid=\"com.azure.messaging.eventhubs.EventData\" data-throw-if-not-resolved=\"false\" data-raw-source=\"events\"></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.EventData\" data-throw-if-not-resolved=\"false\" data-raw-source=\"events\"></xref> will be set to. <code>null</code>\n or 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.SendOptions.getPartitionKey()"
|
|
fullName: "com.azure.messaging.eventhubs.models.SendOptions.getPartitionKey()"
|
|
name: "getPartitionKey()"
|
|
nameWithType: "SendOptions.getPartitionKey()"
|
|
summary: "Gets the hashing key on an event batch."
|
|
syntax: "public String getPartitionKey()"
|
|
desc: "Gets the hashing 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.SendOptions.setPartitionId(java.lang.String)"
|
|
fullName: "com.azure.messaging.eventhubs.models.SendOptions.setPartitionId(String partitionId)"
|
|
name: "setPartitionId(String partitionId)"
|
|
nameWithType: "SendOptions.setPartitionId(String partitionId)"
|
|
summary: "Sets the identifier of the Event Hub partition that the <xref uid=\"com.azure.messaging.eventhubs.EventData\" data-throw-if-not-resolved=\"false\" data-raw-source=\"events\"></xref> will be sent to."
|
|
parameters:
|
|
- description: "The identifier of the Event Hub partition that the <xref uid=\"com.azure.messaging.eventhubs.EventData\" data-throw-if-not-resolved=\"false\" data-raw-source=\"events\"></xref> will be set\n 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 SendOptions setPartitionId(String partitionId)"
|
|
desc: "Sets the identifier of the Event Hub partition that the <xref uid=\"com.azure.messaging.eventhubs.EventData\" data-throw-if-not-resolved=\"false\" data-raw-source=\"events\"></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.SendOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SendOptions\"></xref> object."
|
|
type: "<xref href=\"com.azure.messaging.eventhubs.models.SendOptions?alt=com.azure.messaging.eventhubs.models.SendOptions&text=SendOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventhubs.models.SendOptions.setPartitionKey(java.lang.String)"
|
|
fullName: "com.azure.messaging.eventhubs.models.SendOptions.setPartitionKey(String partitionKey)"
|
|
name: "setPartitionKey(String partitionKey)"
|
|
nameWithType: "SendOptions.setPartitionKey(String partitionKey)"
|
|
summary: "Sets a hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition."
|
|
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 SendOptions setPartitionKey(String partitionKey)"
|
|
desc: "Sets a hashing key to be provided for the batch of events, which instructs the Event Hubs service to map this key to a specific partition.\n\nThe selection of a partition is stable for a given partition hashing key. Should any other batches of events be sent using the same exact partition hashing key, the Event Hubs service will route them all to the same partition.\n\nThis should be specified only when there is a need to group events by partition, but there is flexibility into which partition they are routed. If ensuring that a batch of events is sent only to a specific partition, it is recommended that the <xref uid=\"com.azure.messaging.eventhubs.models.SendOptions.setPartitionId(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"identifier of the position be specified directly\"></xref> when sending the batch."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.messaging.eventhubs.models.SendOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SendOptions\"></xref> object."
|
|
type: "<xref href=\"com.azure.messaging.eventhubs.models.SendOptions?alt=com.azure.messaging.eventhubs.models.SendOptions&text=SendOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The set of options that can be specified when sending a set of events to influence the way in which events are sent to the Event Hubs service."
|
|
metadata: {}
|
|
package: "com.azure.messaging.eventhubs.models"
|
|
artifact: com.azure:azure-messaging-eventhubs:5.19.1
|