Captures - キャプチャーへのアクセスオブジェクト

キャプチャーリソースへのアクセスAPIを提供します。

Request Methods

警告

以下のアクセスオブジェクトは、必ず clientcaptures を使用して生成してください。

client = intdash.Client(...)
client.captures.get(uuid='bd670121-e420-49d5-b3eb-e6b5c103e454')
class Captures(...)[ソース]

キャプチャリソースへのアクセスオブジェクトです。

create(name, start, duration=None, shared=True, description='')[ソース]

キャプチャをサーバーへ作成します。

パラメータ
  • name (str) -- キャプチャ名

  • start (pandas.Timestamp) -- 開始時刻

  • description (str) -- 説明

  • shared (bool) -- 共有フラグ

  • duration (pandas.Timedelta) -- 継続時間

戻り値

作成されたキャプチャオブジェクト

戻り値の型

Capture

delete(uuid)[ソース]

キャプチャをサーバーから削除します。

パラメータ

uuid (str) -- 削除対象のキャプチャのUUID

get(uuid)[ソース]

キャプチャを取得します。

パラメータ

uuid (str) -- 取得対象のキャプチャの UUID

戻り値

キャプチャブジェクト

戻り値の型

Capture

list(start, end, name=None, sort='name', order='asc', limit=100, page=1, iterator=False)[ソース]

キャプチャのリストを取得します。

パラメータ
  • start (pandas.Timestamp) -- 取得対象期間の開始時刻

  • end (pandas.Timestamp) -- 取得対象期間の終了時刻

  • name (str) -- キャプチャ名に対するクエリ

  • sort (str) -- ソートに使用するフィールド名

  • order (str) -- ソート順 ( asc or desc )

  • limit (int) -- 最大取得件数

  • page (int) -- ページ番号

  • iterator (bool) -- Trueの場合、イテレータを生成します

戻り値

キャプチャオブジェクトのリスト

戻り値の型

list[Capture]

update(uuid, name=None, start=None, duration=None, shared=None, description=None)[ソース]

キャプチャを更新します。

パラメータ
  • uuid (str) -- 更新対象の計測のUUID

  • name (str) -- キャプチャ名

  • start (pandas.Timestamp) -- 開始時刻

  • duration (pandas.Timedelta) -- 継続時間

  • shared (bool) -- 共有フラグ

  • description (str) -- 説明

Response

class Capture(...)[ソース]

キャプチャリソースを表すオブジェクトです。

uuid

UUID

Type

str

name

キャプチャ名

Type

str

description

説明

Type

str

start

開始時刻

Type

pandas.Timestamp

duration

継続時間

Type

pandas.Timedelta

edge_uuid

キャプチャが紐づくエッジのUUID

Type

str

shared

共有フラグ

Type

bool

created_at

作成時刻

Type

pandas.Timestamp

updated_at

更新時刻

Type

pandas.Timestamp