132 строки
9.5 KiB
YAML
132 строки
9.5 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.models.ChangeFeedProcessorState"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorState"
|
|
name: "ChangeFeedProcessorState"
|
|
nameWithType: "ChangeFeedProcessorState"
|
|
summary: "Specifies the <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref> state for a particular lease/worker."
|
|
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 **ChangeFeedProcessorState**"
|
|
constructors:
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorState.ChangeFeedProcessorState()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorState.ChangeFeedProcessorState()"
|
|
name: "ChangeFeedProcessorState()"
|
|
nameWithType: "ChangeFeedProcessorState.ChangeFeedProcessorState()"
|
|
syntax: "public ChangeFeedProcessorState()"
|
|
methods:
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorState.getContinuationToken()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorState.getContinuationToken()"
|
|
name: "getContinuationToken()"
|
|
nameWithType: "ChangeFeedProcessorState.getContinuationToken()"
|
|
summary: "Gets a marker representing the last item that was processed."
|
|
syntax: "public String getContinuationToken()"
|
|
desc: "Gets a marker representing the last item that was processed."
|
|
returns:
|
|
description: "the marker representing the last item that was processed."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorState.getEstimatedLag()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorState.getEstimatedLag()"
|
|
name: "getEstimatedLag()"
|
|
nameWithType: "ChangeFeedProcessorState.getEstimatedLag()"
|
|
summary: "Gets an approximation of the difference between the last processed item in the feed container and the latest change recorded."
|
|
syntax: "public int getEstimatedLag()"
|
|
desc: "Gets an approximation of the difference between the last processed item in the feed container and the latest change recorded."
|
|
returns:
|
|
description: "the estimated lag."
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorState.getHostName()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorState.getHostName()"
|
|
name: "getHostName()"
|
|
nameWithType: "ChangeFeedProcessorState.getHostName()"
|
|
summary: "Gets the name of the host which operates on the lease item."
|
|
syntax: "public String getHostName()"
|
|
desc: "Gets the name of the host which operates on the lease item.\n\nWhen using multiple CFP instances distributing the work for a given feed container, each host must have a unique name."
|
|
returns:
|
|
description: "the host name that has ownership of this lease item or null if no host is currently operating on this lease."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorState.getLeaseToken()"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorState.getLeaseToken()"
|
|
name: "getLeaseToken()"
|
|
nameWithType: "ChangeFeedProcessorState.getLeaseToken()"
|
|
summary: "Gets the token of the lease item representing the persistent state of a change feed processor worker."
|
|
syntax: "public String getLeaseToken()"
|
|
desc: "Gets the token of the lease item representing the persistent state of a change feed processor worker.\n\nA lease token is a unique identifier representing a specific scope that a CFP worker will operate on."
|
|
returns:
|
|
description: "a string token uniquely representing the scope for one worker unit."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorState.setContinuationToken(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorState.setContinuationToken(String continuationToken)"
|
|
name: "setContinuationToken(String continuationToken)"
|
|
nameWithType: "ChangeFeedProcessorState.setContinuationToken(String continuationToken)"
|
|
summary: "Sets a marker representing the last item that was processed."
|
|
parameters:
|
|
- description: "the marker representing the last item that was processed."
|
|
name: "continuationToken"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ChangeFeedProcessorState setContinuationToken(String continuationToken)"
|
|
desc: "Sets a marker representing the last item that was processed."
|
|
returns:
|
|
description: "the current ChangeFeedProcessorState instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorState?alt=com.azure.cosmos.models.ChangeFeedProcessorState&text=ChangeFeedProcessorState\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorState.setEstimatedLag(int)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorState.setEstimatedLag(int estimatedLag)"
|
|
name: "setEstimatedLag(int estimatedLag)"
|
|
nameWithType: "ChangeFeedProcessorState.setEstimatedLag(int estimatedLag)"
|
|
summary: "Sets the estimated lag."
|
|
parameters:
|
|
- description: "the estimated lag."
|
|
name: "estimatedLag"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ChangeFeedProcessorState setEstimatedLag(int estimatedLag)"
|
|
desc: "Sets the estimated lag."
|
|
returns:
|
|
description: "the current ChangeFeedProcessorState instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorState?alt=com.azure.cosmos.models.ChangeFeedProcessorState&text=ChangeFeedProcessorState\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorState.setHostName(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorState.setHostName(String hostName)"
|
|
name: "setHostName(String hostName)"
|
|
nameWithType: "ChangeFeedProcessorState.setHostName(String hostName)"
|
|
summary: "Sets the name of the host which operates on the lease item."
|
|
parameters:
|
|
- description: "the host name that has ownership of this lease item."
|
|
name: "hostName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ChangeFeedProcessorState setHostName(String hostName)"
|
|
desc: "Sets the name of the host which operates on the lease item.\n\nWhen using multiple CFP instances distributing the work for a given feed container, each host must have a unique name."
|
|
returns:
|
|
description: "the current ChangeFeedProcessorState instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorState?alt=com.azure.cosmos.models.ChangeFeedProcessorState&text=ChangeFeedProcessorState\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.models.ChangeFeedProcessorState.setLeaseToken(java.lang.String)"
|
|
fullName: "com.azure.cosmos.models.ChangeFeedProcessorState.setLeaseToken(String leaseToken)"
|
|
name: "setLeaseToken(String leaseToken)"
|
|
nameWithType: "ChangeFeedProcessorState.setLeaseToken(String leaseToken)"
|
|
summary: "Sets the token of the lease item representing the persistent state of a change feed processor worker."
|
|
parameters:
|
|
- description: "a unique string representing a specific scope that a CFP worker will operate on."
|
|
name: "leaseToken"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ChangeFeedProcessorState setLeaseToken(String leaseToken)"
|
|
desc: "Sets the token of the lease item representing the persistent state of a change feed processor worker.\n\nA lease token is a unique identifier representing a specific scope that a CFP worker will operate on."
|
|
returns:
|
|
description: "the current ChangeFeedProcessorState instance."
|
|
type: "<xref href=\"com.azure.cosmos.models.ChangeFeedProcessorState?alt=com.azure.cosmos.models.ChangeFeedProcessorState&text=ChangeFeedProcessorState\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Specifies the <xref uid=\"com.azure.cosmos.ChangeFeedProcessor\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ChangeFeedProcessor\"></xref> state for a particular lease/worker."
|
|
metadata: {}
|
|
package: "com.azure.cosmos.models"
|
|
artifact: com.azure:azure-cosmos:4.63.3
|