Class: Amazon::AWS::ResponseGroup

Inherits:
Object
  • Object
show all
Defined in:
lib/amazon/aws.rb

Overview

Response groups determine which data pertaining to the item(s) being sought is returned. They can strongly influence the amount of data returned, so you should always use the smallest response group(s) containing the data of interest to you, to avoid masses of unnecessary data being returned.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*rg) ⇒ ResponseGroup

Define a set of one or more response groups to be applied to items retrieved by an AWS operation.

If no response groups are given in rg when instantiating an object, Small will be used by default.

Example:

rg = ResponseGroup.new( 'Medium', 'Offers', 'Reviews' )



1138
1139
1140
1141
1142
 
# File 'lib/amazon/aws.rb', line 1138

def initialize(*rg)
	rg << 'Small' if rg.empty?
	@list = rg
	@params = { 'ResponseGroup' => @list.join( ',' ) }
end

Instance Attribute Details

#list ⇒ Object (readonly)

Returns the value of attribute list.



1126
1127
1128
 
# File 'lib/amazon/aws.rb', line 1126

def list
  @list
end

#params ⇒ Object (readonly)

Returns the value of attribute params.



1126
1127
1128
 
# File 'lib/amazon/aws.rb', line 1126

def params
  @params
end