Edges - エッジへのアクセスオブジェクト¶

エッジリソースへのアクセスAPIを提供します。

Request Methods¶

警告

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

client = intdash.Client(...)
client.edges.list(name='foo')

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

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

list(name=None, nickname=None, type=None, email=None, disabled=False, sort='name', order='asc', limit=100, page=1, iterator=False)[ソース]¶

エッジのリストを取得します。

パラメータ

name (str) -- エッジ名
nickname (str) -- 表示名
type (EdgeType) -- エッジタイプ
email (str) -- メールアドレス
disabled (str) -- 有効フラグ
sort (str) -- ソートに使用するフィールド
order (str) -- ソート順 ( asc or desc )
limit (int) -- 最大取得件数
page (int) -- ページ番号
iterator (bool) -- Trueの場合、イテレータを生成します

戻り値

エッジオブジェクトのリスト

戻り値の型

list[Edge]

me()[ソース]¶

intdashにアクセスしているエッジ自身を取得します。

戻り値: intdashにアクセスしているエッジ自身のオブジェクト
戻り値の型: Edge

Request Params¶

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

エッジタイプを表す定数です。

device = 'device'¶

none = 'none'¶

user = 'user'¶

Response¶

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

エッジリソースを表すオブジェクトです。

uuid¶

UUID

Type: str

name¶

エッジ名

Type: str

description¶

説明

Type: str

nickname¶

表示名

Type: str

type¶

エッジタイプ

Type: EdgeType

disabled¶

無効フラグ

Type: bool

created_at¶

作成時刻

Type: pandas.Timestamp

updated_at¶

更新時刻

Type: pandas.Timestamp

last_login_at¶

最終ログイン時刻

Type: pandas.Timestamp