コンストラクタ
コンストラクター
client): StreamClient
パラメータ
| 名前 | 型 |
|---|---|
client | Client |
返り値
StreamClient
定義箇所
メソッド
postsFirehoseJa
partition, options?): Promise<EventDrivenStream>
日本語のPostをストリーミング
公開されている日本語のPostをリアルタイムでストリーミングします。
使いやすいイベント駆動型ストリームを返します。
.on() を使って ‘data’、‘error’、‘close’ といったイベントを購読できます。
for await…of による非同期イテレーションにも対応しています。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
partition | number | パーティション番号 |
options | PostsFirehoseJaStreamingOptions | - |
返り値
Promise<EventDrivenStream>
ストリーミングdataを処理するためのイベント駆動型ストリーム
定義箇所
posts
options?): Promise<EventDrivenStream>
フィルター済みのPostをストリーミング
アクティブなルールセットに一致するPostをリアルタイムでストリーミングします。
使いやすいイベント駆動型ストリームを返します。
.on() を使って ‘data’、‘error’、‘close’ といったイベントをリッスンできます。
for await…of を用いた非同期イテレーションにも対応しています。
パラメータ
| 名前 | 型 |
|---|---|
options | PostsStreamingOptions |
返り値
Promise<EventDrivenStream>
ストリーミングdataを処理するためのイベント駆動型ストリーム
定義元
stream/stream_client.ts:710postsSample10
partition, options?): Promise<EventDrivenStream>
Post の10%サンプルをストリーミング
公開された Post の 10% サンプルをリアルタイムでストリーミングします。
使いやすいイベント駆動型ストリームを返します。
.on() を使って ‘data’、‘error’、‘close’ といったイベントを監視できます。
for await…of による非同期イテレーションにも対応しています。
パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
partition | number | パーティション番号 |
options | PostsSample10StreamingOptions | - |
戻り値
Promise<EventDrivenStream>
ストリーミングデータを処理するためのイベント駆動型ストリーム
定義先
stream/stream_client.ts:839likesFirehose
partition, options?): Promise<EventDrivenStream>
全てのLikeをストリーミング
公開されている全てのLikeをリアルタイムでストリーミングします。
使いやすいイベント駆動型ストリームを返します。
.on() を使って ‘data’、‘error’、‘close’ などのイベントを監視できます。
for await…of を用いた非同期イテレーションにも対応しています。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
partition | number | パーティション番号 |
options | LikesFirehoseStreamingOptions | - |
返却値
Promise<EventDrivenStream>
ストリーミングデータを処理するためのイベント駆動型ストリーム
定義箇所
likesCompliance
options?): Promise<EventDrivenStream>
いいねに関するコンプライアンスのdataをストリーミングします
ユーザーのいいねに関連するすべてのコンプライアンスのdataをストリーミングします。
使いやすいイベント駆動型ストリームを返します。
‘data’、‘error’、‘close’ などのイベントを受け取るには .on() を使用します。
for await…of による非同期イテレーションにも対応しています。
パラメーター
| 名前 | 型 |
|---|---|
options | LikesComplianceStreamingOptions |
返り値
Promise<EventDrivenStream>
ストリーミングデータを処理するためのイベント駆動型ストリーム
定義箇所
postsFirehoseEn
partition, options?): Promise<EventDrivenStream>
英語のPostをストリーム
公開されている英語のPostをリアルタイムでストリーミングします。
使いやすいイベント駆動型ストリームを返します。
.on() を使用して ‘data’、‘error’、‘close’ などのイベントをリッスンできます。
for await…of による非同期イテレーションにも対応しています。
パラメーター
| Name | Type | Description |
|---|---|---|
partition | number | パーティション番号 |
options | PostsFirehoseEnStreamingOptions | - |
戻り値
Promise<EventDrivenStream>
ストリーミングデータを処理するためのイベント駆動型ストリーム
定義元
stream/stream_client.ts:1189postsCompliance
partition, options?): Promise<EventDrivenStream>
Post のコンプライアンスデータをストリーミングします
Post に関連するすべてのコンプライアンスデータをストリーミングします。
使いやすいイベント駆動型のストリームを返します。
.on() を使って ‘data’、‘error’、‘close’ などのイベントをリッスンできます。
for await…of を用いた非同期反復処理にも対応しています。
パラメーター
| 名前 | 型 | 説明 |
|---|---|---|
partition | number | パーティション番号 |
options | PostsComplianceStreamingOptions | - |
返り値
Promise<EventDrivenStream>
ストリーミングdataを処理するイベント駆動型ストリーム
定義箇所
postsFirehose
partition, options?): Promise<EventDrivenStream>
すべてのPostをストリーミング
公開されているすべてのPostをリアルタイムでストリーミングします。
使いやすいイベント駆動型ストリームを返します。
.on() を使って ‘data’、‘error’、‘close’ などのイベントをリッスンできます。
for await…of による非同期イテレーションにも対応しています。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
partition | number | パーティション番号 |
options | PostsFirehoseStreamingOptions | - |
戻り値
Promise<EventDrivenStream>
ストリーミングデータを処理するためのイベント駆動型ストリーム
定義場所
stream/stream_client.ts:1421likesSample10
partition, options?): Promise<EventDrivenStream>
サンプルされた「いいね」のストリーム
公開「いいね」の10%サンプルをリアルタイムでストリーミングします。
使いやすいイベント駆動型ストリームを返します。
.on() を使用して ‘data’、‘error’、‘close’ などのイベントを監視できます。
for await…of による非同期イテレーションにも対応しています。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
partition | number | パーティション番号 |
options | LikesSample10StreamingOptions | - |
返却値
Promise<EventDrivenStream>
ストリーミングdataを処理するためのイベント駆動型ストリーム
定義箇所
postsFirehosePt
partition, options?): Promise<EventDrivenStream>
ポルトガル語のPostをストリーミング
公開されているポルトガル語のPostをすべてリアルタイムで配信します。
使いやすいイベント駆動型ストリームを返します。
.on() を使って ‘data’、‘error’、‘close’ といったイベントを監視できます。
for await…of による非同期反復処理にも対応しています。
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
partition | number | パーティション番号 |
options | PostsFirehosePtStreamingOptions | - |
返り値
Promise<EventDrivenStream>
ストリーミングdataを処理するためのイベント駆動型ストリーム
定義場所
stream/stream_client.ts:1680postsFirehoseKo
partition, options?): Promise<EventDrivenStream>
韓国語のPostのストリーム
公開されている韓国語のPostをすべてリアルタイムで配信します。
使いやすいイベント駆動型ストリームを返します。
.on() を使って ‘data’、‘error’、‘close’ などのイベントを監視できます。
for await…of を用いた非同期反復にも対応しています。
パラメータ
| Name | Type | Description |
|---|---|---|
partition | number | パーティション番号 |
options | PostsFirehoseKoStreamingOptions | - |
返り値
Promise<EventDrivenStream>
ストリーミングdataを処理するためのイベント駆動型ストリーム
定義場所
stream/stream_client.ts:1814labelsCompliance
options?): Promise<EventDrivenStream>
Post ラベルのストリーム
Post に適用されたすべてのラベル付けイベントをストリーミングします。
使いやすいイベント駆動型ストリームを返します。
.on() を使用して ‘data’、‘error’、‘close’ などのイベントをリッスンできます。
for await…of による非同期イテレーションにも対応しています。
パラメータ
| 名称 | 型 |
|---|---|
options | LabelsComplianceStreamingOptions |
返り値
Promise<EventDrivenStream>
ストリーミングデータを処理するためのイベント駆動型ストリーム
定義箇所
usersCompliance
partition, options?): Promise<EventDrivenStream>
Users のコンプライアンス data をストリーミング
Users に関連するすべてのコンプライアンス data をストリーム配信します。
使いやすいイベント駆動型のストリームを返します。
.on() を使って ‘data’、‘error’、‘close’ などのイベントを監視できます。
for await…of による非同期イテレーションにも対応しています。
パラメーター
| 名称 | 型 | 説明 |
|---|---|---|
partition | number | パーティション番号 |
options | UsersComplianceStreamingOptions | - |
返り値
Promise<EventDrivenStream>
ストリーミングデータを処理するためのイベント駆動型ストリーム
定義
stream/stream_client.ts:2039postsSample
options?): Promise<EventDrivenStream>
Post のサンプルをストリーミング
公開 Post の 1% サンプルをリアルタイムでストリーミングします。
使いやすいイベント駆動型ストリームを返します。
.on() を使って ‘data’、‘error’、‘close’ などのイベントを監視します。
for await…of による非同期イテレーションにも対応しています。
パラメータ
| Name | Type |
|---|---|
options | PostsSampleStreamingOptions |
返り値
Promise<EventDrivenStream>
ストリーミングdataを処理するためのイベント駆動型ストリーム
定義箇所
getRuleCounts
options?): Promise<Get2TweetsSearchStreamRulesCountsResponse>
ストリームルールのカウントを取得
フィルタードストリームのアクティブルールセットに含まれるルールの件数を取得します。
パラメーター
| 名称 | 型 |
|---|---|
options | GetRuleCountsStreamingOptions |
返り値
Promise<Get2TweetsSearchStreamRulesCountsResponse>
API レスポンスを返す Promise
定義元
stream/stream_client.ts:2242getRules
options?): Promise<RulesLookupResponse>
ストリームルールを取得
フィルターストリームの有効なルールセット、またはその一部を取得します。
パラメータ
| 名称 | 型 |
|---|---|
options | GetRulesStreamingOptions |
返り値
Promise<RulesLookupResponse>
API レスポンスを返す Promise
定義箇所
updateRules
body, options?): Promise<AddOrDeleteRulesResponse>
ストリームルールを更新します
フィルタ済みストリームのアクティブなルールセットに対して、ルールを追加または削除します。
パラメーター
| 名前 | 型 |
|---|---|
body | any |
options | UpdateRulesStreamingOptions |
返り値
Promise<AddOrDeleteRulesResponse>
API レスポンスを返す Promise