aws-sdk-glacier 1.0.0.rc1 → 1.0.0.rc2

data/lib/aws-sdk-glacier/multipart_upload.rb

@@ -1,269 +1,267 @@
 # WARNING ABOUT GENERATED CODE
 #
-# This file is generated. See the contributing for info on making contributions:
+# This file is generated. See the contributing guide for more information:
 # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
-module Aws
-  module Glacier
-    class MultipartUpload
+module Aws::Glacier
+  class MultipartUpload
 
-      extend Aws::Deprecations
+    extend Aws::Deprecations
 
-      # @overload def initialize(account_id, vault_name, id, options = {})
-      #   @param [String] account_id
-      #   @param [String] vault_name
-      #   @param [String] id
-      #   @option options [Client] :client
-      # @overload def initialize(options = {})
-      #   @option options [required, String] :account_id
-      #   @option options [required, String] :vault_name
-      #   @option options [required, String] :id
-      #   @option options [Client] :client
-      def initialize(*args)
-        options = Hash === args.last ? args.pop.dup : {}
-        @account_id = extract_account_id(args, options)
-        @vault_name = extract_vault_name(args, options)
-        @id = extract_id(args, options)
-        @data = options.delete(:data)
-        @client = options.delete(:client) || Client.new(options)
-      end
+    # @overload def initialize(account_id, vault_name, id, options = {})
+    #   @param [String] account_id
+    #   @param [String] vault_name
+    #   @param [String] id
+    #   @option options [Client] :client
+    # @overload def initialize(options = {})
+    #   @option options [required, String] :account_id
+    #   @option options [required, String] :vault_name
+    #   @option options [required, String] :id
+    #   @option options [Client] :client
+    def initialize(*args)
+      options = Hash === args.last ? args.pop.dup : {}
+      @account_id = extract_account_id(args, options)
+      @vault_name = extract_vault_name(args, options)
+      @id = extract_id(args, options)
+      @data = options.delete(:data)
+      @client = options.delete(:client) || Client.new(options)
+    end
 
-      # @!group Read-Only Attributes
+    # @!group Read-Only Attributes
 
-      # @return [String]
-      def account_id
-        @account_id
-      end
+    # @return [String]
+    def account_id
+      @account_id
+    end
 
-      # @return [String]
-      def vault_name
-        @vault_name
-      end
+    # @return [String]
+    def vault_name
+      @vault_name
+    end
 
-      # @return [String]
-      def id
-        @id
-      end
-      alias :multipart_upload_id :id
+    # @return [String]
+    def id
+      @id
+    end
+    alias :multipart_upload_id :id
 
-      # The Amazon Resource Name (ARN) of the vault that contains the archive.
-      # @return [String]
-      def vault_arn
-        data.vault_arn
-      end
+    # The Amazon Resource Name (ARN) of the vault that contains the archive.
+    # @return [String]
+    def vault_arn
+      data.vault_arn
+    end
 
-      # The description of the archive that was specified in the Initiate
-      # Multipart Upload request.
-      # @return [String]
-      def archive_description
-        data.archive_description
-      end
+    # The description of the archive that was specified in the Initiate
+    # Multipart Upload request.
+    # @return [String]
+    def archive_description
+      data.archive_description
+    end
 
-      # The part size, in bytes, specified in the Initiate Multipart Upload
-      # request. This is the size of all the parts in the upload except the
-      # last part, which may be smaller than this size.
-      # @return [Integer]
-      def part_size_in_bytes
-        data.part_size_in_bytes
-      end
+    # The part size, in bytes, specified in the Initiate Multipart Upload
+    # request. This is the size of all the parts in the upload except the
+    # last part, which may be smaller than this size.
+    # @return [Integer]
+    def part_size_in_bytes
+      data.part_size_in_bytes
+    end
 
-      # The UTC time at which the multipart upload was initiated.
-      # @return [Time]
-      def creation_date
-        data.creation_date
-      end
+    # The UTC time at which the multipart upload was initiated.
+    # @return [Time]
+    def creation_date
+      data.creation_date
+    end
 
-      # @!endgroup
+    # @!endgroup
 
-      # @return [Client]
-      def client
-        @client
-      end
+    # @return [Client]
+    def client
+      @client
+    end
 
-      # @raise [Errors::ResourceNotLoadable]
-      # @api private
-      def load
-        msg = "#load is not implemented, data only available via enumeration"
-        raise Errors::ResourceNotLoadable, msg
-      end
-      alias :reload :load
+    # @raise [NotImplementedError]
+    # @api private
+    def load
+      msg = "#load is not implemented, data only available via enumeration"
+      raise NotImplementedError, msg
+    end
+    alias :reload :load
 
-      # @raise [Errors::ResourceNotLoadableError] Raises when {#data_loaded?} is `false`.
-      # @return [Types::UploadListElement]
-      #   Returns the data for this {MultipartUpload}.
-      def data
-        load unless @data
-        @data
-      end
+    # @raise [NotImplementedError] Raises when {#data_loaded?} is `false`.
+    # @return [Types::UploadListElement]
+    #   Returns the data for this {MultipartUpload}.
+    def data
+      load unless @data
+      @data
+    end
 
-      # @return [Boolean]
-      #   Returns `true` if this resource is loaded.  Accessing attributes or
-      #   {#data} on an unloaded resource will trigger a call to {#load}.
-      def data_loaded?
-        !!@data
-      end
+    # @return [Boolean]
+    #   Returns `true` if this resource is loaded.  Accessing attributes or
+    #   {#data} on an unloaded resource will trigger a call to {#load}.
+    def data_loaded?
+      !!@data
+    end
 
-      # @!group Actions
+    # @!group Actions
 
-      # @example Request syntax with placeholder values
-      #
-      #   multipart_upload.abort()
-      # @param [Hash] options ({})
-      # @return [EmptyStructure]
-      def abort(options = {})
-        options = options.merge(
-          account_id: @account_id,
-          vault_name: @vault_name,
-          upload_id: @id
-        )
-        resp = @client.abort_multipart_upload(options)
-        resp.data
-      end
+    # @example Request syntax with placeholder values
+    #
+    #   multipart_upload.abort()
+    # @param [Hash] options ({})
+    # @return [EmptyStructure]
+    def abort(options = {})
+      options = options.merge(
+        account_id: @account_id,
+        vault_name: @vault_name,
+        upload_id: @id
+      )
+      resp = @client.abort_multipart_upload(options)
+      resp.data
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   multipart_upload.complete({
-      #     archive_size: 1,
-      #     checksum: "string",
-      #   })
-      # @param [Hash] options ({})
-      # @option options [Integer] :archive_size
-      #   The total size, in bytes, of the entire archive. This value should be
-      #   the sum of all the sizes of the individual parts that you uploaded.
-      # @option options [String] :checksum
-      #   The SHA256 tree hash of the entire archive. It is the tree hash of
-      #   SHA256 tree hash of the individual parts. If the value you specify in
-      #   the request does not match the SHA256 tree hash of the final assembled
-      #   archive as computed by Amazon Glacier, Amazon Glacier returns an error
-      #   and the request fails.
-      # @return [Types::ArchiveCreationOutput]
-      def complete(options = {})
-        options = options.merge(
-          account_id: @account_id,
-          vault_name: @vault_name,
-          upload_id: @id
-        )
-        resp = @client.complete_multipart_upload(options)
-        resp.data
-      end
+    # @example Request syntax with placeholder values
+    #
+    #   multipart_upload.complete({
+    #     archive_size: 1,
+    #     checksum: "string",
+    #   })
+    # @param [Hash] options ({})
+    # @option options [Integer] :archive_size
+    #   The total size, in bytes, of the entire archive. This value should be
+    #   the sum of all the sizes of the individual parts that you uploaded.
+    # @option options [String] :checksum
+    #   The SHA256 tree hash of the entire archive. It is the tree hash of
+    #   SHA256 tree hash of the individual parts. If the value you specify in
+    #   the request does not match the SHA256 tree hash of the final assembled
+    #   archive as computed by Amazon Glacier, Amazon Glacier returns an error
+    #   and the request fails.
+    # @return [Types::ArchiveCreationOutput]
+    def complete(options = {})
+      options = options.merge(
+        account_id: @account_id,
+        vault_name: @vault_name,
+        upload_id: @id
+      )
+      resp = @client.complete_multipart_upload(options)
+      resp.data
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   multipart_upload.parts({
-      #     marker: "string",
-      #     limit: 1,
-      #   })
-      # @param [Hash] options ({})
-      # @option options [String] :marker
-      #   An opaque string used for pagination. This value specifies the part at
-      #   which the listing of parts should begin. Get the marker value from the
-      #   response of a previous List Parts response. You need only include the
-      #   marker if you are continuing the pagination of results started in a
-      #   previous List Parts request.
-      # @option options [Integer] :limit
-      #   The maximum number of parts to be returned. The default limit is 1000.
-      #   The number of parts returned might be fewer than the specified limit,
-      #   but the number of returned parts never exceeds the limit.
-      # @return [Types::ListPartsOutput]
-      def parts(options = {})
-        options = options.merge(
-          account_id: @account_id,
-          vault_name: @vault_name,
-          upload_id: @id
-        )
-        resp = @client.list_parts(options)
-        resp.data
-      end
+    # @example Request syntax with placeholder values
+    #
+    #   multipart_upload.parts({
+    #     marker: "string",
+    #     limit: 1,
+    #   })
+    # @param [Hash] options ({})
+    # @option options [String] :marker
+    #   An opaque string used for pagination. This value specifies the part at
+    #   which the listing of parts should begin. Get the marker value from the
+    #   response of a previous List Parts response. You need only include the
+    #   marker if you are continuing the pagination of results started in a
+    #   previous List Parts request.
+    # @option options [Integer] :limit
+    #   The maximum number of parts to be returned. The default limit is 1000.
+    #   The number of parts returned might be fewer than the specified limit,
+    #   but the number of returned parts never exceeds the limit.
+    # @return [Types::ListPartsOutput]
+    def parts(options = {})
+      options = options.merge(
+        account_id: @account_id,
+        vault_name: @vault_name,
+        upload_id: @id
+      )
+      resp = @client.list_parts(options)
+      resp.data
+    end
 
-      # @example Request syntax with placeholder values
-      #
-      #   multipart_upload.upload_part({
-      #     checksum: "string",
-      #     range: "string",
-      #     body: "data",
-      #   })
-      # @param [Hash] options ({})
-      # @option options [String] :checksum
-      #   The SHA256 tree hash of the data being uploaded.
-      # @option options [String] :range
-      #   Identifies the range of bytes in the assembled archive that will be
-      #   uploaded in this part. Amazon Glacier uses this information to
-      #   assemble the archive in the proper sequence. The format of this header
-      #   follows RFC 2616. An example header is Content-Range:bytes
-      #   0-4194303/*.
-      # @option options [String, IO] :body
-      #   The data to upload.
-      # @return [Types::UploadMultipartPartOutput]
-      def upload_part(options = {})
-        options = options.merge(
-          account_id: @account_id,
-          vault_name: @vault_name,
-          upload_id: @id
-        )
-        resp = @client.upload_multipart_part(options)
-        resp.data
-      end
+    # @example Request syntax with placeholder values
+    #
+    #   multipart_upload.upload_part({
+    #     checksum: "string",
+    #     range: "string",
+    #     body: "data",
+    #   })
+    # @param [Hash] options ({})
+    # @option options [String] :checksum
+    #   The SHA256 tree hash of the data being uploaded.
+    # @option options [String] :range
+    #   Identifies the range of bytes in the assembled archive that will be
+    #   uploaded in this part. Amazon Glacier uses this information to
+    #   assemble the archive in the proper sequence. The format of this header
+    #   follows RFC 2616. An example header is Content-Range:bytes
+    #   0-4194303/*.
+    # @option options [String, IO] :body
+    #   The data to upload.
+    # @return [Types::UploadMultipartPartOutput]
+    def upload_part(options = {})
+      options = options.merge(
+        account_id: @account_id,
+        vault_name: @vault_name,
+        upload_id: @id
+      )
+      resp = @client.upload_multipart_part(options)
+      resp.data
+    end
 
-      # @!group Associations
+    # @!group Associations
 
-      # @return [Vault]
-      def vault
-        Vault.new(
-          account_id: @account_id,
-          name: @vault_name,
-          client: @client
-        )
-      end
+    # @return [Vault]
+    def vault
+      Vault.new(
+        account_id: @account_id,
+        name: @vault_name,
+        client: @client
+      )
+    end
 
-      # @deprecated
-      # @api private
-      def identifiers
-        {
-          account_id: @account_id,
-          vault_name: @vault_name,
-          id: @id
-        }
-      end
-      deprecated(:identifiers)
+    # @deprecated
+    # @api private
+    def identifiers
+      {
+        account_id: @account_id,
+        vault_name: @vault_name,
+        id: @id
+      }
+    end
+    deprecated(:identifiers)
 
-      private
+    private
 
-      def extract_account_id(args, options)
-        value = args[0] || options.delete(:account_id)
-        case value
-        when String then value
-        when nil then raise ArgumentError, "missing required option :account_id"
-        else
-          msg = "expected :account_id to be a String, got #{value.class}"
-          raise ArgumentError, msg
-        end
+    def extract_account_id(args, options)
+      value = args[0] || options.delete(:account_id)
+      case value
+      when String then value
+      when nil then raise ArgumentError, "missing required option :account_id"
+      else
+        msg = "expected :account_id to be a String, got #{value.class}"
+        raise ArgumentError, msg
       end
+    end
 
-      def extract_vault_name(args, options)
-        value = args[1] || options.delete(:vault_name)
-        case value
-        when String then value
-        when nil then raise ArgumentError, "missing required option :vault_name"
-        else
-          msg = "expected :vault_name to be a String, got #{value.class}"
-          raise ArgumentError, msg
-        end
+    def extract_vault_name(args, options)
+      value = args[1] || options.delete(:vault_name)
+      case value
+      when String then value
+      when nil then raise ArgumentError, "missing required option :vault_name"
+      else
+        msg = "expected :vault_name to be a String, got #{value.class}"
+        raise ArgumentError, msg
       end
+    end
 
-      def extract_id(args, options)
-        value = args[2] || options.delete(:id)
-        case value
-        when String then value
-        when nil then raise ArgumentError, "missing required option :id"
-        else
-          msg = "expected :id to be a String, got #{value.class}"
-          raise ArgumentError, msg
-        end
+    def extract_id(args, options)
+      value = args[2] || options.delete(:id)
+      case value
+      when String then value
+      when nil then raise ArgumentError, "missing required option :id"
+      else
+        msg = "expected :id to be a String, got #{value.class}"
+        raise ArgumentError, msg
       end
-
-      class Collection < Aws::Resources::Collection; end
     end
+
+    class Collection < Aws::Resources::Collection; end
   end
 end