`updateDataflowJob`

CRM Analytics データフロージョブを更新します。これは、Tableau CRM データマネージャの UI でデータプレップレシピ、データ同期、またはデータフローの [停止] をクリックすることと同じです。

構文

1import { updateDataflowJob } from 'lightning/analyticsWaveApi';
2updateDataflowJob({ dataflowjobId: string, dataflowJob: { command: string } }): Promise<DataflowJob>

CRM Analytics API リソース

1PATCH /wave/dataflowjobs/${dataflowjobId}

updateDataflowJob は、この CRM Analytics API リソースを使用します。

パラメータ

dataflowjobId — (必須) データフロージョブ ID。
command — (必須) 実行するジョブコマンド。
- start
- stop

データフロージョブを更新するには stop である必要があります。

戻り値

Dataflow Job 応答を使用して解決される Promise オブジェクト。

使用方法

updateDataflowJob を使用するには、いくつかの方法があります。たとえば、データフロージョブのリストを表示し、リストのキューに登録されている各レシピまたは実行中の各レシピに対して停止を行うことができます。

次の例では、レシピが含まれるページに停止ボタンを追加します。レシピを停止すると、lightning/platformShowToastEvent モジュールを使用して、トーストメッセージが表示されます。

1import { LightningElement, api } from 'lwc';
2import { updateDataflowJob } from 'lightning/analyticsWaveApi';
3import { ShowToastEvent } from 'lightning/platformShowToastEvent';
4
5export default class UpdateDataflowJob extends LightningElement {
6  @api dfjobId; // or fetch the ID of the dataflow job
7  command = 'start';
8
9  stop(event) {
10    updateDataflowJob({ dataflowjobId: this.dfjobId, dataflowJob: { this.command } })
11      .then(() => {
12        this.dispatchEvent(
13          new ShowToastEvent({
14            title: 'Success',
15            message: 'Recipe job stopped',
16             variant: 'success'
17                    })
18          );
19        })
20        .catch(error => {
21          this.dispatchEvent(
22            new ShowToastEvent({
23              title: 'Error stopping recipe job',
24              message: error.body.message,
25              variant: 'error'
26            })
27          );
28        });
29  }
30}

このボタンは、updateDataflowJob() メソッドをコールします。

1<template>
2  <lightning-button
3    label="Stop"
4    icon-name="utility:stop"
5    icon-position="right"
6    onclick={stop}
7  ></lightning-button>
8</template>

The Japanese Summer '24 guide is now live

日本語の Summer '24 ガイドが公開されました! 「Component Reference (コンポーネントリファレンス)」は、以前と同様にコンポーネントライブラリにあります。