ServiceFabricClientGetPartitionsEventListOptionalParams interface

パッケージ:

@azure/servicefabric

省略可能なパラメーター。

Extends

RequestOptionsBase

プロパティ

eventsTypesFilter	これは、応答にのみ含める必要がある FabricEvent の種類を指定するコンマ区切りの文字列です。
excludeAnalysisEvents	true が渡された場合、このパラメーターは AnalysisEvents の取得を無効にします。
skipCorrelationLookup	true が渡された場合、このパラメーターは、CorrelatedEvents 情報の検索を無効にします。 それ以外の場合、CorrelationEvents が処理され、すべての FabricEvent の HasCorrelatedEvents フィールドが設定されます。
timeoutParameter	操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求された操作が完了するまでクライアントが待機する期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値: 60。

継承されたプロパティ

abortSignal	要求を中止するために使用できるシグナル。
customHeaders	要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。
onDownloadProgress	ダウンロードの進行状況時に発生するコールバック。
onUploadProgress	アップロードの進行状況時に発生するコールバック。
timeout	要求が自動的に終了するまでの時間 (ミリ秒)。

プロパティの詳細

eventsTypesFilter

これは、応答にのみ含める必要がある FabricEvent の種類を指定するコンマ区切りの文字列です。

eventsTypesFilter?: string

プロパティ値

string

excludeAnalysisEvents

true が渡された場合、このパラメーターは AnalysisEvents の取得を無効にします。

excludeAnalysisEvents?: boolean

プロパティ値

boolean

skipCorrelationLookup

true が渡された場合、このパラメーターは、CorrelatedEvents 情報の検索を無効にします。 それ以外の場合、CorrelationEvents が処理され、すべての FabricEvent の HasCorrelatedEvents フィールドが設定されます。

skipCorrelationLookup?: boolean

プロパティ値

boolean

timeoutParameter

操作を実行するためのサーバー タイムアウト (秒単位)。 このタイムアウトは、要求された操作が完了するまでクライアントが待機する期間を指定します。 このパラメーターの既定値は 60 秒です。 既定値: 60。

timeoutParameter?: number

プロパティ値

number

継承されたプロパティの詳細

abortSignal

要求を中止するために使用できるシグナル。

abortSignal?: AbortSignalLike

プロパティ値

AbortSignalLike

msRest.RequestOptionsBase.abortSignal から継承された

customHeaders

要求が送信される前に適用されるユーザー定義のカスタム要求ヘッダー。

customHeaders?: {[key: string]: string}

プロパティ値

{[key: string]: string}

msRest.RequestOptionsBase.customHeaders から継承された

onDownloadProgress

ダウンロードの進行状況時に発生するコールバック。

onDownloadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

msRest.RequestOptionsBase.onDownloadProgress から継承された

onUploadProgress

アップロードの進行状況時に発生するコールバック。

onUploadProgress?: (progress: TransferProgressEvent) => void

プロパティ値

(progress: TransferProgressEvent) => void

inherited From msRest.RequestOptionsBase.onUploadProgress

timeout

要求が自動的に終了するまでの時間 (ミリ秒)。

timeout?: number

プロパティ値

number

msRest.RequestOptionsBase.timeout から継承された