saklient  0.0.2.11
saklient.cloud.models.model_iface.Model_Iface Class Reference
Inheritance diagram for saklient.cloud.models.model_iface.Model_Iface:

Public Member Functions

def offset (self, offset)
 次に取得するリストの開始オフセットを指定します。 More...
 
def limit (self, count)
 次に取得するリストの上限レコード数を指定します。 More...
 
def filter_by
 Web APIのフィルタリング設定を直接指定します。 More...
 
def reset (self)
 次のリクエストのために設定されているステートをすべて破棄します。 More...
 
def create (self)
 新規リソース作成用のオブジェクトを用意します。 More...
 
def get_by_id (self, id)
 指定したIDを持つ唯一のリソースを取得します。 More...
 
def find (self)
 リソースの検索リクエストを実行し、結果をリストで取得します。 More...
 
def __init__ (self, client)
 

Constructor & Destructor Documentation

def saklient.cloud.models.model_iface.Model_Iface.__init__ (   self,
  client 
)

Parameters
{saklient.cloud.client.Client}client

Member Function Documentation

def saklient.cloud.models.model_iface.Model_Iface.create (   self)

新規リソース作成用のオブジェクトを用意します。

返り値のオブジェクトにパラメータを設定し、save() を呼ぶことで実際のリソースが作成されます。

Returns
{saklient.cloud.resources.iface.Iface} リソースオブジェクト
def saklient.cloud.models.model_iface.Model_Iface.filter_by (   self,
  key,
  value,
  multiple = False 
)

Web APIのフィルタリング設定を直接指定します。

Parameters
{str}key キー
{any}value 値
{bool}multiple=False valueに配列を与え、OR条件で完全一致検索する場合にtrueを指定します。通常、valueはスカラ値であいまい検索されます。
Returns
{saklient.cloud.models.model_iface.Model_Iface}
def saklient.cloud.models.model_iface.Model_Iface.find (   self)

リソースの検索リクエストを実行し、結果をリストで取得します。

Returns
{saklient.cloud.resources.iface.Iface[]} リソースオブジェクトの配列
def saklient.cloud.models.model_iface.Model_Iface.get_by_id (   self,
  id 
)

指定したIDを持つ唯一のリソースを取得します。

Parameters
{str}id
Returns
{saklient.cloud.resources.iface.Iface} リソースオブジェクト
def saklient.cloud.models.model_iface.Model_Iface.limit (   self,
  count 
)

次に取得するリストの上限レコード数を指定します。

Parameters
{int}count 上限レコード数
Returns
{saklient.cloud.models.model_iface.Model_Iface} this
def saklient.cloud.models.model_iface.Model_Iface.offset (   self,
  offset 
)

次に取得するリストの開始オフセットを指定します。

Parameters
{int}offset オフセット
Returns
{saklient.cloud.models.model_iface.Model_Iface} this
def saklient.cloud.models.model_iface.Model_Iface.reset (   self)

次のリクエストのために設定されているステートをすべて破棄します。

Returns
{saklient.cloud.models.model_iface.Model_Iface} this

The documentation for this class was generated from the following file: