aws-sdk 1.9.0 → 1.9.1

data/lib/aws/simple_db.rb

@@ -203,14 +203,14 @@ module AWS
 
     # @return [Boolean] Returns true if we are inside an AWS::SimpleDB
     #   #consistent_reads method block.
-    # @private
+    # @api private
     def self.in_consistent_reads_block?
       !Thread.current['_simple_db_consistent_reads_'].nil?
     end
 
     # @return [Boolean] Returns true if the consistent_reads block has
     #   a true state, false otherwise.
-    # @private
+    # @api private
     def self.consistent_reads_state
       Thread.current['_simple_db_consistent_reads_']
     end

data/lib/aws/simple_db/attribute.rb

@@ -23,7 +23,7 @@ module AWS
       include PutAttributes
       include DeleteAttributes
 
-      # @private
+      # @api private
       def initialize item, name, options = {}
         @item = item
         @name = name
@@ -142,7 +142,7 @@ module AWS
         values
       end
 
-      # @private
+      # @api private
       protected
       def put values, replace
         expect_opts = values.pop if values.last.kind_of?(Hash)

data/lib/aws/simple_db/client.rb

@@ -17,19 +17,19 @@ module AWS
     # Client class for Amazon SimpleDB.
     class Client < Core::QueryClient
 
-      # @private
+      # @api private
       REGION_US_E1 = 'sdb.amazonaws.com'
 
-      # @private
+      # @api private
       REGION_US_W1 = 'sdb.us-west-1.amazonaws.com'
 
-      # @private
+      # @api private
       REGION_EU_W1 = 'sdb.eu-west-1.amazonaws.com'
 
-      # @private
+      # @api private
       REGION_APAC_SE1 = 'sdb.ap-southeast-1.amazonaws.com'
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[
         :domain_metadata,
         :get_attributes,
@@ -40,7 +40,7 @@ module AWS
       # @param [String] name
       # @return [Boolean] Returns true if the given name is a valid
       #   Amazon SimpleDB domain name.
-      # @private
+      # @api private
       def valid_domain_name? name
         self.class.valid_domain_name?(name)
       end

data/lib/aws/simple_db/consistent_read_option.rb

@@ -14,7 +14,7 @@
 module AWS
   class SimpleDB
 
-    # @private
+    # @api private
     module ConsistentReadOption
 
       # Determines if SimpleDB should be read consistently or not.

data/lib/aws/simple_db/delete_attributes.rb

@@ -14,12 +14,12 @@
 module AWS
   class SimpleDB
 
-    # @private
+    # @api private
     module DeleteAttributes
 
       include ExpectConditionOption
 
-      # @private
+      # @api private
       protected
       def delete_named_attributes *attribute_names
         expect_opts = attribute_names.pop if attribute_names.last.kind_of?(Hash)
@@ -34,7 +34,7 @@ module AWS
         client.delete_attributes(opts) unless attributes.empty?
       end
 
-      # @private
+      # @api private
       protected
       def delete_attribute_values(attributes)
         opts = {

data/lib/aws/simple_db/domain.rb

@@ -30,7 +30,7 @@ module AWS
     #
     class Domain
 
-      # @private
+      # @api private
       class NonEmptyDeleteError < StandardError; end
 
       include Core::Model
@@ -113,7 +113,7 @@ module AWS
       # An irb-friendly string representation of this object.
       #
       # @return [String]
-      # @private
+      # @api private
       def inspect
         "#<#{self.class}:#{name}>"
       end

data/lib/aws/simple_db/domain_metadata.rb

@@ -37,7 +37,7 @@ module AWS
 
       include Core::Model
 
-      # @private
+      # @api private
       ATTRIBUTES = [
         :item_count,
         :item_names_size_bytes,

data/lib/aws/simple_db/errors.rb

@@ -33,10 +33,10 @@ module AWS
     #
     # All errors raised as a result of error responses from the
     # service are instances of either {ClientError} or {ServerError}.
-    # @private
+    # @api private
     module Errors
 
-      # @private
+      # @api private
       GRAMMAR = Core::XML::Grammar.customize do
         element("Errors") do
           ignore

data/lib/aws/simple_db/expect_condition_option.rb

@@ -14,10 +14,10 @@
 module AWS
   class SimpleDB
 
-    # @private
+    # @api private
     module ExpectConditionOption
 
-      # @private
+      # @api private
       protected
       def expect_condition_opts(opts)
         expected = []

data/lib/aws/simple_db/item_collection.rb

@@ -21,7 +21,7 @@ module AWS
       # the regions before and after each quoted region, for example:
       #  "? ? `foo?``bar?` ? 'foo?' ?".scan(OUTSIDE_QUOTES_REGEX)
       #  # => [["? ? ", "`foo?``bar?`", " ? "], ["", "'foo?'", " ?"]]
-      # @private
+      # @api private
       OUTSIDE_QUOTES_REGEX = Regexp.compile(
         '([^\'"`]*)(`(?:[^`]*(?:``))*[^`]*`|' +
         '\'(?:[^\']*(?:\'\'))*[^\']*\'|'      +
@@ -35,13 +35,13 @@ module AWS
       # @return [Domain] The domain the items belong to.
       attr_reader :domain
 
-      # @private
+      # @api private
       attr_reader :output_list
 
-      # @private
+      # @api private
       attr_reader :conditions
 
-      # @private
+      # @api private
       attr_reader :sort_instructions
 
       # @param [Domain] domain The domain that you want an item collection for.
@@ -170,7 +170,7 @@ module AWS
         super
       end
 
-      # @private
+      # @api private
       def each_batch options = {}, &block
         handle_query_options(options) do |collection, opts|
           return collection.each_batch(opts, &block)
@@ -454,7 +454,7 @@ module AWS
       # Applies standard scope options (e.g. :where => 'foo') and removes them from
       # the options hash by calling their method (e.g. by calling #where('foo')).
       # Yields only if there were scope options to apply.
-      # @private
+      # @api private
       protected
       def handle_query_options(*args)
 
@@ -520,7 +520,7 @@ module AWS
 
       end
 
-      # @private
+      # @api private
       protected
       def select_expression options = {}
         expression = []
@@ -532,7 +532,7 @@ module AWS
         expression.compact.join(' ')
       end
 
-      # @private
+      # @api private
       protected
       def where_clause
 
@@ -546,19 +546,19 @@ module AWS
 
       end
 
-      # @private
+      # @api private
       protected
       def order_by_clause
         sort_instructions ? "ORDER BY #{sort_instructions}" : nil
       end
 
-      # @private
+      # @api private
       protected
       def limit_clause
         limit ? "LIMIT #{limit}" : nil
       end
 
-      # @private
+      # @api private
       protected
       def collection_with options
         ItemCollection.new(domain, {
@@ -570,7 +570,7 @@ module AWS
         }.merge(options))
       end
 
-      # @private
+      # @api private
       protected
       def replace_placeholders(str, *substitutions)
         named = {}
@@ -597,7 +597,7 @@ module AWS
         str
       end
 
-      # @private
+      # @api private
       protected
       def replace_placeholders_outside_quotes(str, count, substitutions, named = {})
         str, count = replace_positional_placeders(str, count, substitutions)
@@ -605,7 +605,7 @@ module AWS
         [str, count]
       end
 
-      # @private
+      # @api private
       protected
       def replace_positional_placeders(str, count, substitutions)
         str = str.gsub("?") do |placeholder|
@@ -617,7 +617,7 @@ module AWS
         [str, count]
       end
 
-      # @private
+      # @api private
       protected
       def replace_named_placeholders(str, named)
         named.each do |name, value|
@@ -629,7 +629,7 @@ module AWS
         str
       end
 
-      # @private
+      # @api private
       protected
       def coerce_substitution(subst)
         if subst.kind_of?(Array)
@@ -640,7 +640,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       protected
       def coerce_attribute(name)
         '`' + name.to_s.gsub('`', '``') + '`'

data/lib/aws/simple_db/item_data.rb

@@ -29,7 +29,7 @@ module AWS
     # corresponding {Item} instances.
     class ItemData
 
-      # @private
+      # @api private
       def initialize(opts = {})
         @name = opts[:name]
         @attributes = opts[:attributes]

data/lib/aws/simple_db/put_attributes.rb

@@ -14,14 +14,14 @@
 module AWS
   class SimpleDB
 
-    # @private
+    # @api private
     module PutAttributes
 
       include ExpectConditionOption
 
       # Given a single hash of attribute names to values, returns a list
       # of hashes suitable for the put_attributes :attributes option.
-      # @private
+      # @api private
       protected
       def attribute_hashes attributes, replace
         attribute_hashes = []
@@ -37,7 +37,7 @@ module AWS
         attribute_hashes
       end
 
-      # @private
+      # @api private
       protected
       def do_put attribute_hashes, expect_opts = {}
         return nil if attribute_hashes.empty?

data/lib/aws/simple_db/request.rb

@@ -14,7 +14,7 @@
 module AWS
   class SimpleDB
 
-    # @private
+    # @api private
     class Request < Core::Http::Request
       include Core::Signature::Version2
     end

data/lib/aws/simple_email_service.rb

@@ -384,7 +384,7 @@ module AWS
       end
     end
 
-    # @private
+    # @api private
     protected
     def require_one_of options, *keys
       unless keys.any?{|key| options[key] }
@@ -393,7 +393,7 @@ module AWS
       end
     end
 
-    # @private
+    # @api private
     protected
     def require_each options, *keys
       keys.each do |key|
@@ -403,7 +403,7 @@ module AWS
       end
     end
 
-    # @private
+    # @api private
     protected
     def nest_options options, accepted_options
 

data/lib/aws/simple_email_service/client.rb

@@ -19,7 +19,7 @@ module AWS
 
       REGION_US_E1 = 'email.us-east-1.amazonaws.com'
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[]
 
       # client methods #

data/lib/aws/simple_email_service/identity.rb

@@ -38,7 +38,7 @@ module AWS
     #
     class Identity < Core::Resource
 
-      # @private
+      # @api private
       def initialize email_address_or_domain, options = {}
         @identity = email_address_or_domain
         super

data/lib/aws/simple_email_service/identity_collection.rb

@@ -17,7 +17,7 @@ module AWS
 
       include Core::Collection::WithLimitAndNextToken
 
-      # @private
+      # @api private
       def initialize options = {}
         @type = options[:type]
         super

data/lib/aws/simple_email_service/quotas.rb

@@ -56,7 +56,7 @@ module AWS
       end
       alias_method :to_h, :to_hash
 
-      # @private
+      # @api private
       def inspect
         "<#{self.class} #{to_hash.inspect}>"
       end

data/lib/aws/simple_email_service/request.rb

@@ -13,7 +13,7 @@
 
 module AWS
   class SimpleEmailService
-    # @private
+    # @api private
     class Request < Core::Http::Request
 
       include Core::Signature::Version4

data/lib/aws/simple_workflow/activity_task.rb

@@ -21,7 +21,7 @@ module AWS
 
       include Core::Model
 
-      # @private
+      # @api private
       def initialize domain, data, options = {}
 
         @domain = domain

data/lib/aws/simple_workflow/activity_task_collection.rb

@@ -21,7 +21,7 @@ module AWS
       include Core::Model
       include OptionFormatters
 
-      # @private
+      # @api private
       def initialize domain, options = {}
         @domain = domain
         super

data/lib/aws/simple_workflow/client.rb

@@ -17,7 +17,7 @@ module AWS
     # Client class for Amazon Simple Workflow Service (SWF).
     class Client < Core::JSONClient
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[
         :count_pending_activity_tasks,
         :count_pending_decision_tasks,

data/lib/aws/simple_workflow/count.rb

@@ -20,7 +20,7 @@ module AWS
     # are definitive.
     class Count
 
-      # @private
+      # @api private
       def initialize count, truncated
         @count = count
         @truncated = truncated