Measurement Markers - 計測マーカーへのアクセスオブジェクト¶

計測マーカーリソースへのアクセスAPIを提供します。計測マーカーは、計測に対して特定の時刻、もしくは特定の区間に対して付与されるタグ情報です。

Request Methods¶

警告

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

client = intdash.Client(...)
client.measurement_markers.get(marker_uuid='704be0f0-11d2-4c0b-aeaa-251bad85e067')

class MeasurementMarkers(...)[ソース]¶

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

create(measurement_uuid, type, detail, name=None, description=None, tag=None)[ソース]¶

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

パラメータ

measurement_uuid (str) -- 計測UUID
type (MeasurementMarkerType) -- 計測マーカー種別 ( point or range )
detail (MeasurementMarkerDetail) -- 計測マーカーの詳細
name (str) -- 計測マーカー名
description (str) -- 説明
tag (dict) -- タグ情報

戻り値

計測マーカーオブジェクト

戻り値の型

MeasurementMarker

注釈

detail は指定した type に応じて以下のオブジェクトを指定ください。

type が point の場合は、intdash.MeasurementMarkerDetailPoint を指定してください。
type が range の場合は、intdash.MeasurementMarkerDetailRange を指定してください。

注釈

tag は、Key(string)とValue(string)のペアのみ登録することができます。

// NG
{
    "tagkey" : {
        "nestKey": "not allowed"
    }
}

// OK
{
    "tagkey1" : "ok"
    "tagkey2" : "ok"
}

delete(marker_uuid, measurement_uuid=None)[ソース]¶

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

パラメータ

marker_uuid (str) -- 削除対象のマーカーのUUID
measurement_uuid (str) -- 削除対象の計測マーカーが紐づいている計測のUUID

注釈

measurement_uuid を指定した際、 marker_uuid の計測マーカーが指定の計測に紐付いていない場合はエラーになります。

get(marker_uuid)[ソース]¶

計測マーカーを取得します。

パラメータ: marker_uuid (str) -- 取得対象の計測マーカーのUUID
戻り値: 計測マーカーオブジェクト
戻り値の型: MeasurementMarker

list(measurement_uuid)[ソース]¶

計測UUIDに紐づくすべての計測マーカーを取得します。

パラメータ: measurement_uuid (str) -- 計測UUID
戻り値: 計測マーカーオブジェクトのリスト
戻り値の型: list[MeasurementMarker]

update(marker_uuid, measurement_uuid=None, name=None, description=None, type=None, detail=None, tag=None)[ソース]¶

計測マーカーを更新します。

パラメータ

marker_uuid (str) -- 更新対象の計測マーカーのUUID
measurement_uuid (str) -- 更新対象の計測マーカーが紐づいている計測のUUID
type (MeasurementMarkerType) -- 計測マーカー種別 ( point or range )
detail (MeasurementMarkerDetail) -- 計測マーカーの詳細
name (str) -- 計測マーカー名
description (str) -- 説明
tag (dict) -- タグ情報

戻り値

計測マーカーオブジェクト

戻り値の型

MeasurementMarker

注釈

detail は指定した type に応じて以下のオブジェクトを指定ください。 type が point の場合は、MeasurementMarkerDetailPoint を指定してください。 type が range の場合は、MeasurementMarkerDetailRange を指定してください。

注釈

measurement_uuid を指定した際、 marker_uuid の計測マーカーが指定の計測に紐付いていないと更新されません。

Request Params¶

class MeasurementMarkerType(...)[ソース]¶

計測マーカーのタイプを表す定数です。

point = 'point'¶

range = 'range'¶

class MeasurementMarkerDetail(...)[ソース]¶: 計測マーカーの詳細リクエスト用ベースクラスです。

class MeasurementMarkerDetailPoint(...)[ソース]¶

計測の単発マーカーの詳細リクエスト用のオブジェクトです。

occurred_elapsed_time¶

計測の開始時刻から計測マーカー発生時刻までの経過時間

Type: pandas.Timedelta

class MeasurementMarkerDetailRange(...)[ソース]¶

計測の範囲マーカーの詳細リクエスト用のオブジェクトです。

start_elapsed_time¶

計測の開始時刻から計測マーカー開始時刻までの経過時間

Type: pandas.Timedelta

end_elapsed_time¶

計測の開始時刻から計測マーカーの終了時刻までの経過時間

Type: pandas.Timedelta

Response¶

class MeasurementMarker(...)[ソース]¶

計測マーカーを表すオブジェクトです。

uuid¶

UUID

Type: str

name¶

計測マーカー名

Type: str

description¶

計測マーカーの説明

Type: str

type¶

計測マーカーのタイプ

Type: MeasurementMarkerType

detail¶

計測マーカーの詳細

Type: MeasurementMarkerDetail

tag¶

計測マーカーのタグ

Type: dict

created_at¶

作成時刻

Type: pandas.Timestamp

created_by¶

作成者

Type: str

updated_at¶

更新時刻

Type: pandas.Timestamp

updated_by¶

更新者

Type: str