Class: Saklient::Cloud::Models::Model_Script

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

Overview

スクリプトを検索・作成するための機能を備えたクラス.

Instance Attribute Summary

Attributes inherited from Model

#client, #count, #query, #total

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Model_Script

Returns a new instance of Model_Script.

Parameters:



165
166
167
168
 
# File 'lib/saklient/cloud/models/model_script.rb', line 165

def initialize(client)
  super(client)
  Saklient::Util::validate_type(client, 'Saklient::Cloud::Client')
end

Instance Method Details

#filter_by(key, value, multiple = false) ⇒ Model_Script

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

Parameters:

  • key (String) —

    キー

  • value (any) —

    値

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

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

Returns:



79
80
81
82
83
 
# File 'lib/saklient/cloud/models/model_script.rb', line 79

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

#find ⇒ Array<Saklient::Cloud::Resources::Script>

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

Returns:



104
105
106
 
# File 'lib/saklient/cloud/models/model_script.rb', line 104

def find
  return _find
end

#get_by_id(id) ⇒ Saklient::Cloud::Resources::Script

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

Parameters:

  • id (String)

Returns:



96
97
98
99
 
# File 'lib/saklient/cloud/models/model_script.rb', line 96

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

#limit(count) ⇒ Model_Script

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

Parameters:

  • count (Fixnum) —

    上限レコード数

Returns:



68
69
70
71
 
# File 'lib/saklient/cloud/models/model_script.rb', line 68

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

#offset(offset) ⇒ Model_Script

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

Parameters:

  • offset (Fixnum) —

    オフセット

Returns:



59
60
61
62
 
# File 'lib/saklient/cloud/models/model_script.rb', line 59

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

#reset ⇒ Model_Script

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

Returns:



88
89
90
 
# File 'lib/saklient/cloud/models/model_script.rb', line 88

def reset
  return _reset
end

#sort_by_name(reverse = false) ⇒ Model_Script

TODO:

Implement test case

名前でソートします.

Parameters:

  • reverse (bool) (defaults to: false)

Returns:



158
159
160
161
 
# File 'lib/saklient/cloud/models/model_script.rb', line 158

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

#with_name_like(name) ⇒ Model_Script

TODO:

Implement test case

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

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

Parameters:

  • name (String)

Returns:



116
117
118
119
 
# File 'lib/saklient/cloud/models/model_script.rb', line 116

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

#with_shared_scope ⇒ Model_Script

パブリックスクリプトに絞り込みます.

Returns:



173
174
175
176
 
# File 'lib/saklient/cloud/models/model_script.rb', line 173

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

#with_tag(tag) ⇒ Model_Script

TODO:

Implement test case

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

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

Parameters:

  • tag (String)

Returns:



128
129
130
131
 
# File 'lib/saklient/cloud/models/model_script.rb', line 128

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

#with_tag_dnf(dnf) ⇒ Model_Script

TODO:

Implement test case

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

Parameters:

  • dnf (Array<Array<String>>)

Returns:



148
149
150
151
 
# File 'lib/saklient/cloud/models/model_script.rb', line 148

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

#with_tags(tags) ⇒ Model_Script

TODO:

Implement test case

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

Parameters:

  • tags (Array<String>)

Returns:



138
139
140
141
 
# File 'lib/saklient/cloud/models/model_script.rb', line 138

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

#with_user_scope ⇒ Model_Script

プライベートスクリプトに絞り込みます.

Returns:



181
182
183
184
 
# File 'lib/saklient/cloud/models/model_script.rb', line 181

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