Overview

Namespaces

  • PHP
  • Saklient
    • Cloud
      • Enums
      • Errors
      • Models
      • Resources
    • Errors

Classes

  • Model_Appliance
  • Model_Archive
  • Model_Bridge
  • Model_Disk
  • Model_DiskPlan
  • Model_Icon
  • Model_Iface
  • Model_Ipv6Net
  • Model_IsoImage
  • Model_License
  • Model_LicenseInfo
  • Model_Region
  • Model_Router
  • Model_RouterPlan
  • Model_Script
  • Model_Server
  • Model_ServerPlan
  • Model_Swytch
  • Overview
  • Namespace
  • Class
  • Tree

Class Model_Archive

アーカイブを検索・作成するための機能を備えたクラス。

Saklient\Cloud\Models\Model
Extended by Saklient\Cloud\Models\Model_Archive
Namespace: Saklient\Cloud\Models
Located at Saklient/Cloud/Models/Model_Archive.php
Methods summary
public Saklient\Cloud\Models\Model_Archive
# offset( integer $offset )

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

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

Parameters

$offset
integer
$offset オフセット

Returns

Saklient\Cloud\Models\Model_Archive
this
public Saklient\Cloud\Models\Model_Archive
# limit( integer $count )

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

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

Parameters

$count
integer
$count 上限レコード数

Returns

Saklient\Cloud\Models\Model_Archive
this
public Saklient\Cloud\Models\Model_Archive
# filterBy( string $key, mixed $value, boolean $multiple = false )

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

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

Parameters

$key
string
$key キー
$value
mixed
$value 値
$multiple
boolean
$multiple=false valueに配列を与え、OR条件で完全一致検索する場合にtrueを指定します。通常、valueはスカラ値であいまい検索されます。

Returns

Saklient\Cloud\Models\Model_Archive
public Saklient\Cloud\Models\Model_Archive
# reset( )

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

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

Returns

Saklient\Cloud\Models\Model_Archive
this
public Saklient\Cloud\Resources\Archive
# create( )

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

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

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

Returns

Saklient\Cloud\Resources\Archive
リソースオブジェクト
public Saklient\Cloud\Resources\Archive
# getById( string $id )

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

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

Parameters

$id
string
$id

Returns

Saklient\Cloud\Resources\Archive
リソースオブジェクト
public Saklient\Cloud\Resources\Archive[]
# find( )

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

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

Returns

Saklient\Cloud\Resources\Archive[]
リソースオブジェクトの配列
public Saklient\Cloud\Models\Model_Archive
# withNameLike( string $name )

指定した文字列を名前に含むリソースに絞り込みます。

指定した文字列を名前に含むリソースに絞り込みます。

大文字・小文字は区別されません。 半角スペースで区切られた複数の文字列は、それらをすべて含むことが条件とみなされます。

Parameters

$name
string
$name

Returns

Saklient\Cloud\Models\Model_Archive
public Saklient\Cloud\Models\Model_Archive
# withTag( string $tag )

指定したタグを持つリソースに絞り込みます。

指定したタグを持つリソースに絞り込みます。

複数のタグを指定する場合は withTags() を利用してください。

Parameters

$tag
string
$tag

Returns

Saklient\Cloud\Models\Model_Archive
public Saklient\Cloud\Models\Model_Archive
# withTags( string[] $tags )

指定したすべてのタグを持つリソースに絞り込みます。

指定したすべてのタグを持つリソースに絞り込みます。

Parameters

$tags
string[]
$tags

Returns

Saklient\Cloud\Models\Model_Archive
public Saklient\Cloud\Models\Model_Archive
# withTagDnf( string[][] $dnf )

指定したDNFに合致するタグを持つリソースに絞り込みます。

指定したDNFに合致するタグを持つリソースに絞り込みます。

Parameters

$dnf
string[][]
$dnf

Returns

Saklient\Cloud\Models\Model_Archive
public Saklient\Cloud\Models\Model_Archive
# sortByName( boolean $reverse = false )

名前でソートします。

名前でソートします。

Parameters

$reverse
boolean
$reverse=false

Returns

Saklient\Cloud\Models\Model_Archive
public Saklient\Cloud\Models\Model_Archive
# withSizeGib( integer $sizeGib )

指定したサイズのアーカイブに絞り込みます。

指定したサイズのアーカイブに絞り込みます。

Parameters

$sizeGib
integer
$sizeGib

Returns

Saklient\Cloud\Models\Model_Archive
public Saklient\Cloud\Models\Model_Archive
# withSharedScope( )

パブリックアーカイブに絞り込みます。

パブリックアーカイブに絞り込みます。

Returns

Saklient\Cloud\Models\Model_Archive
public Saklient\Cloud\Models\Model_Archive
# withUserScope( )

プライベートアーカイブに絞り込みます。

プライベートアーカイブに絞り込みます。

Returns

Saklient\Cloud\Models\Model_Archive
public Saklient\Cloud\Models\Model_Archive
# sortBySize( boolean $reverse = false )

サイズでソートします。

サイズでソートします。

Parameters

$reverse
boolean
$reverse=false

Returns

Saklient\Cloud\Models\Model_Archive
Methods inherited from Saklient\Cloud\Models\Model
__construct(), __get(), _apiPath(), _className(), _create(), _createResourceImpl(), _filterBy(), _find(), _findOne(), _getById(), _limit(), _offset(), _reset(), _rootKey(), _rootKeyM(), _sort(), _sortByName(), _withNameLike(), _withTag(), _withTagDnf(), _withTags(), get_client(), get_count(), get_query(), get_total()
Properties inherited from Saklient\Cloud\Models\Model
$_client, $_count, $_query, $_total
Magic properties inherited from Saklient\Cloud\Models\Model
$client, $count, $query, $total
API documentation generated by ApiGen 2.8.0