Measurements - 計測へのアクセスオブジェクト

計測リソースへのアクセスAPIを提供します。 計測とは、エッジから生成・送信された時系列データのまとまりを示します。

Request Methods

警告

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

client = intdash.Client(...)
client.measurements.get(uuid='a9cdd3c2-6aa2-4347-b259-253bdc542d9a')
class Measurements(...)[ソース]

計測リソースへのアクセスオブジェクトです。

create(edge_uuid, basetime, basetime_type='manual', name='', description='', protect=False)[ソース]

計測をサーバーへ作成します。

パラメータ

  • edge_uuid (str) -- エッジのUUID

  • basetime (pandas.Timestamp) -- 基準時刻

  • basetime_type (BasetimeType) -- 基準時刻タイプ

  • name (str) -- 計測名

  • description (str) -- 説明

  • protect (bool) -- 保護要否

戻り値

作成された計測オブジェクト

戻り値の型

Measurement

注釈

計測の保護を解除する権限を持たないユーザーの場合、 保護された計測を作成することはできますが、 保護された計測を削除することはできません。 また、計測を保護する権限を持たないユーザーの場合、 保護されていない計測を、後から保護状態にすることはできません。

delete(uuid)[ソース]

計測をサーバーから削除します。

パラメータ

uuid (str) -- 削除対象の計測のUUID

get(uuid=None, marker_uuid=None)[ソース]

計測を取得します。

パラメータ

  • uuid (str) -- 取得対象の計測のUUID

  • marker_uuid (str) -- 計測マーカーのUUID（指定された計測マーカーに紐づく計測が取得されます）

戻り値

計測オブジェクト

戻り値の型

Measurement

注釈

uuid と marker_uuid をいずれも指定しない場合、 Value Error が発生します。 また、両方を指定した場合は計測のUUIDのみが使用されます。

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

計測のリストを取得します。

パラメータ

  • start (pandas.Timestamp) -- 取得対象範囲の始点

  • end (pandas.Timestamp) -- 取得対象範囲の終点

  • edge_uuid (str) -- 計測が紐づくエッジの UUID

  • name (str) -- 計測名

  • partial_match (bool) -- 部分一致フラグ

  • ended (boolean) -- 終了フラグ

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

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

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

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

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

戻り値

計測オブジェクトのリスト

戻り値の型

list[Measurement]

注釈

partial_match では、計測の取得条件を指定できます。 False を指定すると、計測のbasetimeが取得対象範囲に入っている場合に、その計測が取得対象となります。 True にすると、計測の一部が取得対象範囲に入っていればその計測は取得対象となります。

        | measurement1 |
        +--------------+
                            | measurement2 |
                            +--------------+
                | measurement3 |
                +--------------+
                                                    time
-----------+----------------------------+------------>
           |                            |
         start                         end

上記の例では、partial_match が True の場合、 measurement1 、 measurement2 、 measurement3 が取得できます。 partial_match が False の場合、 measurement2 、 measurement3 が取得できます。

protect(uuid)[ソース]

計測を保護します。

パラメータ

uuid (str) -- 保護対象の計測のUUID

unprotect(uuid)[ソース]

計測の保護を解除します。

パラメータ

uuid (str) -- 保護解除対象の計測のUUID

update(uuid, name=None, description=None, basetime_type=None, ended=None)[ソース]

計測を更新します。

パラメータ

  • uuid (str) -- 更新対象の計測のUUID

  • name (str) -- 計測名

  • description (str) -- 説明

  • basetime_type (BasetimeType) -- 基準時刻タイプ

  • ended (bool) -- 終了フラグ

Response

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

計測リソースを表すオブジェクトです。

uuid

UUID

Type

str

name

計測名

Type

str

description

説明

Type

str

edge_uuid

計測が紐づくエッジのUUID

Type

str

duration

継続時間

Type

pandas.Timedelta

basetime

基準時刻

Type

pandas.Timestamp

basetime_type

基準時刻タイプ

Type

BasetimeType

ended

終了フラグ

Type

bool

processed_ratio

処理済み比率

Type

float

protected

保護状態

Type

bool

markers

計測マーカー

Type

MeasurementMarker

created_at

作成時刻

Type

pandas.Timestamp

updated_at

更新時刻

Type

pandas.Timestamp