CosmosItemRequestOptions クラス
- java.
lang. Object - com.
azure. cosmos. models. CosmosItemRequestOptions
- com.
public class CosmosItemRequestOptions
cosmos Item に発行された要求に対して指定できるオプションをカプセル化します。
コンストラクターの概要
コンストラクター | 説明 |
---|---|
CosmosItemRequestOptions() |
コンストラクター |
メソッドの概要
メソッドの継承元: java.lang.Object
コンストラクターの詳細
CosmosItemRequestOptions
public CosmosItemRequestOptions()
コンストラクター
メソッドの詳細
getConsistencyLevel
public ConsistencyLevel getConsistencyLevel()
要求に必要な整合性レベルを取得します。
Returns:
getDedicatedGatewayRequestOptions
public DedicatedGatewayRequestOptions getDedicatedGatewayRequestOptions()
専用ゲートウェイ要求オプションを取得します
Returns:
getExcludedRegions
public List
要求/再試行に対して除外するリージョンの一覧を取得します。 これらのリージョンは、優先リージョンの一覧から除外されます。
Returns:
getIfMatchETag
public String getIfMatchETag()
Azure Cosmos DB サービスの要求に関連付けられているIf-Match (ETag) を取得します。
Returns:
getIfNoneMatchETag
public String getIfNoneMatchETag()
Azure Cosmos DB サービスの要求に関連付けられている If-None-Match (ETag) を取得します。
Returns:
getIndexingDirective
public IndexingDirective getIndexingDirective()
インデックス作成ディレクティブ (インデックス、インデックスなしなど) を取得します。
Returns:
getPostTriggerInclude
public List
操作後に呼び出されるトリガーを取得します。
Returns:
getPreTriggerInclude
public List
操作の前に呼び出されるトリガーを取得します。
Returns:
getSessionToken
public String getSessionToken()
セッション整合性で使用するトークンを取得します。
Returns:
getThresholdForDiagnosticsOnTracer
public Duration getThresholdForDiagnosticsOnTracer()
CRUD 操作の待機時間がこの診断を超える場合は、end to end CRUD api のトレーサー スパンでイベントとしてテレメトリ エクスポーターを開くために送信される thresholdForDiagnosticsOnTracer を取得します。 既定値は 100 ミリ秒です。
Returns:
getThroughputControlGroupName
public String getThroughputControlGroupName()
スループット制御グループ名を取得します。
Returns:
isContentResponseOnWriteEnabled
public Boolean isContentResponseOnWriteEnabled()
CosmosItem に対する作成、更新、および削除操作の場合に Cosmos DB 応答のヘッダーと状態コードのみを返すブール値を取得します。 false に設定した場合、サービスは応答でペイロードを返しません。 ネットワーク経由でペイロードを返送せず、クライアントでシリアル化することで、ネットワークと CPU の負荷を軽減します。 この機能は、読み取り操作または書き込み操作の RU 使用量には影響しません。 注: このフラグは にも存在しますが、 でCosmosClientBuilderCosmosItemRequestOptions指定されている場合は、この要求に対して でCosmosClientBuilder指定された値をオーバーライドします。 既定では、これは null です。
Returns:
setConsistencyLevel
public CosmosItemRequestOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)
要求に必要な整合性レベルを設定します。 有効な整合性レベルは、読み取り/クエリ要求に対してのみ削減できます。 したがって、アカウントの既定の整合性レベルがたとえば Session である場合は、個々の要求に対して要求ごとのレベルで、最終的な整合性で十分であることを指定できます。これにより、この要求の待機時間と RU の料金が削減される可能性がありますが、セッションの整合性 (読み取り/自分の書き込み) は保証されません。ここで要求レベルで設定された整合性レベルが SESSION であり、CosmosClient インスタンスを構築するときに指定される既定の整合性レベルである場合CosmosClientBuilder.consistencyLevel は SESSION ではなく、CosmosClientBuilder:sessionCapturingOverrideEnabled(true) を明示的に呼び出すことによって、セッション トークンのキャプチャも有効にする必要があります。
Parameters:
Returns:
setContentResponseOnWriteEnabled
public CosmosItemRequestOptions setContentResponseOnWriteEnabled(Boolean contentResponseOnWriteEnabled)
CosmosItem に対する作成、更新、および削除の操作の場合にのみ、Cosmos DB 応答でヘッダーと状態コードを返すようにブール値を設定します。 false に設定した場合、サービスは応答のペイロードを返しません。 ネットワーク経由でペイロードを返送せず、クライアントでシリアル化することで、ネットワークと CPU の負荷を軽減します。 この機能は、読み取り操作または書き込み操作の RU 使用量には影響しません。 既定では、これは null です。 注: このフラグは にも存在しますが、 でCosmosClientBuilderCosmosItemRequestOptions指定されている場合は、この要求に対して でCosmosClientBuilder指定された値をオーバーライドします。
Parameters:
Returns:
setCosmosEndToEndOperationLatencyPolicyConfig
public CosmosItemRequestOptions setCosmosEndToEndOperationLatencyPolicyConfig(CosmosEndToEndOperationLatencyPolicyConfig endToEndOperationLatencyPolicyConfig)
要求に CosmosEndToEndOperationLatencyPolicyConfig 使用する を設定します。 構成がクライアントで既に設定されている場合は、この要求のクライアント レベルの構成がオーバーライドされます
Parameters:
Returns:
setDedicatedGatewayRequestOptions
public CosmosItemRequestOptions setDedicatedGatewayRequestOptions(DedicatedGatewayRequestOptions dedicatedGatewayRequestOptions)
専用ゲートウェイ要求オプションを設定します
Parameters:
Returns:
setDiagnosticsThresholds
public CosmosItemRequestOptions setDiagnosticsThresholds(CosmosDiagnosticsThresholds operationSpecificThresholds)
特定の操作の診断しきい値をオーバーライドできます。
Parameters:
Returns:
setExcludedRegions
public CosmosItemRequestOptions setExcludedRegions(List
要求/再試行に対して除外するリージョンの一覧。 例 "米国東部" または "米国東部、米国西部" これらのリージョンは、優先リージョンの一覧から除外されます
Parameters:
Returns:
setIfMatchETag
public CosmosItemRequestOptions setIfMatchETag(String ifMatchETag)
Azure Cosmos DB サービスの要求に関連付けられているIf-Match (ETag) を設定します。
Parameters:
Returns:
setIfNoneMatchETag
public CosmosItemRequestOptions setIfNoneMatchETag(String ifNoneMatchETag)
Azure Cosmos DB サービスの要求に関連付けられている If-None-Match (ETag) を設定します。
Parameters:
Returns:
setIndexingDirective
public CosmosItemRequestOptions setIndexingDirective(IndexingDirective indexingDirective)
インデックス作成ディレクティブ (インデックス、インデックスなしなど) を設定します。
Parameters:
Returns:
setNonIdempotentWriteRetryPolicy
public CosmosItemRequestOptions setNonIdempotentWriteRetryPolicy(boolean nonIdempotentWriteRetriesEnabled, boolean useTrackingIdPropertyForCreateAndReplace)
SDK がべき等であることを保証できない場合でも、書き込み操作の自動再試行を有効にします。 これは、特定の要求/操作の CosmosClientBuilder#setNonIdempotentWriteRetryPolicy(boolean, boolean) 動作のオーバーライドです。 注: CosmosClientBuilder の設定によって、作成、置換、アップサート、および削除の各操作の既定の動作が決まります。 要求オプションでは、要求ベースごとにオーバーライドできます。 既定でパッチ操作の場合 (要求オプションでオーバーライドされない限り)、再試行は常に既定で無効になります。 - 作成: 再試行により、最初の試行が正常に作成されたドキュメントを作成しようとしたときに、アプリケーションに対して (さらに) 409 競合要求が表示される可能性があります。 useTrackingIdPropertyForCreateAndReplace を有効にすると、再試行によって発生する 409-Conflict の場合、これを回避できます。 - 置換: 置換操作で事前条件チェック (etag) が使用され、再試行によって最初の試行が正常に更新されたドキュメントの更新 (etag の変更の原因) が試行されたときに、再試行によってアプリケーションに表示される (さらに) 412-Precondition エラー要求が発生する可能性があります。 useTrackingIdPropertyForCreateAndReplace を有効にすると、再試行によって発生する 412-Precondition エラーでこれを回避できます。 - 削除: 削除操作が再試行され、最初の試行が成功すると、再試行によって (さらに) 404-NotFound 要求が表示される可能性があります。 書き込み再試行は、アプリケーションが 404 - Not Found を適切に処理できる場合にのみ有効にする必要があります。 - Upsert: 再試行すると、200 が表示される可能性があります。これは、ドキュメントが実際に最初の試行によって作成されたときにドキュメントが更新されたように見えるので、論理的には同じ操作内です。 これは、アップサート操作で 201 と 200 の特別な大文字と小文字を区別するアプリケーションにのみ影響します。 パッチ: パッチの再試行は可能ですが、常にべき等であるとは限りません。実行されているパッチ操作と使用されている前提条件フィルターに完全に依存します。 パッチの書き込み再試行を有効にする前に、これは慎重に確認する必要があり、テスト (パッチの再試行は要求オプションでのみ有効にできます)、CosmosClient 全体の構成は無視されます。 PK/トランザクション バッチ/Stroed プロシージャ実行による一括削除: 自動再試行はサポートされていません。
Parameters:
Returns:
setPostTriggerInclude
public CosmosItemRequestOptions setPostTriggerInclude(List
操作後に呼び出されるトリガーを設定します。
Parameters:
Returns:
setPreTriggerInclude
public CosmosItemRequestOptions setPreTriggerInclude(List
操作の前に呼び出されるトリガーを設定します。
Parameters:
Returns:
setSessionToken
public CosmosItemRequestOptions setSessionToken(String sessionToken)
セッション整合性で使用するトークンを設定します。
Parameters:
Returns:
setThresholdForDiagnosticsOnTracer
public CosmosItemRequestOptions setThresholdForDiagnosticsOnTracer(Duration thresholdForDiagnosticsOnTracer)
CRUD 操作の待機時間がこの診断を超える場合は、end to end CRUD api のトレーサー スパンでイベントとしてテレメトリ エクスポーターを開くために送信される thresholdForDiagnosticsOnTracer を設定します。 既定値は 100 ミリ秒です。
Parameters:
Returns:
setThroughputControlGroupName
public void setThroughputControlGroupName(String throughputControlGroupName)
スループット制御グループ名を設定します。
Parameters:
適用対象
Azure SDK for Java