Class: AwsSsmEnv::FetchResult

Inherits:

Object

• Object
• AwsSsmEnv::FetchResult

Defined in:

lib/aws-ssm-env/fetcher.rb

Overview

parametersとnext_tokenを持った値オブジェクト。 Fetcerサブクラスのfetchメソッド戻り値として利用する。

Author:

• Ryohei Sonoda

Since:

• 0.1.0

Constant Summary

EMPTY =

Since:

• 0.1.0

new([])

Instance Attribute Summary

• #next_token ⇒ String readonly

  １回ですべてのパラメータが取得できないAPIを利用する場合に次の値を取得するためのトークン文字列。 だいたいのAWSのAPIには用意されているため、戻り値の型であるこのクラスに持たせる。.

• #parameters ⇒ Array readonly

  name, value プロパティを持ったパラメータオブジェクトの配列。配列要素の実装クラスは実行されるAPIによって変わる。.

Instance Method Summary

• #initialize(parameters, next_token = nil) ⇒ FetchResult constructor

  A new instance of FetchResult.

Constructor Details

#initialize(parameters, next_token = nil) ⇒ FetchResult

Returns a new instance of FetchResult.

Since:

• 0.1.0

# File 'lib/aws-ssm-env/fetcher.rb', line 113

def initialize(parameters, next_token = nil)
  @parameters = parameters
  @next_token = next_token
end

Instance Attribute Details

#next_token ⇒ String (readonly)

１回ですべてのパラメータが取得できないAPIを利用する場合に次の値を取得するためのトークン文字列。 だいたいのAWSのAPIには用意されているため、戻り値の型であるこのクラスに持たせる。

Returns:

• (String) —

  the current value of next_token

Since:

• 0.1.0

# File 'lib/aws-ssm-env/fetcher.rb', line 110

def next_token
  @next_token
end

#parameters ⇒ Array (readonly)

name, value プロパティを持ったパラメータオブジェクトの配列。配列要素の実装クラスは実行されるAPIによって変わる。

Returns:

• (Array) —

  the current value of parameters

Since:

• 0.1.0

# File 'lib/aws-ssm-env/fetcher.rb', line 110

def parameters
  @parameters
end