class Saklient::Cloud::Resources::CommonServiceItem

共通サービス契約の実体1つに対応し, 属性の取得や操作を行うためのクラス.

Attributes

description[RW]

説明

@return [String]

icon[RW]

アイコン

@return [Icon]

id[R]

ID

@return [String]

m_description[RW]

説明

@return [String]

m_icon[RW]

アイコン

@return [Icon]

m_id[RW]

ID

@return [String]

m_name[RW]

名前

@return [String]

m_provider[RW]

共通サービスプロバイダ情報

@return [CommonServiceProvider]

m_raw_settings[RW]

設定の生データ

@return [any]

m_raw_settings_hash[RW]

@private @return [String]

m_raw_status[RW]

ステータスの生データ

@return [any]

m_tags[RW]

タグ文字列の配列

@return [Array<String>]

n_description[RW]

@return [bool]

n_icon[RW]

@return [bool]

n_id[RW]

@return [bool]

n_name[RW]

@return [bool]

n_provider[RW]

@return [bool]

n_raw_settings[RW]

@return [bool]

n_raw_settings_hash[RW]

@return [bool]

n_raw_status[RW]

@return [bool]

n_tags[RW]

@return [bool]

name[RW]

名前

@return [String]

provider[R]

共通サービスプロバイダ情報

@return [CommonServiceProvider]

raw_settings[RW]

設定の生データ

@return [any]

raw_settings_hash[R]

@private @return [String]

raw_status[R]

ステータスの生データ

@return [any]

tags[RW]

タグ文字列の配列

@return [Array<String>]

Public Class Methods

new(client, obj, wrapped = false) click to toggle source

@private @param [Saklient::Cloud::Client] client @param [any] obj @param [bool] wrapped

# File lib/saklient/cloud/resources/common_service_item.rb, line 112
def initialize(client, obj, wrapped = false)
  super(client)
  Saklient::Util::validate_type(client, 'Saklient::Cloud::Client')
  Saklient::Util::validate_type(wrapped, 'bool')
  api_deserialize(obj, wrapped)
end

Public Instance Methods

_class_name() click to toggle source

@private @return [String]

# File lib/saklient/cloud/resources/common_service_item.rb, line 84
def _class_name
  return 'CommonServiceItem'
end
_id() click to toggle source

@private @return [String]

# File lib/saklient/cloud/resources/common_service_item.rb, line 90
def _id
  return get_id
end
description=(v) click to toggle source
# File lib/saklient/cloud/resources/common_service_item.rb, line 226
def description=(v)
  set_description(v)
end
icon=(v) click to toggle source
# File lib/saklient/cloud/resources/common_service_item.rb, line 307
def icon=(v)
  set_icon(v)
end
name=(v) click to toggle source
# File lib/saklient/cloud/resources/common_service_item.rb, line 186
def name=(v)
  set_name(v)
end
raw_settings=(v) click to toggle source
# File lib/saklient/cloud/resources/common_service_item.rb, line 371
def raw_settings=(v)
  set_raw_settings(v)
end
reload() click to toggle source

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

@return [CommonServiceItem] this

# File lib/saklient/cloud/resources/common_service_item.rb, line 104
def reload
  return _reload
end
save() click to toggle source

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

@return [CommonServiceItem] this

# File lib/saklient/cloud/resources/common_service_item.rb, line 97
def save
  return _save
end
tags=(v) click to toggle source
# File lib/saklient/cloud/resources/common_service_item.rb, line 267
def tags=(v)
  set_tags(v)
end

Protected Instance Methods

_api_path() click to toggle source

@private @return [String]

# File lib/saklient/cloud/resources/common_service_item.rb, line 64
def _api_path
  return '/commonserviceitem'
end
_on_before_save(query) click to toggle source

@private @param [any] query @return [void]

# File lib/saklient/cloud/resources/common_service_item.rb, line 124
def _on_before_save(query)
  Saklient::Util::set_by_path(query, 'OriginalSettingsHash', get_raw_settings_hash)
end
_root_key() click to toggle source

@private @return [String]

# File lib/saklient/cloud/resources/common_service_item.rb, line 70
def _root_key
  return 'CommonServiceItem'
end
_root_key_m() click to toggle source

@private @return [String]

# File lib/saklient/cloud/resources/common_service_item.rb, line 76
def _root_key_m
  return 'CommonServiceItems'
end
api_deserialize_impl(r) click to toggle source

(This method is generated in Translator_default#buildImpl)

@param [any] r

# File lib/saklient/cloud/resources/common_service_item.rb, line 427
def api_deserialize_impl(r)
  @is_new = (r).nil?
  r = {} if @is_new
  @is_incomplete = false
  if Saklient::Util::exists_path(r, 'ID')
    @m_id = (Saklient::Util::get_by_path(r, 'ID')).nil? ? nil : Saklient::Util::get_by_path(r, 'ID').to_s
  else
    @m_id = nil
    @is_incomplete = true
  end
  @n_id = false
  if Saklient::Util::exists_path(r, 'Name')
    @m_name = (Saklient::Util::get_by_path(r, 'Name')).nil? ? nil : Saklient::Util::get_by_path(r, 'Name').to_s
  else
    @m_name = nil
    @is_incomplete = true
  end
  @n_name = false
  if Saklient::Util::exists_path(r, 'Description')
    @m_description = (Saklient::Util::get_by_path(r, 'Description')).nil? ? nil : Saklient::Util::get_by_path(r, 'Description').to_s
  else
    @m_description = nil
    @is_incomplete = true
  end
  @n_description = false
  if Saklient::Util::exists_path(r, 'Tags')
    if (Saklient::Util::get_by_path(r, 'Tags')).nil?
      @m_tags = []
    else
      @m_tags = []
      for t in Saklient::Util::get_by_path(r, 'Tags')
        v1 = nil
        v1 = (t).nil? ? nil : t.to_s
        @m_tags << v1
      end
    end
  else
    @m_tags = nil
    @is_incomplete = true
  end
  @n_tags = false
  if Saklient::Util::exists_path(r, 'Icon')
    @m_icon = (Saklient::Util::get_by_path(r, 'Icon')).nil? ? nil : Icon.new(@_client, Saklient::Util::get_by_path(r, 'Icon'))
  else
    @m_icon = nil
    @is_incomplete = true
  end
  @n_icon = false
  if Saklient::Util::exists_path(r, 'CommonServiceProvider')
    @m_provider = (Saklient::Util::get_by_path(r, 'CommonServiceProvider')).nil? ? nil : Saklient::Cloud::Resources::CommonServiceProvider.new(@_client, Saklient::Util::get_by_path(r, 'CommonServiceProvider'))
  else
    @m_provider = nil
    @is_incomplete = true
  end
  @n_provider = false
  if Saklient::Util::exists_path(r, 'Settings')
    @m_raw_settings = Saklient::Util::get_by_path(r, 'Settings')
  else
    @m_raw_settings = nil
    @is_incomplete = true
  end
  @n_raw_settings = false
  if Saklient::Util::exists_path(r, 'SettingsHash')
    @m_raw_settings_hash = (Saklient::Util::get_by_path(r, 'SettingsHash')).nil? ? nil : Saklient::Util::get_by_path(r, 'SettingsHash').to_s
  else
    @m_raw_settings_hash = nil
    @is_incomplete = true
  end
  @n_raw_settings_hash = false
  if Saklient::Util::exists_path(r, 'Status')
    @m_raw_status = Saklient::Util::get_by_path(r, 'Status')
  else
    @m_raw_status = nil
    @is_incomplete = true
  end
  @n_raw_status = false
end
api_serialize_impl(withClean = false) click to toggle source

@private @param [bool] withClean @return [any]

# File lib/saklient/cloud/resources/common_service_item.rb, line 508
def api_serialize_impl(withClean = false)
  Saklient::Util::validate_type(withClean, 'bool')
  missing = []
  ret = {}
  Saklient::Util::set_by_path(ret, 'ID', @m_id) if withClean || @n_id
  if withClean || @n_name
    Saklient::Util::set_by_path(ret, 'Name', @m_name)
  else
    missing << 'name' if @is_new
  end
  Saklient::Util::set_by_path(ret, 'Description', @m_description) if withClean || @n_description
  if withClean || @n_tags
    Saklient::Util::set_by_path(ret, 'Tags', [])
    for r1 in @m_tags
      v = nil
      v = r1
      ret[:Tags] << v
    end
  end
  Saklient::Util::set_by_path(ret, 'Icon', withClean ? ((@m_icon).nil? ? nil : @m_icon.api_serialize(withClean)) : ((@m_icon).nil? ? { ID: '0' } : @m_icon.api_serialize_id)) if withClean || @n_icon
  Saklient::Util::set_by_path(ret, 'CommonServiceProvider', withClean ? ((@m_provider).nil? ? nil : @m_provider.api_serialize(withClean)) : ((@m_provider).nil? ? { ID: '0' } : @m_provider.api_serialize_id)) if withClean || @n_provider
  Saklient::Util::set_by_path(ret, 'Settings', @m_raw_settings) if withClean || @n_raw_settings
  Saklient::Util::set_by_path(ret, 'SettingsHash', @m_raw_settings_hash) if withClean || @n_raw_settings_hash
  Saklient::Util::set_by_path(ret, 'Status', @m_raw_status) if withClean || @n_raw_status
  raise Saklient::Errors::SaklientException.new('required_field', 'Required fields must be set before the CommonServiceItem creation: ' + missing.join(', ')) if missing.length > 0
  return ret
end
get_description() click to toggle source

(This method is generated in Translator_default#buildImpl)

@private @return [String]

# File lib/saklient/cloud/resources/common_service_item.rb, line 199
def get_description
  return @m_description
end
get_icon() click to toggle source

(This method is generated in Translator_default#buildImpl)

@private @return [Icon]

# File lib/saklient/cloud/resources/common_service_item.rb, line 280
def get_icon
  return @m_icon
end
get_id() click to toggle source

(This method is generated in Translator_default#buildImpl)

@private @return [String]

# File lib/saklient/cloud/resources/common_service_item.rb, line 135
def get_id
  return @m_id
end
get_name() click to toggle source

(This method is generated in Translator_default#buildImpl)

@private @return [String]

# File lib/saklient/cloud/resources/common_service_item.rb, line 159
def get_name
  return @m_name
end
get_provider() click to toggle source

(This method is generated in Translator_default#buildImpl)

@private @return [CommonServiceProvider]

# File lib/saklient/cloud/resources/common_service_item.rb, line 320
def get_provider
  return @m_provider
end
get_raw_settings() click to toggle source

(This method is generated in Translator_default#buildImpl)

@private @return [any]

# File lib/saklient/cloud/resources/common_service_item.rb, line 344
def get_raw_settings
  @n_raw_settings = true
  return @m_raw_settings
end
get_raw_settings_hash() click to toggle source

(This method is generated in Translator_default#buildImpl)

@private @return [String]

# File lib/saklient/cloud/resources/common_service_item.rb, line 384
def get_raw_settings_hash
  return @m_raw_settings_hash
end
get_raw_status() click to toggle source

(This method is generated in Translator_default#buildImpl)

@private @return [any]

# File lib/saklient/cloud/resources/common_service_item.rb, line 407
def get_raw_status
  return @m_raw_status
end
get_tags() click to toggle source

(This method is generated in Translator_default#buildImpl)

@private @return [Array<String>]

# File lib/saklient/cloud/resources/common_service_item.rb, line 239
def get_tags
  @n_tags = true
  return @m_tags
end
set_description(v) click to toggle source

(This method is generated in Translator_default#buildImpl)

@private @param [String] v @return [String]

# File lib/saklient/cloud/resources/common_service_item.rb, line 208
def set_description(v)
  Saklient::Util::validate_type(v, 'String')
  @m_description = v
  @n_description = true
  return @m_description
end
set_icon(v) click to toggle source

(This method is generated in Translator_default#buildImpl)

@private @param [Icon] v @return [Icon]

# File lib/saklient/cloud/resources/common_service_item.rb, line 289
def set_icon(v)
  Saklient::Util::validate_type(v, 'Icon')
  @m_icon = v
  @n_icon = true
  return @m_icon
end
set_name(v) click to toggle source

(This method is generated in Translator_default#buildImpl)

@private @param [String] v @return [String]

# File lib/saklient/cloud/resources/common_service_item.rb, line 168
def set_name(v)
  Saklient::Util::validate_type(v, 'String')
  @m_name = v
  @n_name = true
  return @m_name
end
set_raw_settings(v) click to toggle source

(This method is generated in Translator_default#buildImpl)

@private @param [any] v @return [any]

# File lib/saklient/cloud/resources/common_service_item.rb, line 354
def set_raw_settings(v)
  @m_raw_settings = v
  @n_raw_settings = true
  return @m_raw_settings
end
set_tags(v) click to toggle source

(This method is generated in Translator_default#buildImpl)

@private @param [Array<String>] v @return [Array<String>]

# File lib/saklient/cloud/resources/common_service_item.rb, line 249
def set_tags(v)
  Saklient::Util::validate_type(v, 'Array')
  @m_tags = v
  @n_tags = true
  return @m_tags
end