saklient.cloud.resources.archive.Archive Class Reference

Inheritance diagram for saklient.cloud.resources.archive.Archive:

Public Member Functions
def	save (self)
	このローカルオブジェクトに現在設定されているリソース情報をAPIに送信し、新規作成または上書き保存します。 More...
def	reload (self)
	最新のリソース情報を再取得します。 More...
def	__init__
def	get_is_available (self)
def	get_size_gib (self)
def	set_size_gib (self, sizeGib)
def	get_source (self)
def	set_source (self, source)
def	get_ftp_info (self)
def	open_ftp
	FTPSを開始し、イメージファイルをアップロード・ダウンロードできる状態にします。 More...
def	close_ftp (self)
	FTPSを終了し、アーカイブを利用可能な状態にします。 More...
def	sleep_while_copying
	コピー中のアーカイブが利用可能になるまで待機します。 More...
def	get_id (self)
	(This method is generated in Translator_default::buildImpl) More...
def	get_scope (self)
	(This method is generated in Translator_default::buildImpl) More...
def	get_name (self)
	(This method is generated in Translator_default::buildImpl) More...
def	set_name (self, v)
	(This method is generated in Translator_default::buildImpl) More...
def	get_description (self)
	(This method is generated in Translator_default::buildImpl) More...
def	set_description (self, v)
	(This method is generated in Translator_default::buildImpl) More...
def	get_tags (self)
	(This method is generated in Translator_default::buildImpl) More...
def	set_tags (self, v)
	(This method is generated in Translator_default::buildImpl) More...
def	get_icon (self)
	(This method is generated in Translator_default::buildImpl) More...
def	set_icon (self, v)
	(This method is generated in Translator_default::buildImpl) More...
def	get_display_order (self)
	(This method is generated in Translator_default::buildImpl) More...
def	set_display_order (self, v)
	(This method is generated in Translator_default::buildImpl) More...
def	get_size_mib (self)
	(This method is generated in Translator_default::buildImpl) More...
def	set_size_mib (self, v)
	(This method is generated in Translator_default::buildImpl) More...
def	get_service_class (self)
	(This method is generated in Translator_default::buildImpl) More...
def	get_plan (self)
	(This method is generated in Translator_default::buildImpl) More...
def	get_availability (self)
	(This method is generated in Translator_default::buildImpl) More...
def	api_deserialize_impl (self, r)
	(This method is generated in Translator_default::buildImpl) More...
def	api_serialize_impl

Public Attributes
	m_name
	n_name
	m_description
	n_description
	n_tags
	m_tags
	m_icon
	n_icon
	m_display_order
	n_display_order
	m_size_mib
	n_size_mib
	is_new
	is_incomplete
	m_id
	n_id
	m_scope
	n_scope
	m_service_class
	n_service_class
	m_plan
	n_plan
	m_availability
	n_availability

Properties
	is_available = property(get_is_available, None, None)
	ディスクが利用可能なときtrueを返します。
	size_gib = property(get_size_gib, set_size_gib, None)
	サイズ[GiB]
	source = property(get_source, set_source, None)
	アーカイブのコピー元
	ftp_info = property(get_ftp_info, None, None)
	FTP情報
	id = property(get_id, None, None)
	ID.
	scope = property(get_scope, None, None)
	スコープ EScope
	name = property(get_name, set_name, None)
	名前
	description = property(get_description, set_description, None)
	説明
	tags = property(get_tags, set_tags, None)
	タグ文字列の配列
	icon = property(get_icon, set_icon, None)
	アイコン
	display_order = property(get_display_order, set_display_order, None)
	表示順序
	size_mib = property(get_size_mib, set_size_mib, None)
	サイズ[MiB]
	service_class = property(get_service_class, None, None)
	サービスクラス
	plan = property(get_plan, None, None)
	プラン
	availability = property(get_availability, None, None)
	有効状態 EAvailability

Constructor & Destructor Documentation

def saklient.cloud.resources.archive.Archive.__init__	(		self,
			client,
			obj,
			wrapped = False
	)

Parameters

{saklient.cloud.client.Client}	client
{any}	obj
{bool}	wrapped=False

Member Function Documentation

def saklient.cloud.resources.archive.Archive.api_deserialize_impl	(		self,
			r
	)

(This method is generated in Translator_default::buildImpl)

Parameters

{any}

r

def saklient.cloud.resources.archive.Archive.api_serialize_impl	(		self,
			withClean = False
	)

Parameters

{bool}

withClean=False

Returns

{any}

def saklient.cloud.resources.archive.Archive.close_ftp

(

self

)

FTPSを終了し、アーカイブを利用可能な状態にします。

Returns

{saklient.cloud.resources.archive.Archive} this

def saklient.cloud.resources.archive.Archive.get_availability

(

self

)

(This method is generated in Translator_default::buildImpl)

Returns

{str}

def saklient.cloud.resources.archive.Archive.get_description

(

self

)

(This method is generated in Translator_default::buildImpl)

Returns

{str}

def saklient.cloud.resources.archive.Archive.get_display_order

(

self

)

(This method is generated in Translator_default::buildImpl)

Returns

{int}

def saklient.cloud.resources.archive.Archive.get_ftp_info

(

self

)

Returns

{saklient.cloud.resources.ftpinfo.FtpInfo}

def saklient.cloud.resources.archive.Archive.get_icon

(

self

)

(This method is generated in Translator_default::buildImpl)

Returns

{saklient.cloud.resources.icon.Icon}

def saklient.cloud.resources.archive.Archive.get_id

(

self

)

(This method is generated in Translator_default::buildImpl)

Returns

{str}

def saklient.cloud.resources.archive.Archive.get_is_available

(

self

)

Returns

{bool}

def saklient.cloud.resources.archive.Archive.get_name

(

self

)

(This method is generated in Translator_default::buildImpl)

Returns

{str}

def saklient.cloud.resources.archive.Archive.get_plan

(

self

)

(This method is generated in Translator_default::buildImpl)

Returns

{saklient.cloud.resources.diskplan.DiskPlan}

def saklient.cloud.resources.archive.Archive.get_scope

(

self

)

(This method is generated in Translator_default::buildImpl)

Returns

{str}

def saklient.cloud.resources.archive.Archive.get_service_class

(

self

)

(This method is generated in Translator_default::buildImpl)

Returns

{str}

def saklient.cloud.resources.archive.Archive.get_size_gib

(

self

)

Returns

{int}

def saklient.cloud.resources.archive.Archive.get_size_mib

(

self

)

(This method is generated in Translator_default::buildImpl)

Returns

{int}

def saklient.cloud.resources.archive.Archive.get_source

(

self

)

Returns

{saklient.cloud.resources.resource.Resource}

def saklient.cloud.resources.archive.Archive.get_tags

(

self

)

(This method is generated in Translator_default::buildImpl)

Returns

{str[]}

def saklient.cloud.resources.archive.Archive.open_ftp	(		self,
			reset = False
	)

FTPSを開始し、イメージファイルをアップロード・ダウンロードできる状態にします。

アカウント情報は、ftpInfo プロパティから取得することができます。

Parameters

{bool}

reset=False 既にFTPSが開始されているとき、trueを指定してこのメソッドを呼ぶことでパスワードを再設定します。

Returns

{saklient.cloud.resources.archive.Archive} this

def saklient.cloud.resources.archive.Archive.reload

(

self

)

最新のリソース情報を再取得します。

Returns

{saklient.cloud.resources.archive.Archive} this

def saklient.cloud.resources.archive.Archive.save

(

self

)

このローカルオブジェクトに現在設定されているリソース情報をAPIに送信し、新規作成または上書き保存します。

Returns

{saklient.cloud.resources.archive.Archive} this

def saklient.cloud.resources.archive.Archive.set_description	(		self,
			v
	)

(This method is generated in Translator_default::buildImpl)

Parameters

{str}

v

Returns

{str}

def saklient.cloud.resources.archive.Archive.set_display_order	(		self,
			v
	)

(This method is generated in Translator_default::buildImpl)

Parameters

{int}

v

Returns

{int}

def saklient.cloud.resources.archive.Archive.set_icon	(		self,
			v
	)

(This method is generated in Translator_default::buildImpl)

Parameters

{saklient.cloud.resources.icon.Icon}

v

Returns

{saklient.cloud.resources.icon.Icon}

def saklient.cloud.resources.archive.Archive.set_name	(		self,
			v
	)

(This method is generated in Translator_default::buildImpl)

Parameters

{str}

v

Returns

{str}

def saklient.cloud.resources.archive.Archive.set_size_gib	(		self,
			sizeGib
	)

Parameters

{int}

sizeGib

Returns

{int}

def saklient.cloud.resources.archive.Archive.set_size_mib	(		self,
			v
	)

(This method is generated in Translator_default::buildImpl)

Parameters

{int}

v

Returns

{int}

def saklient.cloud.resources.archive.Archive.set_source	(		self,
			source
	)

Parameters

{saklient.cloud.resources.resource.Resource}

source

Returns

{saklient.cloud.resources.resource.Resource}

def saklient.cloud.resources.archive.Archive.set_tags	(		self,
			v
	)

(This method is generated in Translator_default::buildImpl)

Parameters

{str[]}

v

Returns

{str[]}

def saklient.cloud.resources.archive.Archive.sleep_while_copying	(		self,
			timeoutSec = 3600
	)

コピー中のアーカイブが利用可能になるまで待機します。

Parameters

{int}

timeoutSec=3600

Returns

{bool} 成功時はtrue、タイムアウトやエラーによる失敗時はfalseを返します。

---

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

• saklient/cloud/resources/archive.py