206 строки
16 KiB
YAML
206 строки
16 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.messaging.eventhubs.models.PartitionOwnership"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership"
|
|
name: "PartitionOwnership"
|
|
nameWithType: "PartitionOwnership"
|
|
summary: "A model class to hold partition ownership information."
|
|
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 **PartitionOwnership**"
|
|
constructors:
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.PartitionOwnership()"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.PartitionOwnership()"
|
|
name: "PartitionOwnership()"
|
|
nameWithType: "PartitionOwnership.PartitionOwnership()"
|
|
summary: "Creates a new instance."
|
|
syntax: "public PartitionOwnership()"
|
|
desc: "Creates a new instance."
|
|
methods:
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.getConsumerGroup()"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.getConsumerGroup()"
|
|
name: "getConsumerGroup()"
|
|
nameWithType: "PartitionOwnership.getConsumerGroup()"
|
|
summary: "Gets the consumer group name associated with this ownership record."
|
|
syntax: "public String getConsumerGroup()"
|
|
desc: "Gets the consumer group name associated with this ownership record."
|
|
returns:
|
|
description: "The consumer group name associated with this ownership record."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.getETag()"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.getETag()"
|
|
name: "getETag()"
|
|
nameWithType: "PartitionOwnership.getETag()"
|
|
summary: "Gets the ETag that was generated by the last known successful update to the partition ownership record."
|
|
syntax: "public String getETag()"
|
|
desc: "Gets the ETag that was generated by the last known successful update to the partition ownership record. An ETag is a unique identifier \\* that is generated when a data record is successfully created/updated. The ETag is used to achieve optimistic concurrency in a distributed event processor setup. When multiple instances of event processor try to update the same partition ownership record, ETag is used to verify that the last values read by the instance requesting the update is still the latest ETag for this record. If the ETag in the store does not match the ETag in the update request, then the update is expected to fail as there was an update since the last time an event processor read this record."
|
|
returns:
|
|
description: "The eTag for this ownership record."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.getEventHubName()"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.getEventHubName()"
|
|
name: "getEventHubName()"
|
|
nameWithType: "PartitionOwnership.getEventHubName()"
|
|
summary: "Gets the Event Hub name associated with this ownership record."
|
|
syntax: "public String getEventHubName()"
|
|
desc: "Gets the Event Hub name associated with this ownership record."
|
|
returns:
|
|
description: "The Event Hub name associated with this ownership record."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.getFullyQualifiedNamespace()"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.getFullyQualifiedNamespace()"
|
|
name: "getFullyQualifiedNamespace()"
|
|
nameWithType: "PartitionOwnership.getFullyQualifiedNamespace()"
|
|
summary: "Returns the fully qualified namespace of the Event Hub."
|
|
syntax: "public String getFullyQualifiedNamespace()"
|
|
desc: "Returns the fully qualified namespace of the Event Hub."
|
|
returns:
|
|
description: "the fully qualified namespace of the Event Hub."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.getLastModifiedTime()"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.getLastModifiedTime()"
|
|
name: "getLastModifiedTime()"
|
|
nameWithType: "PartitionOwnership.getLastModifiedTime()"
|
|
summary: "Gets the last modified time of this ownership record as epoch millis."
|
|
syntax: "public Long getLastModifiedTime()"
|
|
desc: "Gets the last modified time of this ownership record as epoch millis."
|
|
returns:
|
|
description: "The last modified time of this ownership record as epoch millis."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.getOwnerId()"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.getOwnerId()"
|
|
name: "getOwnerId()"
|
|
nameWithType: "PartitionOwnership.getOwnerId()"
|
|
summary: "Sets the unique event processor identifier as the owner of the partition id in this ownership record."
|
|
syntax: "public String getOwnerId()"
|
|
desc: "Sets the unique event processor identifier as the owner of the partition id in this ownership record."
|
|
returns:
|
|
description: "The unique event processor identifier as the owner of the partition id in this ownership record."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.getPartitionId()"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.getPartitionId()"
|
|
name: "getPartitionId()"
|
|
nameWithType: "PartitionOwnership.getPartitionId()"
|
|
summary: "Gets the partition id associated with this ownership record."
|
|
syntax: "public String getPartitionId()"
|
|
desc: "Gets the partition id associated with this ownership record."
|
|
returns:
|
|
description: "The partition id associated with this ownership record."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.setConsumerGroup(java.lang.String)"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.setConsumerGroup(String consumerGroup)"
|
|
name: "setConsumerGroup(String consumerGroup)"
|
|
nameWithType: "PartitionOwnership.setConsumerGroup(String consumerGroup)"
|
|
summary: "Sets the consumer group name associated with this ownership record."
|
|
parameters:
|
|
- description: "The consumer group name associated with this ownership record."
|
|
name: "consumerGroup"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PartitionOwnership setConsumerGroup(String consumerGroup)"
|
|
desc: "Sets the consumer group name associated with this ownership record."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.messaging.eventhubs.models.PartitionOwnership\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PartitionOwnership\"></xref> instance."
|
|
type: "<xref href=\"com.azure.messaging.eventhubs.models.PartitionOwnership?alt=com.azure.messaging.eventhubs.models.PartitionOwnership&text=PartitionOwnership\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.setETag(java.lang.String)"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.setETag(String eTag)"
|
|
name: "setETag(String eTag)"
|
|
nameWithType: "PartitionOwnership.setETag(String eTag)"
|
|
summary: "Sets the ETag with the last known successful update to partition ownership record."
|
|
parameters:
|
|
- description: "The eTag for this ownership record."
|
|
name: "eTag"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PartitionOwnership setETag(String eTag)"
|
|
desc: "Sets the ETag with the last known successful update to partition ownership record. An ETag is a unique identifier that is generated when a data record is successfully created/updated. This ETag is used to achieve optimistic concurrency in a distributed event processor setup. When multiple instances of event processor try to update the same partition ownership record, ETag is used to verify that the last values read by the instance requesting the update is still the latest ETag for this record. If the ETag in the store does not match the ETag in the update request, then the update is expected to fail as there was an update since the last time an event processor read this record."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.messaging.eventhubs.models.PartitionOwnership\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PartitionOwnership\"></xref> instance."
|
|
type: "<xref href=\"com.azure.messaging.eventhubs.models.PartitionOwnership?alt=com.azure.messaging.eventhubs.models.PartitionOwnership&text=PartitionOwnership\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.setEventHubName(java.lang.String)"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.setEventHubName(String eventHubName)"
|
|
name: "setEventHubName(String eventHubName)"
|
|
nameWithType: "PartitionOwnership.setEventHubName(String eventHubName)"
|
|
summary: "Sets the Event Hub name associated with this ownership record."
|
|
parameters:
|
|
- description: "The Event Hub name associated with this ownership record."
|
|
name: "eventHubName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PartitionOwnership setEventHubName(String eventHubName)"
|
|
desc: "Sets the Event Hub name associated with this ownership record."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.messaging.eventhubs.models.PartitionOwnership\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PartitionOwnership\"></xref> instance."
|
|
type: "<xref href=\"com.azure.messaging.eventhubs.models.PartitionOwnership?alt=com.azure.messaging.eventhubs.models.PartitionOwnership&text=PartitionOwnership\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.setFullyQualifiedNamespace(java.lang.String)"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.setFullyQualifiedNamespace(String fullyQualifiedNamespace)"
|
|
name: "setFullyQualifiedNamespace(String fullyQualifiedNamespace)"
|
|
nameWithType: "PartitionOwnership.setFullyQualifiedNamespace(String fullyQualifiedNamespace)"
|
|
summary: "Sets the fully qualified namespace of the Event Hub."
|
|
parameters:
|
|
- description: "the fully qualified namespace of the Event Hub."
|
|
name: "fullyQualifiedNamespace"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PartitionOwnership setFullyQualifiedNamespace(String fullyQualifiedNamespace)"
|
|
desc: "Sets the fully qualified namespace of the Event Hub."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.messaging.eventhubs.models.PartitionOwnership\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PartitionOwnership\"></xref> instance."
|
|
type: "<xref href=\"com.azure.messaging.eventhubs.models.PartitionOwnership?alt=com.azure.messaging.eventhubs.models.PartitionOwnership&text=PartitionOwnership\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.setLastModifiedTime(java.lang.Long)"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.setLastModifiedTime(Long lastModifiedTime)"
|
|
name: "setLastModifiedTime(Long lastModifiedTime)"
|
|
nameWithType: "PartitionOwnership.setLastModifiedTime(Long lastModifiedTime)"
|
|
summary: "Sets the last modified time of this ownership record as epoch millis."
|
|
parameters:
|
|
- description: "The last modified time of this ownership record as epoch millis."
|
|
name: "lastModifiedTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
syntax: "public PartitionOwnership setLastModifiedTime(Long lastModifiedTime)"
|
|
desc: "Sets the last modified time of this ownership record as epoch millis."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.messaging.eventhubs.models.PartitionOwnership\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PartitionOwnership\"></xref> instance."
|
|
type: "<xref href=\"com.azure.messaging.eventhubs.models.PartitionOwnership?alt=com.azure.messaging.eventhubs.models.PartitionOwnership&text=PartitionOwnership\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.setOwnerId(java.lang.String)"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.setOwnerId(String ownerId)"
|
|
name: "setOwnerId(String ownerId)"
|
|
nameWithType: "PartitionOwnership.setOwnerId(String ownerId)"
|
|
summary: "Returns the unique event processor identifier that owns the partition id in this ownership record."
|
|
parameters:
|
|
- description: "The unique event processor identifier that owns the partition id in this ownership record."
|
|
name: "ownerId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PartitionOwnership setOwnerId(String ownerId)"
|
|
desc: "Returns the unique event processor identifier that owns the partition id in this ownership record."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.messaging.eventhubs.models.PartitionOwnership\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PartitionOwnership\"></xref> instance."
|
|
type: "<xref href=\"com.azure.messaging.eventhubs.models.PartitionOwnership?alt=com.azure.messaging.eventhubs.models.PartitionOwnership&text=PartitionOwnership\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.messaging.eventhubs.models.PartitionOwnership.setPartitionId(java.lang.String)"
|
|
fullName: "com.azure.messaging.eventhubs.models.PartitionOwnership.setPartitionId(String partitionId)"
|
|
name: "setPartitionId(String partitionId)"
|
|
nameWithType: "PartitionOwnership.setPartitionId(String partitionId)"
|
|
summary: "Sets the partition id associated with this ownership record."
|
|
parameters:
|
|
- description: "The partition id associated with this ownership record."
|
|
name: "partitionId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PartitionOwnership setPartitionId(String partitionId)"
|
|
desc: "Sets the partition id associated with this ownership record."
|
|
returns:
|
|
description: "The updated <xref uid=\"com.azure.messaging.eventhubs.models.PartitionOwnership\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PartitionOwnership\"></xref> instance."
|
|
type: "<xref href=\"com.azure.messaging.eventhubs.models.PartitionOwnership?alt=com.azure.messaging.eventhubs.models.PartitionOwnership&text=PartitionOwnership\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "A model class to hold partition ownership information."
|
|
metadata: {}
|
|
package: "com.azure.messaging.eventhubs.models"
|
|
artifact: com.azure:azure-messaging-eventhubs:5.19.1
|