aws-sdk 1.9.0 → 1.9.1

data/lib/aws/record/validators/numericality.rb

@@ -14,7 +14,7 @@
 module AWS
   module Record
 
-    # @private
+    # @api private
     class NumericalityValidator < Validator
 
       ACCEPTED_OPTIONS = [

data/lib/aws/record/validators/presence.rb

@@ -14,7 +14,7 @@
 module AWS
   module Record
 
-    # @private
+    # @api private
     class PresenceValidator < Validator
 
       ACCEPTED_OPTIONS = [:message, :allow_nil, :allow_blank, :on, :if, :unless]

data/lib/aws/redshift/client.rb

@@ -17,7 +17,7 @@ module AWS
     # Client class for Amazon Redshift.
     class Client < Core::QueryClient
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[]
 
       # client methods #

data/lib/aws/redshift/request.rb

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

data/lib/aws/route_53/change_batch.rb

@@ -29,7 +29,7 @@ module AWS
       include Enumerable
       include Core::Model
 
-      # @private
+      # @api private
       def initialize hosted_zone_id, options = {}
         super(options)
         @hosted_zone_id = hosted_zone_id
@@ -97,7 +97,7 @@ module AWS
 
     class ChangeRequest
 
-      # @private
+      # @api private
       def initialize(action, name, type, options={})
         @action = action
         @name = name

data/lib/aws/route_53/change_info.rb

@@ -24,7 +24,7 @@ module AWS
     #
     class ChangeInfo < Core::Resource
 
-      # @private
+      # @api private
       def initialize id, options = {}
         @id = id
         super

data/lib/aws/route_53/client.rb

@@ -17,7 +17,7 @@ module AWS
     # Client class for Route53.
     class Client < Core::RESTXMLClient
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[]
 
       # client methods #

data/lib/aws/route_53/hosted_zone.rb

@@ -30,7 +30,7 @@ module AWS
     #
     class HostedZone < Core::Resource
 
-      # @private
+      # @api private
       def initialize id, options = {}
         @id = id.sub(%r!^/hostedzone/!, '')
         @change_info = options[:change_info]

data/lib/aws/route_53/hosted_zone_collection.rb

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

data/lib/aws/route_53/request.rb

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

data/lib/aws/route_53/resource_record_set.rb

@@ -39,7 +39,7 @@ module AWS
     #
     class ResourceRecordSet < Core::Resource
 
-      # @private
+      # @api private
       def initialize name, type, options = {}
         @name = name
         @type = type

data/lib/aws/route_53/resource_record_set_collection.rb

@@ -30,7 +30,7 @@ module AWS
 
       include Core::Collection::WithLimitAndNextToken
 
-      # @private
+      # @api private
       def initialize hosted_zone_id, options = {}
         @hosted_zone_id = hosted_zone_id
         @filters = options[:filters] || {}

data/lib/aws/s3/access_control_list.rb

@@ -125,7 +125,7 @@ module AWS
             attr != :canonical_user_id and display_name
         end
 
-        # @private
+        # @api private
         def stag
           if attr = signal_attribute
             super + " xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"" +
@@ -135,12 +135,12 @@ module AWS
           end
         end
 
-        # @private
+        # @api private
         def signal_attribute
           SIGNAL_ATTRIBUTES.find { |att| send(att) }
         end
 
-        # @private
+        # @api private
         def type_for_attr(attr)
           {
             :amazon_customer_email => "AmazonCustomerByEmail",
@@ -164,7 +164,7 @@ module AWS
         # will be returned as `:full_control`.
         attr_reader :name
 
-        # @private
+        # @api private
         def initialize(name)
           raise "expected string or symbol" unless
             name.respond_to?(:to_str) or name.respond_to?(:to_sym)
@@ -210,19 +210,19 @@ module AWS
 
       include ACLObject
 
-      # @private
+      # @api private
       def stag
         super()+" xmlns=\"http://s3.amazonaws.com/doc/2006-03-01/\""
       end
 
-      # @private
+      # @api private
       def element_name
         "AccessControlPolicy"
       end
 
       class GrantBuilder
 
-        # @private
+        # @api private
         def initialize(acl, grant)
           @acl = acl
           @grant = grant

data/lib/aws/s3/acl_object.rb

@@ -19,18 +19,18 @@ module AWS
     # Common methods for AccessControlList and related objects.
     module ACLObject
 
-      # @private
+      # @api private
       def initialize(opts = {}); end
 
-      # @private
+      # @api private
       def body_xml; ""; end
 
-      # @private
+      # @api private
       def stag
         element_name
       end
 
-      # @private
+      # @api private
       def element_name
         self.class.name[/::([^:]*)$/, 1]
       end
@@ -69,12 +69,12 @@ module AWS
       # @see #valid?
       def validate!; end
 
-      # @private
+      # @api private
       def validate_input(name, value, context = nil)
         send("validate_#{name}_input!", value, context)
       end
 
-      # @private
+      # @api private
       module ClassMethods
 
         def string_attr(element_name, options = {})

data/lib/aws/s3/acl_options.rb

@@ -18,7 +18,7 @@ module AWS
 
     # Provides a method to {Bucket} and {S3Object} that parses a wide
     # range of ACL options.
-    # @private
+    # @api private
     module ACLOptions
 
       protected

data/lib/aws/s3/bucket.rb

@@ -483,7 +483,7 @@ module AWS
         @owner || client.list_buckets.owner
       end
 
-      # @private
+      # @api private
       def inspect
         "#<AWS::S3::Bucket:#{name}>"
       end
@@ -533,7 +533,7 @@ module AWS
         MultipartUploadCollection.new(self)
       end
 
-      # @private
+      # @api private
       module ACLProxy
 
         attr_accessor :bucket
@@ -576,7 +576,7 @@ module AWS
         nil
       end
 
-      # @private
+      # @api private
       module PolicyProxy
 
         attr_accessor :bucket

data/lib/aws/s3/bucket_collection.rb

@@ -148,7 +148,7 @@ module AWS
         nil
       end
 
-      # @private
+      # @api private
       private
       def bucket_named name, owner = nil
         S3::Bucket.new(name.to_s, :owner => owner, :config => config)

data/lib/aws/s3/bucket_lifecycle_configuration.rb

@@ -115,7 +115,7 @@ module AWS
     #
     class BucketLifecycleConfiguration
 
-      # @private
+      # @api private
       def initialize bucket, options = {}
         @bucket = bucket
         @rules = parse_xml(options[:xml]) if options[:xml]
@@ -334,7 +334,7 @@ module AWS
       #
       class Rule
 
-        # @private
+        # @api private
         def initialize configuration, id, prefix, expiration_time = nil, status = nil
           @configuration = configuration
           @id = id
@@ -404,7 +404,7 @@ module AWS
           self.status = 'Disabled'
         end
 
-        # @private
+        # @api private
         def eql? other
           other.is_a?(Rule) and
           other.configuration.bucket == configuration.bucket and

data/lib/aws/s3/bucket_tag_collection.rb

@@ -101,7 +101,7 @@ module AWS
       end
       alias_method :==, :eql?
 
-      # @private
+      # @api private
       def inspect
         self.to_h.inspect
       end

data/lib/aws/s3/bucket_version_collection.rb

@@ -47,7 +47,7 @@ module AWS
       #
       def each options = {}, █ super; end
 
-      # @private
+      # @api private
       protected
       def each_member_in_page(page, &block)
         super
@@ -58,17 +58,17 @@ module AWS
         end
       end
 
-      # @private
+      # @api private
       protected
       def list_request(options)
         client.list_object_versions(options)
       end
 
-      # @private
+      # @api private
       protected
       def limit_param; :max_keys; end
 
-      # @private
+      # @api private
       protected
       def pagination_markers; super + [:version_id_marker]; end
 

data/lib/aws/s3/cipher_io.rb

@@ -14,7 +14,7 @@
 module AWS
   class S3
 
-    # @private
+    # @api private
     class CipherIO
 
       def initialize cipher, stream, stream_size = nil

data/lib/aws/s3/client.rb

@@ -31,7 +31,7 @@ module AWS
 
       autoload :XML, 'aws/s3/client/xml'
 
-      # @private
+      # @api private
       EMPTY_BODY_ERRORS = {
         304 => Errors::NotModified,
         403 => Errors::Forbidden,
@@ -39,7 +39,7 @@ module AWS
         404 => Errors::NoSuchKey,
       }
 
-      # @private
+      # @api private
       CACHEABLE_REQUESTS = Set[]
 
       include DataOptions

data/lib/aws/s3/client/xml.rb

@@ -15,7 +15,7 @@ module AWS
   class S3
     class Client < Core::Client
 
-      # @private
+      # @api private
       module XML
 
         BaseGrammar = Core::XML::Grammar.new({}, :inflect_rename => true)

data/lib/aws/s3/data_options.rb

@@ -18,7 +18,7 @@ module AWS
 
     # Used by S3#S3Object and S3::Client to accept options with
     # data that should be uploaded (streamed).
-    # @private
+    # @api private
     module DataOptions
 
       protected
@@ -140,7 +140,7 @@ module AWS
 
       # A utility class that turns a block (with 2 args) into an
       # IO object that responds to #read and #eof.
-      # @private
+      # @api private
       class IOProxy
 
         def initialize write_block

data/lib/aws/s3/encryption_utils.rb

@@ -15,7 +15,7 @@ require 'openssl'
 
 module AWS
   class S3
-    # @private
+    # @api private
     module EncryptionUtils
 
       protected

data/lib/aws/s3/errors.rb

@@ -30,7 +30,7 @@ module AWS
     # service are instances of either {ClientError} or {ServerError}.
     module Errors
 
-      # @private
+      # @api private
       GRAMMAR = Core::XML::Grammar.customize
 
       extend Core::LazyErrorClasses

data/lib/aws/s3/multipart_upload.rb

@@ -23,7 +23,7 @@ module AWS
 
       include Core::Model
 
-      # @private
+      # @api private
       def initialize(object, id, options = {})
         @id = id
         @object = object
@@ -271,18 +271,18 @@ module AWS
         UploadedPartCollection.new(self)
       end
 
-      # @private
+      # @api private
       def completed_parts
         @completed_parts.values.
           sort { |a, b| a[:part_number] <=> b[:part_number] }
       end
 
-      # @private
+      # @api private
       def inspect
         "<#{self.class}:#{object.bucket.name}/#{object.key}:#{id}>"
       end
 
-      # @private
+      # @api private
       private
       def get_complete_opts(part_numbers = nil)
         parts_resp = client.list_parts(base_opts)
@@ -300,7 +300,7 @@ module AWS
         complete_opts
       end
 
-      # @private
+      # @api private
       private
       def base_opts
         opts = {