aws-sdk 1.9.0 → 1.9.1

data/lib/aws/core/policy.rb

@@ -108,7 +108,7 @@ module AWS
       # Removes the ids from the policy and its statements for the purpose
       # of comparing two policies for equivilence.
       # @return [Hash] Returns the policy as a hash with no ids
-      # @private
+      # @api private
       def hash_without_ids
         hash = self.to_h
         hash.delete('Id')
@@ -163,7 +163,7 @@ module AWS
       # @see ConditionBlock#add
       class OperatorBuilder
 
-        # @private
+        # @api private
         def initialize(condition_builder, key)
           @condition_builder = condition_builder
           @key = key
@@ -184,7 +184,7 @@ module AWS
         # @return [Array] Returns an array of policy conditions.
         attr_reader :conditions
 
-        # @private
+        # @api private
         def initialize(conditions)
           @conditions = conditions
         end
@@ -295,7 +295,7 @@ module AWS
       #
       class ConditionBlock
 
-        # @private
+        # @api private
         def initialize(conditions = {})
           # filter makes a copy
           @conditions = filter_conditions(conditions)
@@ -375,7 +375,7 @@ module AWS
           op[translate_key(key)] = converted_values
         end
 
-        # @private
+        # @api private
         def to_h
           @conditions
         end
@@ -447,7 +447,7 @@ module AWS
           end.compact.flatten
         end
 
-        # @private
+        # @api private
         protected
         def match_triple(filter, type, op, key, value)
           value = [value].flatten.first
@@ -468,7 +468,7 @@ module AWS
           [match, type]
         end
 
-        # @private
+        # @api private
         protected
         def match_operator(filter, op, value)
           # dates are the only values that don't come back as native types in JSON
@@ -477,13 +477,13 @@ module AWS
           translate_operator(filter, value) == op
         end
 
-        # @private
+        # @api private
         protected
         def match_key(filter, key, value = nil)
           translate_key(filter) == key
         end
 
-        # @private
+        # @api private
         protected
         def filter_conditions(conditions = @conditions)
           conditions.inject({}) do |m, (op, keys)|
@@ -496,7 +496,7 @@ module AWS
           end
         end
 
-        # @private
+        # @api private
         protected
         def translate_key(key)
           if key.kind_of?(Symbol)
@@ -517,13 +517,13 @@ module AWS
           end
         end
 
-        # @private
+        # @api private
         MODIFIERS = {
           /_ignoring_case$/ => "IgnoreCase",
           /_equals$/ => "Equals"
         }
 
-        # @private
+        # @api private
         protected
         def valid_operator?(operator)
           translate_operator(operator, "")
@@ -532,7 +532,7 @@ module AWS
           false
         end
 
-        # @private
+        # @api private
         protected
         def translate_operator(operator, example_value)
           return operator if operator.kind_of?(String)
@@ -545,100 +545,100 @@ module AWS
           send("translate_#{operator}", example_value, opts)
         end
 
-        # @private
+        # @api private
         protected
         def translate_is(example, opts)
           return "Bool" if type_notation(example) == "Bool"
           base_translate(example, "Equals", opts[:ignore_case])
         end
 
-        # @private
+        # @api private
         protected
         def translate_not(example, opts)
           base_translate(example, "NotEquals", opts[:ignore_case])
         end
 
-        # @private
+        # @api private
         protected
         def translate_like(example, opts)
           base_translate(example, "Like")
         end
 
-        # @private
+        # @api private
         protected
         def translate_not_like(example, opts)
           base_translate(example, "NotLike")
         end
 
-        # @private
+        # @api private
         protected
         def translate_less_than(example, opts)
           base_translate(example, "LessThan", opts[:equals])
         end
         alias_method :translate_lt, :translate_less_than
 
-        # @private
+        # @api private
         protected
         def translate_lte(example, opts)
           translate_less_than(example, { :equals => "Equals" })
         end
 
-        # @private
+        # @api private
         protected
         def translate_greater_than(example, opts)
           base_translate(example, "GreaterThan", opts[:equals])
         end
         alias_method :translate_gt, :translate_greater_than
 
-        # @private
+        # @api private
         protected
         def translate_gte(example, opts)
           translate_greater_than(example, { :equals => "Equals" })
         end
 
-        # @private
+        # @api private
         protected
         def translate_is_ip_address(example, opts)
           "IpAddress"
         end
 
-        # @private
+        # @api private
         protected
         def translate_not_ip_address(example, opts)
           "NotIpAddress"
         end
 
-        # @private
+        # @api private
         protected
         def translate_is_arn(example, opts)
           "ArnEquals"
         end
 
-        # @private
+        # @api private
         protected
         def translate_not_arn(example, opts)
           "ArnNotEquals"
         end
 
-        # @private
+        # @api private
         protected
         def translate_is_arn_like(example, opts)
           "ArnLike"
         end
 
-        # @private
+        # @api private
         protected
         def translate_not_arn_like(example, opts)
           "ArnNotLike"
         end
 
-        # @private
+        # @api private
         protected
         def base_translate(example, base_operator, *modifiers)
           "#{type_notation(example)}#{base_operator}#{modifiers.join}"
         end
 
-        # @private
+        # @api private
         protected
         def type_notation(example)
           case example
@@ -653,7 +653,7 @@ module AWS
           end
         end
 
-        # @private
+        # @api private
         protected
         def convert_value(value)
           case value
@@ -666,7 +666,7 @@ module AWS
           end
         end
 
-        # @private
+        # @api private
         protected
         def strip_modifiers(operator)
           opts = {}
@@ -770,7 +770,7 @@ module AWS
         end
         alias_method :exclude_action, :exclude_actions
 
-        # @private
+        # @api private
         def to_h
           stmt = {
             "Sid" => sid,

data/lib/aws/core/query_error_parser.rb

@@ -14,7 +14,7 @@
 module AWS
   module Core
 
-    # @private
+    # @api private
     module QueryErrorParser
 
 

data/lib/aws/core/query_request_builder.rb

@@ -14,7 +14,7 @@
 module AWS
   module Core
 
-    # @private
+    # @api private
     class QueryRequestBuilder
 
       def initialize api_version, operation

data/lib/aws/core/query_response_parser.rb

@@ -14,7 +14,7 @@
 module AWS
   module Core
 
-    # @private
+    # @api private
     class QueryResponseParser
 
       def initialize parsing_rules

data/lib/aws/core/region_collection.rb

@@ -40,7 +40,7 @@ module AWS
 
       # @option options [Configuration] :config (AWS.config)
       # @option options [ServiceInterface] :service (nil)
-      # @private
+      # @api private
       def initialize options = {}
         @config = options[:config] || AWS.config
         @service = options[:service]
@@ -78,13 +78,13 @@ module AWS
       class << self
 
         # @return [nil]
-        # @private
+        # @api private
         def clear!
           @data = nil
         end
 
         # @return [Hash] Returns a hash of region metadata.
-        # @private
+        # @api private
         def data
           @data ||= load_data
         end

data/lib/aws/core/resource.rb

@@ -15,16 +15,16 @@
 module AWS
   module Core
 
-    # @private
+    # @api private
     class Resource
 
       include Model
       include Cacheable
 
-      # @private
+      # @api private
       class NotFound < StandardError; end
 
-      # @private
+      # @api private
       def initialize *args
 
         super
@@ -67,13 +67,13 @@ module AWS
       end
       alias_method :==, :eql?
 
-      # @private
+      # @api private
       protected
       def get_resource attr_name
         raise NotImplementedError
       end
 
-      # @private
+      # @api private
       protected
       def update_resource attr, value
         raise NotImplementedError
@@ -82,13 +82,13 @@ module AWS
       # Overide this method is subclasses of Resource.  This method should
       # return an array of identifying key/value pairs.
       #
-      #     # @private
+      #     # @api private
       #     protected
       #     def resource_identifiers
       #       [[:user_name, name]]
       #     end
       #
-      # @private
+      # @api private
       protected
       def resource_identifiers
         raise NotImplementedError
@@ -100,25 +100,25 @@ module AWS
         Hash[resource_identifiers].merge(additional)
       end
 
-      # @private
+      # @api private
       protected
       def local_cache_key
         resource_identifiers.collect{|name,value| value.to_s }.join(":")
       end
 
-      # @private
+      # @api private
       protected
       def static_attributes
         @static_attributes ||= {}
       end
 
-      # @private
+      # @api private
       protected
       def ruby_name
         @ruby_name ||= Inflection.ruby_name(self.class.name)
       end
 
-      # @private
+      # @api private
       public
       def attributes_from_response resp
 
@@ -149,7 +149,7 @@ module AWS
 
       end
 
-      # @private
+      # @api private
       protected
       def cache_static_attributes request_type, resp_obj
         self.class.attribute_providers_for(request_type).each do |provider|
@@ -164,7 +164,7 @@ module AWS
 
       class << self
 
-        # @private
+        # @api private
         def define_attribute_type type_name
           class_eval <<-METHODS
 
@@ -180,33 +180,33 @@ module AWS
           METHODS
         end
 
-        # @private
+        # @api private
         def new_from request_type, resp_obj, *args
           resource = new(*args)
           resource.send(:cache_static_attributes, request_type, resp_obj)
           resource
         end
 
-        # @private
+        # @api private
         def attributes
           @attributes ||= Hash.new do |hash,attr_name|
             raise "uknown attribute #{attr_name}"
           end
         end
 
-        # @private
+        # @api private
         def attribute_providers
           @attribute_providers ||= []
         end
 
-        # @private
+        # @api private
         def attribute_providers_for request_type
           attribute_providers.select do |provider|
             provider.request_types.include?(request_type)
           end
         end
 
-        # @private
+        # @api private
         protected
         def attribute name, options = {}, &block
           attr = Attribute.new(name, options)
@@ -217,13 +217,13 @@ module AWS
           attributes[attr.name] = attr
         end
 
-        # @private
+        # @api private
         protected
         def mutable_attribute name, options = {}, &block
           attribute(name, options.merge(:mutable => true), &block)
         end
 
-        # @private
+        # @api private
         protected
         def define_attribute_getter attribute
           define_method(attribute.name) do
@@ -241,7 +241,7 @@ module AWS
           end
         end
 
-        # @private
+        # @api private
         protected
         def define_attribute_setter attribute
           setter = attribute.name.to_s.sub(/\?/, '') + '='
@@ -255,7 +255,7 @@ module AWS
           end
         end
 
-        # @private
+        # @api private
         protected
         def populates_from *request_types, &block
           provider = provider(*request_types)
@@ -264,7 +264,7 @@ module AWS
           provider
         end
 
-        # @private
+        # @api private
         protected
         def provider *request_types, &block
           provider = AttributeProvider.new(self, request_types)
@@ -277,7 +277,7 @@ module AWS
 
       end
 
-      # @private
+      # @api private
       class Attribute
 
         def initialize name, options = {}
@@ -335,7 +335,7 @@ module AWS
 
       end
 
-      # @private
+      # @api private
       class AttributeProvider
 
         def initialize klass, request_types