aws-sdk 1.8.5 → 1.9.0

data/lib/aws/simple_db/attribute_collection.rb

@@ -37,10 +37,12 @@ module AWS
       #
       # You can ask for any attribute by name.  The attribute may or may not
       # actually exist in SimpleDB.
-      # 
+      #
       # @example Get an attribute by symbol or string name
+      #
       #   colors = item.attributes[:colors]
       #   colors = item.attributes['colors']
+      #
       # @param [String, Symbol] attribute_name name of the attribute to get.
       # @return [Item] An item with the given name.
       def [] attribute_name
@@ -50,7 +52,9 @@ module AWS
       # Sets the values for a given attribute.
       #
       # @example Replace all of the values for the named attribute.
+      #
       #   item.attributes[:color] = 'red', 'blue'
+      #
       # @return This method returns the values passed to it.
       def []= attribute_name, *values
         self[attribute_name].set(*values)
@@ -64,12 +68,12 @@ module AWS
       #     puts "#{name}: #{value}"
       #   end
       #
-      # @yield [attribute_name, attribute_value] Yields once for every 
+      # @yield [attribute_name, attribute_value] Yields once for every
       #   attribute value on the item.
       # @yieldparam [String] attribute_name
       # @yieldparam [String] attribute_value
-      # @param [Hash] options 
-      # @option options [Boolean] :consistent_read (false) Causes this 
+      # @param [Hash] options
+      # @option options [Boolean] :consistent_read (false) Causes this
       #   method to yield the most current attributes for this item.
       # @return [nil]
       def each_value options = {}, &block
@@ -101,13 +105,13 @@ module AWS
       #   on the item.  Yields each attribute only one time, even it
       #   has multiple values.
       # @yieldparam [Attribute] attribute
-      # @param [Hash] options 
-      # @option options [Boolean] :consistent_read (false) Causes this 
+      # @param [Hash] options
+      # @option options [Boolean] :consistent_read (false) Causes this
       #   method to yield the most current attributes for this item.
       # @return [nil]
       def each options = {}, &block
         yielded = {}
-        each_value(options) do |attribute_name, attribute_value| 
+        each_value(options) do |attribute_name, attribute_value|
           unless yielded[attribute_name]
             attribute = self[attribute_name]
             yield(attribute)
@@ -119,7 +123,7 @@ module AWS
 
       # Replaces attributes for the {#item}.
       #
-      # The +attributes_hash+ should have attribute names as keys.  The 
+      # The `attributes_hash` should have attribute names as keys.  The
       # hash values should be either strings or arrays of strings.
       #
       # Attributes not named in this hash are left alone.  Attributes named
@@ -128,7 +132,7 @@ module AWS
       # @example
       #
       #   item.attributes.set(
-      #     'colors' => ['red', 'blue'],  
+      #     'colors' => ['red', 'blue'],
       #     'category' => 'clearance')
       #
       # @param [Hash] attributes
@@ -140,13 +144,13 @@ module AWS
 
       # Adds values to attributes on the {#item}.
       #
-      # The +attributes_hash+ should have attribute names as keys.  The 
+      # The `attributes_hash` should have attribute names as keys.  The
       # hash values should be either strings or arrays of strings.
       #
       # @example
       #
       #   item.attributes.add(
-      #     'colors' => ['red', 'blue'],  
+      #     'colors' => ['red', 'blue'],
       #     'category' => 'clearance')
       #
       # @param[Hash] attribute_hash
@@ -157,6 +161,8 @@ module AWS
 
       # Perform a mixed update of added and replace attributes.
       #
+      # @example
+      #
       #   item.attributes.put(
       #     :add => { 'colors' => %w(green blue), 'tags' => 'cool' }
       #     :replace => { 'quantity' => 5 }
@@ -183,11 +189,12 @@ module AWS
       # arrays of strings.
       #
       # @example
+      #
       #   item.attributes.to_h
       #   #=> { 'colors' => ['red','blue'], 'size' => ['large'] }
       #
-      # @param [Hash] options 
-      # @option options [Boolean] :consistent_read (false) Causes this 
+      # @param [Hash] options
+      # @option options [Boolean] :consistent_read (false) Causes this
       #   method to return the most current attributes values.
       # @return [Hash]
       def to_h options = {}
@@ -202,10 +209,12 @@ module AWS
       # Delete one or more attributes from {#item}.
       #
       # @example Delete a list of attributes by name (accepts a list or array)
+      #
       #   item.attributes.delete 'size', 'color'
       #   item.attributes.delete %w(size color)
       #
       # @example Delete a specific list of attribute values
+      #
       #   item.attributes.delete(:color => 'red', :tags => %w(special limited))
       #
       # @overload delete(attributes)

data/lib/aws/simple_db/client.rb

@@ -57,226 +57,226 @@ module AWS
       # @!method batch_delete_attributes(options = {})
       # Calls the BatchDeleteAttributes API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String) The name of the domain in
+      #   * `:domain_name` - *required* - (String) The name of the domain in
       #     which the attributes are being deleted.
-      #   * +:items+ - *required* - (Array<Hash>) A list of items on which to
+      #   * `:items` - *required* - (Array<Hash>) A list of items on which to
       #     perform the operation.
-      #     * +:name+ - *required* - (String)
-      #     * +:attributes+ - (Array<Hash>)
-      #       * +:name+ - *required* - (String) The name of the attribute.
-      #       * +:value+ - *required* - (String) The value of the attribute.
+      #     * `:name` - *required* - (String)
+      #     * `:attributes` - (Array<Hash>)
+      #       * `:name` - *required* - (String) The name of the attribute.
+      #       * `:value` - *required* - (String) The value of the attribute.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:response_metadata+ - (Hash)
-      #     * +:box_usage+ - (Numeric)
-      #     * +:response_id+ - (String)
+      #   * `:response_metadata` - (Hash)
+      #     * `:box_usage` - (Numeric)
+      #     * `:response_id` - (String)
 
       # @!method batch_put_attributes(options = {})
       # Calls the BatchPutAttributes API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String) The name of the domain in
+      #   * `:domain_name` - *required* - (String) The name of the domain in
       #     which the attributes are being stored.
-      #   * +:items+ - *required* - (Array<Hash>) A list of items on which to
+      #   * `:items` - *required* - (Array<Hash>) A list of items on which to
       #     perform the operation.
-      #     * +:name+ - *required* - (String) The name of the replaceable item.
-      #     * +:attributes+ - *required* - (Array<Hash>) The list of attributes
+      #     * `:name` - *required* - (String) The name of the replaceable item.
+      #     * `:attributes` - *required* - (Array<Hash>) The list of attributes
       #       for a replaceable item.
-      #       * +:name+ - *required* - (String) The name of the replaceable
+      #       * `:name` - *required* - (String) The name of the replaceable
       #         attribute.
-      #       * +:value+ - *required* - (String) The value of the replaceable
+      #       * `:value` - *required* - (String) The value of the replaceable
       #         attribute.
-      #       * +:replace+ - (Boolean) A flag specifying whether or not to
+      #       * `:replace` - (Boolean) A flag specifying whether or not to
       #         replace the attribute/value pair or to add a new
-      #         attribute/value pair. The default setting is +false+ .
+      #         attribute/value pair. The default setting is `false` .
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:response_metadata+ - (Hash)
-      #     * +:box_usage+ - (Numeric)
-      #     * +:response_id+ - (String)
+      #   * `:response_metadata` - (Hash)
+      #     * `:box_usage` - (Numeric)
+      #     * `:response_id` - (String)
 
       # @!method create_domain(options = {})
       # Calls the CreateDomain API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String) The name of the domain to
+      #   * `:domain_name` - *required* - (String) The name of the domain to
       #     create. The name can range between 3 and 255 characters and can
       #     contain the following characters: a-z, A-Z, 0-9, '_', '-', and '.'.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:response_metadata+ - (Hash)
-      #     * +:box_usage+ - (Numeric)
-      #     * +:response_id+ - (String)
+      #   * `:response_metadata` - (Hash)
+      #     * `:box_usage` - (Numeric)
+      #     * `:response_id` - (String)
 
       # @!method delete_attributes(options = {})
       # Calls the DeleteAttributes API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String) The name of the domain in
+      #   * `:domain_name` - *required* - (String) The name of the domain in
       #     which to perform the operation.
-      #   * +:item_name+ - *required* - (String) The name of the item. Similar
+      #   * `:item_name` - *required* - (String) The name of the item. Similar
       #     to rows on a spreadsheet, items represent individual objects that
       #     contain one or more value-attribute pairs.
-      #   * +:attributes+ - (Array<Hash>) A list of Attributes. Similar to
+      #   * `:attributes` - (Array<Hash>) A list of Attributes. Similar to
       #     columns on a spreadsheet, attributes represent categories of data
       #     that can be assigned to items.
-      #     * +:name+ - *required* - (String) The name of the attribute.
-      #     * +:value+ - (String) The value of the attribute.
-      #   * +:expected+ - (Hash) The update condition which, if specified,
+      #     * `:name` - *required* - (String) The name of the attribute.
+      #     * `:value` - (String) The value of the attribute.
+      #   * `:expected` - (Hash) The update condition which, if specified,
       #     determines whether the specified attributes will be deleted or not.
       #     The update condition must be satisfied in order for this request to
       #     be processed and the attributes to be deleted.
-      #     * +:name+ - (String) The name of the attribute involved in the
+      #     * `:name` - (String) The name of the attribute involved in the
       #       condition.
-      #     * +:value+ - (String) The value of an attribute. This value can
-      #       only be specified when the Exists parameter is equal to +true+ .
-      #     * +:exists+ - (Boolean) A value specifying whether or not the
+      #     * `:value` - (String) The value of an attribute. This value can
+      #       only be specified when the Exists parameter is equal to `true` .
+      #     * `:exists` - (Boolean) A value specifying whether or not the
       #       specified attribute must exist with the specified value in order
-      #       for the update condition to be satisfied. Specify +true+ if the
+      #       for the update condition to be satisfied. Specify `true` if the
       #       attribute must exist for the update condition to be satisfied.
-      #       Specify +false+ if the attribute should not exist in order for
+      #       Specify `false` if the attribute should not exist in order for
       #       the update condition to be satisfied.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:response_metadata+ - (Hash)
-      #     * +:box_usage+ - (Numeric)
-      #     * +:response_id+ - (String)
+      #   * `:response_metadata` - (Hash)
+      #     * `:box_usage` - (Numeric)
+      #     * `:response_id` - (String)
 
       # @!method delete_domain(options = {})
       # Calls the DeleteDomain API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String) The name of the domain to
+      #   * `:domain_name` - *required* - (String) The name of the domain to
       #     delete.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:response_metadata+ - (Hash)
-      #     * +:box_usage+ - (Numeric)
-      #     * +:response_id+ - (String)
+      #   * `:response_metadata` - (Hash)
+      #     * `:box_usage` - (Numeric)
+      #     * `:response_id` - (String)
 
       # @!method domain_metadata(options = {})
       # Calls the DomainMetadata API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String) The name of the domain for
+      #   * `:domain_name` - *required* - (String) The name of the domain for
       #     which to display the metadata of.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:item_count+ - (Integer)
-      #   * +:item_names_size_bytes+ - (Integer)
-      #   * +:attribute_name_count+ - (Integer)
-      #   * +:attribute_names_size_bytes+ - (Integer)
-      #   * +:attribute_value_count+ - (Integer)
-      #   * +:attribute_values_size_bytes+ - (Integer)
-      #   * +:timestamp+ - (Integer)
-      #   * +:response_metadata+ - (Hash)
-      #     * +:box_usage+ - (Numeric)
-      #     * +:response_id+ - (String)
+      #   * `:item_count` - (Integer)
+      #   * `:item_names_size_bytes` - (Integer)
+      #   * `:attribute_name_count` - (Integer)
+      #   * `:attribute_names_size_bytes` - (Integer)
+      #   * `:attribute_value_count` - (Integer)
+      #   * `:attribute_values_size_bytes` - (Integer)
+      #   * `:timestamp` - (Integer)
+      #   * `:response_metadata` - (Hash)
+      #     * `:box_usage` - (Numeric)
+      #     * `:response_id` - (String)
 
       # @!method get_attributes(options = {})
       # Calls the GetAttributes API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String) The name of the domain in
+      #   * `:domain_name` - *required* - (String) The name of the domain in
       #     which to perform the operation.
-      #   * +:item_name+ - *required* - (String) The name of the item.
-      #   * +:attribute_names+ - (Array<String>) The names of the attributes.
-      #   * +:consistent_read+ - (Boolean) Determines whether or not strong
+      #   * `:item_name` - *required* - (String) The name of the item.
+      #   * `:attribute_names` - (Array<String>) The names of the attributes.
+      #   * `:consistent_read` - (Boolean) Determines whether or not strong
       #     consistency should be enforced when data is read from SimpleDB. If
-      #     +true+ , any data previously written to SimpleDB will be returned.
+      #     `true` , any data previously written to SimpleDB will be returned.
       #     Otherwise, results will be consistent eventually, and the client
       #     may not see data that was written immediately before your read.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:attributes+ - (Array<Hash>)
-      #     * +:name+ - (String)
-      #     * +:alternate_name_encoding+ - (String)
-      #     * +:value+ - (String)
-      #     * +:alternate_value_encoding+ - (String)
-      #   * +:response_metadata+ - (Hash)
-      #     * +:box_usage+ - (Numeric)
-      #     * +:response_id+ - (String)
+      #   * `:attributes` - (Array<Hash>)
+      #     * `:name` - (String)
+      #     * `:alternate_name_encoding` - (String)
+      #     * `:value` - (String)
+      #     * `:alternate_value_encoding` - (String)
+      #   * `:response_metadata` - (Hash)
+      #     * `:box_usage` - (Numeric)
+      #     * `:response_id` - (String)
 
       # @!method list_domains(options = {})
       # Calls the ListDomains API operation.
       # @param [Hash] options
-      #   * +:max_number_of_domains+ - (Integer) The maximum number of domain
+      #   * `:max_number_of_domains` - (Integer) The maximum number of domain
       #     names you want returned. The range is 1 to 100. The default setting
       #     is 100.
-      #   * +:next_token+ - (String) A string informing Amazon SimpleDB where
+      #   * `:next_token` - (String) A string informing Amazon SimpleDB where
       #     to start the next list of domain names.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:domain_names+ - (Array<String>)
-      #   * +:next_token+ - (String)
-      #   * +:response_metadata+ - (Hash)
-      #     * +:box_usage+ - (Numeric)
-      #     * +:response_id+ - (String)
+      #   * `:domain_names` - (Array<String>)
+      #   * `:next_token` - (String)
+      #   * `:response_metadata` - (Hash)
+      #     * `:box_usage` - (Numeric)
+      #     * `:response_id` - (String)
 
       # @!method put_attributes(options = {})
       # Calls the PutAttributes API operation.
       # @param [Hash] options
-      #   * +:domain_name+ - *required* - (String) The name of the domain in
+      #   * `:domain_name` - *required* - (String) The name of the domain in
       #     which to perform the operation.
-      #   * +:item_name+ - *required* - (String) The name of the item.
-      #   * +:attributes+ - *required* - (Array<Hash>) The list of attributes.
-      #     * +:name+ - *required* - (String) The name of the replaceable
+      #   * `:item_name` - *required* - (String) The name of the item.
+      #   * `:attributes` - *required* - (Array<Hash>) The list of attributes.
+      #     * `:name` - *required* - (String) The name of the replaceable
       #       attribute.
-      #     * +:value+ - *required* - (String) The value of the replaceable
+      #     * `:value` - *required* - (String) The value of the replaceable
       #       attribute.
-      #     * +:replace+ - (Boolean) A flag specifying whether or not to
+      #     * `:replace` - (Boolean) A flag specifying whether or not to
       #       replace the attribute/value pair or to add a new attribute/value
-      #       pair. The default setting is +false+ .
-      #   * +:expected+ - (Hash) The update condition which, if specified,
+      #       pair. The default setting is `false` .
+      #   * `:expected` - (Hash) The update condition which, if specified,
       #     determines whether the specified attributes will be updated or not.
       #     The update condition must be satisfied in order for this request to
       #     be processed and the attributes to be updated.
-      #     * +:name+ - (String) The name of the attribute involved in the
+      #     * `:name` - (String) The name of the attribute involved in the
       #       condition.
-      #     * +:value+ - (String) The value of an attribute. This value can
-      #       only be specified when the Exists parameter is equal to +true+ .
-      #     * +:exists+ - (Boolean) A value specifying whether or not the
+      #     * `:value` - (String) The value of an attribute. This value can
+      #       only be specified when the Exists parameter is equal to `true` .
+      #     * `:exists` - (Boolean) A value specifying whether or not the
       #       specified attribute must exist with the specified value in order
-      #       for the update condition to be satisfied. Specify +true+ if the
+      #       for the update condition to be satisfied. Specify `true` if the
       #       attribute must exist for the update condition to be satisfied.
-      #       Specify +false+ if the attribute should not exist in order for
+      #       Specify `false` if the attribute should not exist in order for
       #       the update condition to be satisfied.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:response_metadata+ - (Hash)
-      #     * +:box_usage+ - (Numeric)
-      #     * +:response_id+ - (String)
+      #   * `:response_metadata` - (Hash)
+      #     * `:box_usage` - (Numeric)
+      #     * `:response_id` - (String)
 
       # @!method select(options = {})
       # Calls the Select API operation.
       # @param [Hash] options
-      #   * +:select_expression+ - *required* - (String) The expression used to
+      #   * `:select_expression` - *required* - (String) The expression used to
       #     query the domain.
-      #   * +:next_token+ - (String) A string informing Amazon SimpleDB where
+      #   * `:next_token` - (String) A string informing Amazon SimpleDB where
       #     to start the next list of ItemNames.
-      #   * +:consistent_read+ - (Boolean) Determines whether or not strong
+      #   * `:consistent_read` - (Boolean) Determines whether or not strong
       #     consistency should be enforced when data is read from SimpleDB. If
-      #     +true+ , any data previously written to SimpleDB will be returned.
+      #     `true` , any data previously written to SimpleDB will be returned.
       #     Otherwise, results will be consistent eventually, and the client
       #     may not see data that was written immediately before your read.
       # @return [Core::Response]
       #   The #data method of the response object returns
       #   a hash with the following structure:
-      #   * +:items+ - (Array<Hash>)
-      #     * +:name+ - (String)
-      #     * +:alternate_name_encoding+ - (String)
-      #     * +:attributes+ - (Array<Hash>)
-      #       * +:name+ - (String)
-      #       * +:alternate_name_encoding+ - (String)
-      #       * +:value+ - (String)
-      #       * +:alternate_value_encoding+ - (String)
-      #   * +:next_token+ - (String)
-      #   * +:response_metadata+ - (Hash)
-      #     * +:box_usage+ - (Numeric)
-      #     * +:response_id+ - (String)
+      #   * `:items` - (Array<Hash>)
+      #     * `:name` - (String)
+      #     * `:alternate_name_encoding` - (String)
+      #     * `:attributes` - (Array<Hash>)
+      #       * `:name` - (String)
+      #       * `:alternate_name_encoding` - (String)
+      #       * `:value` - (String)
+      #       * `:alternate_value_encoding` - (String)
+      #   * `:next_token` - (String)
+      #   * `:response_metadata` - (Hash)
+      #     * `:box_usage` - (Numeric)
+      #     * `:response_id` - (String)
 
       # end client methods #