PipelineCreatePipelineRunOptionalParams interface
省略可能なパラメーター。
- Extends
プロパティ
| is |
回復モード フラグ。 復旧モードが true に設定されている場合、指定された参照されるパイプラインの実行と、新しい実行が同じ groupId の下にグループ化されます。 |
| parameters | パイプライン実行のパラメーター。 これらのパラメーターは、runId が指定されていない場合にのみ使用されます。 |
| reference |
パイプライン実行識別子。 実行 ID が指定されている場合、指定した実行のパラメーターを使用して新しい実行が作成されます。 |
| start |
復旧モードでは、再実行はこのアクティビティから開始されます。 指定しない場合、すべてのアクティビティが実行されます。 |
継承されたプロパティ
| abort |
要求を中止するために使用できるシグナル。 |
| on |
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。 |
| request |
この操作の HTTP 要求を作成および送信するときに使用されるオプション。 |
| serializer |
シリアル化/シリアル化解除の動作をオーバーライドするオプション。 |
| tracing |
トレースが有効な場合に使用されるオプション。 |
プロパティの詳細
isRecovery
回復モード フラグ。 復旧モードが true に設定されている場合、指定された参照されるパイプラインの実行と、新しい実行が同じ groupId の下にグループ化されます。
isRecovery?: boolean
プロパティ値
boolean
parameters
パイプライン実行のパラメーター。 これらのパラメーターは、runId が指定されていない場合にのみ使用されます。
parameters?: {[propertyName: string]: any}
プロパティ値
{[propertyName: string]: any}
referencePipelineRunId
パイプライン実行識別子。 実行 ID が指定されている場合、指定した実行のパラメーターを使用して新しい実行が作成されます。
referencePipelineRunId?: string
プロパティ値
string
startActivityName
復旧モードでは、再実行はこのアクティビティから開始されます。 指定しない場合、すべてのアクティビティが実行されます。
startActivityName?: string
プロパティ値
string
継承されたプロパティの詳細
abortSignal
要求を中止するために使用できるシグナル。
abortSignal?: AbortSignalLike
プロパティ値
coreClient.OperationOptions.abortSignal から継承
onResponse
要求された操作の実行中にサーバーから応答を受信するたびに呼び出される関数。 複数回呼び出すことができます。
onResponse?: RawResponseCallback
プロパティ値
coreClient.OperationOptions.onResponse から継承
requestOptions
この操作の HTTP 要求を作成および送信するときに使用されるオプション。
requestOptions?: OperationRequestOptions
プロパティ値
coreClient.OperationOptions.requestOptions から継承
serializerOptions
シリアル化/シリアル化解除の動作をオーバーライドするオプション。
serializerOptions?: SerializerOptions
プロパティ値
coreClient.OperationOptions.serializerOptions から継承
tracingOptions
トレースが有効な場合に使用されるオプション。
tracingOptions?: OperationTracingOptions
プロパティ値
coreClient.OperationOptions.tracingOptions から継承