Class: Saklient::Cloud::Models::Model_Archive

Inherits:
Model
  • Object
show all
Defined in:
lib/saklient/cloud/models/model_archive.rb

Overview

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

Instance Method Summary (collapse)

Instance Method Details

- (Saklient::Cloud::Resources::Archive) create

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

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

Returns:



99
100
101
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 99

def create
  return _create
end

- (Model_Archive) filter_by(key, value, multiple = false)

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

Parameters:

  • key (String) —

    キー

  • value (any) —

    値

  • multiple (bool) (defaults to: false) —

    valueに配列を与え, OR条件で完全一致検索する場合にtrueを指定します. 通常, valueはスカラ値であいまい検索されます.

Returns:



81
82
83
84
85
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 81

def filter_by(key, value, multiple = false)
  Saklient::Util::validate_type(key, 'String')
  Saklient::Util::validate_type(multiple, 'bool')
  return _filter_by(key, value, multiple)
end

- (Array<Saklient::Cloud::Resources::Archive>) find

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

Returns:



115
116
117
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 115

def find
  return _find
end

- (Saklient::Cloud::Resources::Archive) get_by_id(id)

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

Parameters:

  • id (String)

Returns:



107
108
109
110
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 107

def get_by_id(id)
  Saklient::Util::validate_type(id, 'String')
  return _get_by_id(id)
end

- (Model_Archive) limit(count)

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

Parameters:

  • count (Fixnum) —

    上限レコード数

Returns:



70
71
72
73
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 70

def limit(count)
  Saklient::Util::validate_type(count, 'Fixnum')
  return _limit(count)
end

- (Model_Archive) offset(offset)

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

Parameters:

  • offset (Fixnum) —

    オフセット

Returns:



61
62
63
64
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 61

def offset(offset)
  Saklient::Util::validate_type(offset, 'Fixnum')
  return _offset(offset)
end

- (Model_Archive) reset

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

Returns:



90
91
92
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 90

def reset
  return _reset
end

- (Model_Archive) sort_by_name(reverse = false)

TODO:

Implement test case

名前でソートします.

Parameters:

  • reverse (bool) (defaults to: false)

Returns:



169
170
171
172
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 169

def sort_by_name(reverse = false)
  Saklient::Util::validate_type(reverse, 'bool')
  return _sort_by_name(reverse)
end

- (Model_Archive) sort_by_size(reverse = false)

サイズでソートします.

Parameters:

  • reverse (bool) (defaults to: false)

Returns:



211
212
213
214
215
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 211

def sort_by_size(reverse = false)
  Saklient::Util::validate_type(reverse, 'bool')
  _sort('SizeMB', reverse)
  return self
end

- (Model_Archive) with_name_like(name)

TODO:

Implement test case

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

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

Parameters:

  • name (String)

Returns:



127
128
129
130
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 127

def with_name_like(name)
  Saklient::Util::validate_type(name, 'String')
  return _with_name_like(name)
end

- (Model_Archive) with_shared_scope

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

Returns:



194
195
196
197
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 194

def with_shared_scope
  _filter_by('Scope', [Saklient::Cloud::Enums::EScope::shared])
  return self
end

- (Model_Archive) with_size_gib(sizeGib)

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

Parameters:

  • sizeGib (Fixnum)

Returns:



185
186
187
188
189
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 185

def with_size_gib(sizeGib)
  Saklient::Util::validate_type(sizeGib, 'Fixnum')
  _filter_by('SizeMB', [sizeGib * 1024])
  return self
end

- (Model_Archive) with_tag(tag)

TODO:

Implement test case

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

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

Parameters:

  • tag (String)

Returns:



139
140
141
142
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 139

def with_tag(tag)
  Saklient::Util::validate_type(tag, 'String')
  return _with_tag(tag)
end

- (Model_Archive) with_tag_dnf(dnf)

TODO:

Implement test case

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

Parameters:

  • dnf (Array<Array<String>>)

Returns:



159
160
161
162
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 159

def with_tag_dnf(dnf)
  Saklient::Util::validate_type(dnf, 'Array')
  return _with_tag_dnf(dnf)
end

- (Model_Archive) with_tags(tags)

TODO:

Implement test case

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

Parameters:

  • tags (Array<String>)

Returns:



149
150
151
152
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 149

def with_tags(tags)
  Saklient::Util::validate_type(tags, 'Array')
  return _with_tags(tags)
end

- (Model_Archive) with_user_scope

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

Returns:



202
203
204
205
 
# File 'lib/saklient/cloud/models/model_archive.rb', line 202

def with_user_scope
  _filter_by('Scope', [Saklient::Cloud::Enums::EScope::user])
  return self
end