aws-sdk 1.9.0 → 1.9.1

data/lib/aws/s3/multipart_upload_collection.rb

@@ -39,7 +39,7 @@ module AWS
       #   place.
       attr_reader :bucket
 
-      # @private
+      # @api private
       def initialize(bucket, opts = {})
         @bucket = bucket
         super

data/lib/aws/s3/object_collection.rb

@@ -282,7 +282,7 @@ module AWS
         super
       end
 
-      # @private
+      # @api private
       protected
       def each_member_in_page(page, &block)
         super
@@ -291,19 +291,19 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       protected
       def list_request options
         client.list_objects(options)
       end
 
-      # @private
+      # @api private
       protected
       def limit_param
         :max_keys
       end
 
-      # @private
+      # @api private
       protected
       def next_markers page
         marker = (last = page.contents.last and last.key)
@@ -315,7 +315,7 @@ module AWS
       end
 
       # processes items in batches of 1k items
-      # @private
+      # @api private
       class BatchHelper
 
         def initialize batch_size, &block

data/lib/aws/s3/object_upload_collection.rb

@@ -29,7 +29,7 @@ module AWS
       # @return [S3Object] The object to which the uploads belong.
       attr_reader :object
 
-      # @private
+      # @api private
       def initialize(object, opts = {})
         @all_uploads =
           MultipartUploadCollection.new(object.bucket).

data/lib/aws/s3/object_version.rb

@@ -138,7 +138,7 @@ module AWS
 
       alias_method :eql?, :==
 
-      # @private
+      # @api private
       def inspect
         "<#{self.class}:#{object.bucket.name}:#{object.key}:#{version_id}>"
       end

data/lib/aws/s3/paginated_collection.rb

@@ -14,7 +14,7 @@
 module AWS
   class S3
 
-    # @private
+    # @api private
     module PaginatedCollection
 
       include Core::Collection::WithLimitAndNextToken

data/lib/aws/s3/prefix_and_delimiter_collection.rb

@@ -14,7 +14,7 @@
 module AWS
   class S3
 
-    # @private
+    # @api private
     module PrefixAndDelimiterCollection
 
       include PrefixedCollection
@@ -24,7 +24,7 @@ module AWS
         Tree.new(self, { :prefix => prefix }.merge(options))
       end
 
-      # @private
+      # @api private
       protected
       def each_member_in_page(page, &block)
         super
@@ -33,7 +33,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       protected
       def list_options(options)
         opts = super

data/lib/aws/s3/prefixed_collection.rb

@@ -18,7 +18,7 @@ module AWS
 
       include PaginatedCollection
 
-      # @private
+      # @api private
       def initialize *args
         options = args.last.is_a?(Hash) ? args.pop : {}
         @prefix = options[:prefix]
@@ -72,7 +72,7 @@ module AWS
         self.class.new(bucket, :prefix => new_prefix)
       end
 
-      # @private
+      # @api private
       protected
       def list_options(options)
         opts = super

data/lib/aws/s3/presigned_post.rb

@@ -74,7 +74,7 @@ module AWS
       #   upload.  By default any size object may be uploaded.
       attr_reader :content_length
 
-      # @private
+      # @api private
       SPECIAL_FIELDS = [:cache_control,
                         :content_type,
                         :content_disposition,
@@ -86,7 +86,7 @@ module AWS
                         :success_action_status,
                         :filename]
 
-      # @private
+      # @api private
       attr_reader :conditions
 
       # @return [Array<String>] Additional fields which may be sent
@@ -238,7 +238,7 @@ module AWS
       # {PresignedPost#where} for usage examples.
       class ConditionBuilder
 
-        # @private
+        # @api private
         def initialize(post, field)
           @post = post
           @field = field
@@ -362,20 +362,20 @@ module AWS
 
       end
 
-      # @private
+      # @api private
       def with_equality_condition(option_name, value)
         field_name = field_name(option_name)
         with_condition(option_name, Hash[[[field_name, value]]])
       end
 
-      # @private
+      # @api private
       def with_prefix_condition(option_name, prefix)
         field_name = field_name(option_name)
         with_condition(option_name,
                        ["starts-with", "$#{field_name}", prefix])
       end
 
-      # @private
+      # @api private
       def refine(opts)
         self.class.new(bucket, {
                          :conditions => conditions,
@@ -389,7 +389,7 @@ module AWS
                        merge(opts))
       end
 
-      # @private
+      # @api private
       private
       def with_condition(field, condition)
         conditions = self.conditions.dup
@@ -397,7 +397,7 @@ module AWS
         refine(:conditions => conditions)
       end
 
-      # @private
+      # @api private
       private
       def format_expiration
         time = expires || Time.now.utc + 60*60
@@ -415,7 +415,7 @@ module AWS
         time.utc.iso8601
       end
 
-      # @private
+      # @api private
       private
       def range_value(range)
         case range
@@ -426,7 +426,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       private
       def split_range(range)
         range = range_value(range)
@@ -436,7 +436,7 @@ module AWS
           range.end)]
       end
 
-      # @private
+      # @api private
       private
       def optional_fields
         fields = (SPECIAL_FIELDS &
@@ -453,7 +453,7 @@ module AWS
         fields
       end
 
-      # @private
+      # @api private
       private
       def field_name(option_name)
         case option_name
@@ -472,7 +472,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       private
       def field_value(option_name)
         case option_name
@@ -490,7 +490,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       private
       def generate_conditions
 
@@ -512,7 +512,7 @@ module AWS
 
       end
 
-      # @private
+      # @api private
       private
       def ignored_conditions
         ignored_fields.map do |field|
@@ -520,7 +520,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       private
       def range_conditions
         if content_length
@@ -530,7 +530,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       private
       def key_conditions
         [if key && key.include?("${filename}")
@@ -542,7 +542,7 @@ module AWS
          end]
       end
 
-      # @private
+      # @api private
       private
       def build_uri(request)
         uri_class = secure? ? URI::HTTPS : URI::HTTP

data/lib/aws/s3/request.rb

@@ -17,7 +17,7 @@ require 'time'
 module AWS
   class S3
 
-    # @private
+    # @api private
     class Request < Core::Http::Request
 
       include Core::UriEscape
@@ -28,7 +28,7 @@ module AWS
       # @return [String] S3 object key
       attr_accessor :key
 
-      # @private
+      # @api private
       attr_accessor :force_path_style
 
       def metadata= metadata

data/lib/aws/s3/s3_object.rb

@@ -254,7 +254,7 @@ module AWS
       # @return [Bucket] The bucket this object is in.
       attr_reader :bucket
 
-      # @private
+      # @api private
       def inspect
         "<#{self.class}:#{bucket.name}/#{key}>"
       end
@@ -1067,7 +1067,7 @@ module AWS
 
       end
 
-      # @private
+      # @api private
       module ACLProxy
 
         attr_accessor :object
@@ -1125,7 +1125,7 @@ module AWS
 
       end
 
-      # @private
+      # @api private
       REQUEST_PARAMETERS = Request.query_parameters.map do |p|
         p.tr("-","_").to_sym
       end

data/lib/aws/s3/tree/branch_node.rb

@@ -30,7 +30,7 @@ module AWS
 
         include Parent
 
-        # @private
+        # @api private
         def initialize parent, collection, options = {}
           @parent = parent
           super(collection,

data/lib/aws/s3/tree/child_collection.rb

@@ -20,7 +20,7 @@ module AWS
         include Core::Model
         include Enumerable
 
-        # @private
+        # @api private
         def initialize parent, collection, options = {}
 
           options = {

data/lib/aws/s3/tree/leaf_node.rb

@@ -24,7 +24,7 @@ module AWS
       # @note Generally you do not need to create leaf nodes
       class LeafNode < Node
 
-        # @private
+        # @api private
         def initialize parent, member
           @parent = parent
           @member = member

data/lib/aws/s3/tree/node.rb

@@ -14,7 +14,7 @@
 module AWS
   class S3
     class Tree
-      # @private
+      # @api private
       class Node
       end
     end

data/lib/aws/s3/tree/parent.rb

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

data/lib/aws/s3/uploaded_part.rb

@@ -29,7 +29,7 @@ module AWS
       # @return [Integer] The part number.
       attr_reader :part_number
 
-      # @private
+      # @api private
       def initialize(upload, part_number, opts = {})
         @upload = upload
         @part_number = part_number
@@ -60,7 +60,7 @@ module AWS
         get_attribute(:etag)
       end
 
-      # @private
+      # @api private
       private
       def get_attribute(name)
         (resp = client.list_parts(:bucket_name => upload.object.bucket.name,

data/lib/aws/s3/uploaded_part_collection.rb

@@ -29,7 +29,7 @@ module AWS
       # @return [MultipartUpload] The upload to which the parts belong.
       attr_reader :upload
 
-      # @private
+      # @api private
       def initialize(upload, opts = {})
         @upload = upload
         super
@@ -43,7 +43,7 @@ module AWS
         UploadedPart.new(upload, number)
       end
 
-      # @private
+      # @api private
       protected
       def each_member_in_page(page, &block)
         page.parts.each do |part_info|
@@ -52,7 +52,7 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       protected
       def list_options(options)
         opts = super
@@ -62,17 +62,17 @@ module AWS
         opts
       end
 
-      # @private
+      # @api private
       protected
       def limit_param; :max_parts; end
 
-      # @private
+      # @api private
       protected
       def list_request(options)
         client.list_parts(options)
       end
 
-      # @private
+      # @api private
       protected
       def pagination_markers
         [:part_number_marker]

data/lib/aws/s3/website_configuration.rb

@@ -63,13 +63,13 @@ module AWS
 
       # This method exists for backwards compatability.
       # @return [String,nil]
-      # @private
+      # @api private
       def index_document_suffix
         (@options[:index_document] || {})[:suffix]
       end
 
       # This method exists for backwards compatability.
-      # @private
+      # @api private
       def index_document_suffix= suffix
         @options.delete(:redirect_all_requests_to)
         @options[:index_document] ||= {}
@@ -78,13 +78,13 @@ module AWS
 
       # This method exists for backwards compatability.
       # @return [String,nil]
-      # @private
+      # @api private
       def error_document_key
         (@options[:error_document] || {})[:key]
       end
 
       # This method exists for backwards compatability.
-      # @private
+      # @api private
       def error_document_key= key
         @options.delete(:redirect_all_requests_to)
         @options[:error_document] ||= {}