class Saklient::Cloud::Models::Model_Region

リージョンを検索するための機能を備えたクラス.

Public Class Methods

new(client) click to toggle source

@private @param [Saklient::Cloud::Client] client

Calls superclass method Saklient::Cloud::Models::Model::new
# File lib/saklient/cloud/models/model_region.rb, line 131
def initialize(client)
  super(client)
  Saklient::Util::validate_type(client, 'Saklient::Cloud::Client')
end

Public Instance Methods

filter_by(key, value, multiple = false) click to toggle source

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

@param [String] key キー @param [any] value 値 @param [bool] multiple valueに配列を与え, OR条件で完全一致検索する場合にtrueを指定します. 通常, valueはスカラ値であいまい検索されます. @return [Model_Region]

# File lib/saklient/cloud/models/model_region.rb, line 77
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() click to toggle source

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

@return [Array<Saklient::Cloud::Resources::Region>] リソースオブジェクトの配列

# File lib/saklient/cloud/models/model_region.rb, line 102
def find
  return _find
end
get_by_id(id) click to toggle source

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

@param [String] id @return [Saklient::Cloud::Resources::Region] リソースオブジェクト

# File lib/saklient/cloud/models/model_region.rb, line 94
def get_by_id(id)
  Saklient::Util::validate_type(id, 'String')
  return _get_by_id(id)
end
limit(count) click to toggle source

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

@param [Fixnum] count 上限レコード数 @return [Model_Region] this

# File lib/saklient/cloud/models/model_region.rb, line 66
def limit(count)
  Saklient::Util::validate_type(count, 'Fixnum')
  return _limit(count)
end
offset(offset) click to toggle source

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

@param [Fixnum] offset オフセット @return [Model_Region] this

# File lib/saklient/cloud/models/model_region.rb, line 57
def offset(offset)
  Saklient::Util::validate_type(offset, 'Fixnum')
  return _offset(offset)
end
reset() click to toggle source

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

@return [Model_Region] this

# File lib/saklient/cloud/models/model_region.rb, line 86
def reset
  return _reset
end
sort_by_name(reverse = false) click to toggle source

名前でソートします.

@todo Implement test case @param [bool] reverse @return [Model_Region]

# File lib/saklient/cloud/models/model_region.rb, line 124
def sort_by_name(reverse = false)
  Saklient::Util::validate_type(reverse, 'bool')
  return _sort_by_name(reverse)
end
with_name_like(name) click to toggle source

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

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

@todo Implement test case @param [String] name @return [Model_Region]

# File lib/saklient/cloud/models/model_region.rb, line 114
def with_name_like(name)
  Saklient::Util::validate_type(name, 'String')
  return _with_name_like(name)
end

Protected Instance Methods

_api_path() click to toggle source

@private @return [String]

# File lib/saklient/cloud/models/model_region.rb, line 20
def _api_path
  return '/region'
end
_class_name() click to toggle source

@private @return [String]

# File lib/saklient/cloud/models/model_region.rb, line 38
def _class_name
  return 'Region'
end
_create_resource_impl(obj, wrapped = false) click to toggle source

@private @param [any] obj @param [bool] wrapped @return [Saklient::Cloud::Resources::Resource]

# File lib/saklient/cloud/models/model_region.rb, line 46
def _create_resource_impl(obj, wrapped = false)
  Saklient::Util::validate_type(wrapped, 'bool')
  return Saklient::Cloud::Resources::Region.new(@_client, obj, wrapped)
end
_root_key() click to toggle source

@private @return [String]

# File lib/saklient/cloud/models/model_region.rb, line 26
def _root_key
  return 'Region'
end
_root_key_m() click to toggle source

@private @return [String]

# File lib/saklient/cloud/models/model_region.rb, line 32
def _root_key_m
  return 'Regions'
end