CosmosItemRequestOptions Klasse

Paket:

com.azure.cosmos.models

Maven-Artefakt:

com.azure:azure-cosmos:4.54.0

• java.lang.Object
• • com.azure.cosmos.models.CosmosItemRequestOptions

public class CosmosItemRequestOptions

Kapselt Optionen, die für eine an cosmos Item ausgestellte Anforderung angegeben werden können.

Zusammenfassung zum Konstruktor

Konstruktor	Beschreibung
CosmosItemRequestOptions()	Konstruktor

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
ConsistencyLevel	getConsistencyLevel() Ruft die für die Anforderung erforderliche Konsistenzebene ab.
DedicatedGatewayRequestOptions	getDedicatedGatewayRequestOptions() Ruft die Optionen für die Anforderung des dedizierten Gateways ab.
List<String>	getExcludedRegions() Ruft die Liste der Regionen ab, die für die Anforderung/Wiederholung ausgeschlossen werden sollen.
String	getIfMatchETag() Ruft das If-Match (ETag) ab, das der Anforderung im Azure Cosmos DB-Dienst zugeordnet ist.
String	getIfNoneMatchETag() Ruft das If-None-Match (ETag) ab, das der Anforderung im Azure Cosmos DB-Dienst zugeordnet ist.
IndexingDirective	getIndexingDirective() Ruft die Indizierungsdirektive ab (index, nicht indizieren usw.).
List<String>	getPostTriggerInclude() Ruft die Trigger ab, die nach dem Vorgang aufgerufen werden sollen.
List<String>	getPreTriggerInclude() Ruft die Trigger ab, die vor dem Vorgang aufgerufen werden sollen.
String	getSessionToken() Ruft das Token zur Verwendung mit Sitzungskonsistenz ab.
Duration	getThresholdForDiagnosticsOnTracer() Ruft den SchwellenwertfürDiagnosticsOnTracer ab, wenn die Latenz beim CRUD-Vorgang größer ist als dieser Diagnose als Ereignisse in der Ablaufverfolgungsspanne der CRUD-API an den öffnenden Telemetrieexporter gesendet wird.
String	getThroughputControlGroupName() Ruft den Namen der Durchsatzsteuerungsgruppe ab.
Boolean	isContentResponseOnWriteEnabled() Ruft den booleschen Wert ab, der nur die Header und status Code in der Cosmos DB-Antwort zurückgibt, wenn die Vorgänge Erstellen, Aktualisieren und Löschen für CosmosItem ausgeführt werden.
CosmosItemRequestOptions	setConsistencyLevel(ConsistencyLevel consistencyLevel) Legt die für die Anforderung erforderliche Konsistenzebene fest.
CosmosItemRequestOptions	setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled) Legt den booleschen Wert so fest, dass nur die Header und status Code in der Cosmos DB-Antwort zurückgegeben werden, wenn Vorgänge zum Erstellen, Aktualisieren und Löschen für CosmosItem ausgeführt werden.
CosmosItemRequestOptions	setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig endToEndOperationLatencyPolicyConfig) Legt den fest, der CosmosEndToEndOperationLatencyPolicyConfig für die Anforderung verwendet werden soll.
CosmosItemRequestOptions	setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions) Legt die Optionen für dedizierte Gatewayanforderungen fest.
CosmosItemRequestOptions	setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds) Ermöglicht das Überschreiben der Diagnoseschwellenwerte für einen bestimmten Vorgang.
CosmosItemRequestOptions	setExcludedRegions(List<String> excludeRegions) Liste der Regionen, die für die Anforderung/Wiederholung ausgeschlossen werden sollen.
CosmosItemRequestOptions	setIfMatchETag(String ifMatchETag) Legt den If-Match (ETag) fest, der der Anforderung im Azure Cosmos DB-Dienst zugeordnet ist.
CosmosItemRequestOptions	setIfNoneMatchETag(String ifNoneMatchETag) Legt das If-None-Match (ETag) fest, das der Anforderung im Azure Cosmos DB-Dienst zugeordnet ist.
CosmosItemRequestOptions	setIndexingDirective(IndexingDirective indexingDirective) Legt die Indizierungsdirektive fest (index, nicht indexieren usw.).
CosmosItemRequestOptions	setNonIdempotentWriteRetryPolicy(boolean nonIdempotentWriteRetriesEnabled, boolean useTrackingIdPropertyForCreateAndReplace) Aktiviert automatische Wiederholungsversuche für Schreibvorgänge, auch wenn das SDK nicht garantieren kann, dass sie idempotent sind.
CosmosItemRequestOptions	setPostTriggerInclude(List<String> postTriggerInclude) Legt die Trigger fest, die nach dem Vorgang aufgerufen werden sollen.
CosmosItemRequestOptions	setPreTriggerInclude(List<String> preTriggerInclude) Legt die Trigger fest, die vor dem Vorgang aufgerufen werden sollen.
CosmosItemRequestOptions	setSessionToken(String sessionToken) Legt das Token für die Verwendung mit Sitzungskonsistenz fest.
CosmosItemRequestOptions	setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer) Legt den SchwellenwertfürDiagnoseOnTracer fest, wenn die Latenz für den CRUD-Vorgang größer ist als dieser Diagnose als Ereignisse in der Ablaufverfolgungsspanne der CruD-API an den öffnenden Telemetrieexporter gesendet wird.
void	setThroughputControlGroupName(String throughputControlGroupName) Legt den Namen der Durchsatzsteuerungsgruppe fest.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zum Konstruktor

CosmosItemRequestOptions

public CosmosItemRequestOptions()

Konstruktor

Details zur Methode

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

Ruft die für die Anforderung erforderliche Konsistenzebene ab.

Returns:

die Konsistenzebene.

getDedicatedGatewayRequestOptions

public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions()

Ruft die Optionen für die Anforderung des dedizierten Gateways ab.

Returns:

Die Optionen für die Anforderung für dedizierte Gateways

getExcludedRegions

public List getExcludedRegions()

Ruft die Liste der Regionen ab, die für die Anforderung/Wiederholung ausgeschlossen werden sollen. Diese Regionen sind aus der Liste der bevorzugten Regionen ausgeschlossen.

Returns:

Eine Liste der ausgeschlossenen Regionen

getIfMatchETag

public String getIfMatchETag()

Ruft das If-Match (ETag) ab, das der Anforderung im Azure Cosmos DB-Dienst zugeordnet ist.

Returns:

das ifMatchETag, das der Anforderung zugeordnet ist.

getIfNoneMatchETag

public String getIfNoneMatchETag()

Ruft das If-None-Match (ETag) ab, das der Anforderung im Azure Cosmos DB-Dienst zugeordnet ist.

Returns:

das ifNoneMatchETag, das der Anforderung zugeordnet ist.

getIndexingDirective

public IndexingDirective getIndexingDirective()

Ruft die Indizierungsdirektive ab (index, nicht indizieren usw.).

Returns:

die Indizierungsdirektive.

getPostTriggerInclude

public List getPostTriggerInclude()

Ruft die Trigger ab, die nach dem Vorgang aufgerufen werden sollen.

Returns:

die Trigger, die nach dem Vorgang aufgerufen werden sollen.

getPreTriggerInclude

public List getPreTriggerInclude()

Ruft die Trigger ab, die vor dem Vorgang aufgerufen werden sollen.

Returns:

die Trigger, die vor dem Vorgang aufgerufen werden sollen.

getSessionToken

public String getSessionToken()

Ruft das Token zur Verwendung mit Sitzungskonsistenz ab.

Returns:

das Sitzungstoken.

getThresholdForDiagnosticsOnTracer

public Duration getThresholdForDiagnosticsOnTracer()

Ruft den schwellenwertForDiagnosticsOnTracer ab, wenn die Latenz beim CRUD-Vorgang größer ist als dieser Diagnose als Ereignisse in der Ablaufverfolgungsspanne der End-to-End-CRUD-API an den geöffneten Telemetrieexporter gesendet wird. Der Standardwert ist 100 ms.

Returns:

thresholdForDiagnosticsOnTracerInMS der Latenzschwellenwert für Diagnose in der Ablaufverfolgung.

getThroughputControlGroupName

public String getThroughputControlGroupName()

Ruft den Namen der Durchsatzsteuerungsgruppe ab.

Returns:

der Name der Durchsatzsteuerungsgruppe.

isContentResponseOnWriteEnabled

public Boolean isContentResponseOnWriteEnabled()

Ruft den booleschen Wert ab, der nur die Header und status Code in der Cosmos DB-Antwort im Fall von Create-, Update- und Delete-Vorgängen für CosmosItem zurückgibt. Wenn dieser Wert auf false festgelegt ist, gibt der Dienst keine Nutzlast in der Antwort zurück. Es reduziert die Netzwerk- und CPU-Last, indem die Nutzlast nicht über das Netzwerk zurückgesendet und auf dem Client serialisiert wird. Dieses Feature wirkt sich nicht auf die RU-Nutzung für Lese- oder Schreibvorgänge aus. HINWEIS: Dieses Flag ist auch für CosmosClientBuildervorhanden, aber wenn auf CosmosItemRequestOptionsangegeben wird, überschreibt es den für diese Anforderung angegebenen CosmosClientBuilder Wert. Standardmäßig ist dies NULL.

Returns:

ein boolescher Wert, der angibt, ob die Nutzlast in der Antwort für diese Anforderung enthalten ist oder nicht.

setConsistencyLevel

public CosmosItemRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)

Legt die für die Anforderung erforderliche Konsistenzebene fest. Die effektive Konsistenzebene kann nur bei Lese-/Abfrageanforderungen reduziert werden. Wenn also die Standardkonsistenzebene des Kontos beispielsweise Sitzung ist, können Sie auf einer Anforderungsebene für einzelne Anforderungen angeben, dass die letztendliche Konsistenz ausreichend ist. Dies kann die Latenz und ru-Gebühren für diese Anforderung verringern, aber keine Sitzungskonsistenz mehr garantieren (Read-Your-Own-Write). HINWEIS: Wenn die Konsistenzebene für eine Anforderungsebene hier SESSION und die Standardkonsistenzebene ist, die beim Erstellen des CosmosClient angegeben ist. instance über CosmosClientBuilder.consistencyLevel nicht SESSION ist, muss die Sitzungstokenerfassung auch aktiviert werden, indem CosmosClientBuilder:sessionCapturingOverrideEnabled(true) explizit aufgerufen wird.

Parameters:

consistencyLevel - die Konsistenzebene.

Returns:

CosmosItemRequestOptions.

setContentResponseOnWriteEnabled

public CosmosItemRequestOptions setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)

Legt den booleschen Wert so fest, dass nur die Header und status Code in der Cosmos DB-Antwort zurückgegeben werden, wenn die Vorgänge Erstellen, Aktualisieren und Löschen für CosmosItem ausgeführt werden. Wenn auf false festgelegt ist, gibt der Dienst keine Nutzlast in der Antwort zurück. Es reduziert die Netzwerk- und CPU-Last, da die Nutzlast nicht über das Netzwerk zurückgesendet und auf dem Client serialisiert wird. Dieses Feature wirkt sich nicht auf die RU-Nutzung für Lese- oder Schreibvorgänge aus. Standardmäßig ist dies NULL. HINWEIS: Dieses Flag ist auch für CosmosClientBuildervorhanden, aber wenn auf CosmosItemRequestOptionsangegeben wird, überschreibt es den für diese Anforderung angegebenen CosmosClientBuilder Wert.

Parameters:

contentResponseOnWriteEnabled - ein boolescher Wert, der angibt, ob die Nutzlast für diese Anforderung in die Antwort einbezogen wird oder nicht

Returns:

CosmosItemRequestOptions.

setCosmosEndToEndOperationLatencyPolicyConfig

public CosmosItemRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig endToEndOperationLatencyPolicyConfig)

Legt den fest, der CosmosEndToEndOperationLatencyPolicyConfig für die Anforderung verwendet werden soll. Wenn die Konfiguration bereits auf dem Client festgelegt ist, überschreibt dies die Konfiguration auf Clientebene für diese Anforderung.

Parameters:

endToEndOperationLatencyPolicyConfig - das CosmosEndToEndOperationLatencyPolicyConfig

Returns:

CosmosItemRequestOptions

setDedicatedGatewayRequestOptions

public CosmosItemRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)

Legt die Optionen für dedizierte Gatewayanforderungen fest.

Parameters:

dedicatedGatewayRequestOptions - Optionen für dedizierte Gatewayanforderungen

Returns:

CosmosItemRequestOptions

setDiagnosticsThresholds

public CosmosItemRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)

Ermöglicht das Überschreiben der Diagnoseschwellenwerte für einen bestimmten Vorgang.

Parameters:

operationSpecificThresholds - Die Überschreibung des Diagnoseschwellenwerts für diesen Vorgang

Returns:

CosmosItemRequestOptions.

setExcludedRegions

public CosmosItemRequestOptions setExcludedRegions(List excludeRegions)

Liste der Regionen, die für die Anforderung/Wiederholung ausgeschlossen werden sollen. Beispiel "USA, Osten" oder "USA, Osten, USA, Westen" Diese Regionen werden aus der Liste der bevorzugten Regionen ausgeschlossen.

Parameters:

excludeRegions - Liste der Regionen

Returns:

das CosmosItemRequestOptions

setIfMatchETag

public CosmosItemRequestOptions setIfMatchETag(String ifMatchETag)

Legt den If-Match (ETag) fest, der der Anforderung im Azure Cosmos DB-Dienst zugeordnet ist.

Parameters:

ifMatchETag - das ifMatchETag, das der Anforderung zugeordnet ist.

Returns:

die aktuellen Anforderungsoptionen

setIfNoneMatchETag

public CosmosItemRequestOptions setIfNoneMatchETag(String ifNoneMatchETag)

Legt das If-None-Match (ETag) fest, das der Anforderung im Azure Cosmos DB-Dienst zugeordnet ist.

Parameters:

ifNoneMatchETag - das ifNoneMatchETag, das der Anforderung zugeordnet ist.

Returns:

die aktuellen Anforderungsoptionen

setIndexingDirective

public CosmosItemRequestOptions setIndexingDirective(IndexingDirective indexingDirective)

Legt die Indizierungsdirektive fest (index, nicht indexieren usw.).

Parameters:

indexingDirective - die Indizierungsdirektive.

Returns:

CosmosItemRequestOptions.

setNonIdempotentWriteRetryPolicy

public CosmosItemRequestOptions setNonIdempotentWriteRetryPolicy(boolean nonIdempotentWriteRetriesEnabled, boolean useTrackingIdPropertyForCreateAndReplace)

Aktiviert automatische Wiederholungsversuche für Schreibvorgänge, auch wenn das SDK nicht garantieren kann, dass sie idempotent sind. Dies ist eine Überschreibung des CosmosClientBuilder#setNonIdempotentWriteRetryPolicy(boolean, boolean) Verhaltens für eine bestimmte Anforderung/einen bestimmten Vorgang. HINWEIS: Die Einstellung für CosmosClientBuilder bestimmt das Standardverhalten für die Vorgänge Create, Replace, Upsert und Delete. Sie kann pro Anforderungsbasis in den Anforderungsoptionen überschrieben werden. Bei Patchvorgängen standardmäßig (sofern nicht in den Anforderungsoptionen überschrieben) sind Wiederholungsversuche standardmäßig immer deaktiviert. - Erstellen: Wiederholungsversuche können dazu führen, dass (mehr) 409-Konfliktanforderungen an die Anwendung angezeigt werden, wenn ein Wiederholungsversuch versucht, ein Dokument zu erstellen, das beim ersten Versuch erfolgreich erstellt wurde. Wenn Sie useTrackingIdPropertyForCreateAndReplace aktivieren, kann dies für 409-Conflict vermieden werden, die durch Wiederholungen verursacht werden. - Ersetzen: Wiederholungsversuche können dazu führen, dass (mehr) 412-Vorbedingungsfehleranforderungen an die Anwendung angezeigt werden, wenn ein Ersetzungsvorgang eine Präbedingungsprüfung (etag) verwendet und ein Wiederholungsversuch versucht, ein Dokument zu aktualisieren, das beim ersten Versuch erfolgreich aktualisiert wurde (wodurch sich das etag ändert). Beim Aktivieren von useTrackingIdPropertyForCreateAndReplace kann dies bei 412-Vorbedingungsfehlern vermieden werden, die durch Wiederholungen verursacht werden. - Löschen: Wiederholungsversuche können zu (mehr) 404-NotFound-Anforderungen führen, wenn ein Löschvorgang wiederholt wird und der erste Versuch erfolgreich war. Im Idealfall sollten Schreibversuche nur aktiviert werden, wenn Anwendungen 404 – Nicht gefunden ordnungsgemäß verarbeiten können. - Upsert: Wiederholungsversuche können dazu führen, dass eine 200 angezeigt wird , die aussieht, als das Dokument aktualisiert wurde, als das Dokument tatsächlich durch den ersten Versuch erstellt wurde - also logisch innerhalb desselben Vorgangs. Dies wirkt sich nur auf Anwendungen aus, die über ein spezielles Gehäuse für 201 vs. 200 für Upsert-Vorgänge verfügen. Patch: Wiederholungsversuche für Patch können aber nicht immer idempotent sein . Dies hängt vollständig von den ausgeführten Patchvorgängen und den verwendeten Vorbedingungsfiltern ab. Vor dem Aktivieren von Schreibversuchen für Patch muss dies sorgfältig überprüft und getestet werden - wobei Wiederholungen für Patch nur bei Anforderungsoptionen aktiviert werden können - jede cosmosClient-breite Konfiguration wird ignoriert. Bulk/Delete by PK/Transactional Batch/Stroed Procedure Execution: Es werden keine automatischen Wiederholungen unterstützt.

Parameters:

nonIdempotentWriteRetriesEnabled - ein Flag, das angibt, ob das SDK automatische Wiederholungsversuche für einen Vorgang aktivieren soll, wenn die Idempotenz nicht garantiert werden kann, da für den vorherigen Versuch eine Anforderung im Netzwerk gesendet wurde.

useTrackingIdPropertyForCreateAndReplace - ein Flag, das angibt, ob Schreibvorgänge die trackingId-Systemeigenschaft "/_trackingId" verwenden können, um die Identifizierung von Konflikten und Vorbedingungsfehlern aufgrund von Wiederholungen zu ermöglichen. Wenn diese Option aktiviert ist, verfügt jedes dokument, das erstellt oder ersetzt wird, über eine zusätzliche Eigenschaft "/_trackingId", für die der Wert vom SDK aktualisiert wird. Wenn es nicht gewünscht ist, diese neue JSON-Eigenschaft hinzuzufügen (z. B. aufgrund der RU-Erhöhung basierend auf der Nutzlastgröße oder weil Dokumente die maximale Obergrenze der Nutzlastgröße überschreiten), kann die Verwendung dieser Systemeigenschaft deaktiviert werden, indem Sie diesen Parameter auf false festlegen. Dies bedeutet, dass es aufgrund von Wiederholungen eine höhere Stufe von 409/312 geben könnte - und Anwendungen müssten sie selbst anmutig behandeln.

Returns:

CosmosItemRequestOptions

setPostTriggerInclude

public CosmosItemRequestOptions setPostTriggerInclude(List postTriggerInclude)

Legt die Trigger fest, die nach dem Vorgang aufgerufen werden sollen.

Parameters:

postTriggerInclude - die Trigger, die nach dem Vorgang aufgerufen werden sollen.

Returns:

CosmosItemRequestOptions.

setPreTriggerInclude

public CosmosItemRequestOptions setPreTriggerInclude(List preTriggerInclude)

Legt die Trigger fest, die vor dem Vorgang aufgerufen werden sollen.

Parameters:

preTriggerInclude - die Trigger, die vor dem Vorgang aufgerufen werden sollen.

Returns:

CosmosItemRequestOptions.

setSessionToken

public CosmosItemRequestOptions setSessionToken(String sessionToken)

Legt das Token für die Verwendung mit Sitzungskonsistenz fest.

Parameters:

sessionToken - das Sitzungstoken.

Returns:

CosmosItemRequestOptions.

setThresholdForDiagnosticsOnTracer

public CosmosItemRequestOptions setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)

Legt den schwellenwertForDiagnosticsOnTracer fest, wenn die Latenz für den CRUD-Vorgang größer ist als dieser Diagnose als Ereignisse in der Ablaufverfolgungsspanne der CRUD-Api an den geöffneten Telemetrieexporter gesendet wird. Der Standardwert ist 100 ms.

Parameters:

thresholdForDiagnosticsOnTracer - der Latenzschwellenwert für Diagnose im Ablaufverfolgungsmodus.

Returns:

CosmosItemRequestOptions

setThroughputControlGroupName

public void setThroughputControlGroupName(String throughputControlGroupName)

Legt den Namen der Durchsatzsteuerungsgruppe fest.

Parameters:

throughputControlGroupName - der Name der Durchsatzsteuerungsgruppe.