File: errors.rb

package info (click to toggle)
ruby-aws-sdk 1.67.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,840 kB
  • sloc: ruby: 28,436; makefile: 7
file content (125 lines) | stat: -rw-r--r-- 3,807 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# Copyright 2011-2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License"). You
# may not use this file except in compliance with the License. A copy of
# the License is located at
#
#     http://aws.amazon.com/apache2.0/
#
# or in the "license" file accompanying this file. This file is
# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
# ANY KIND, either express or implied. See the License for the specific
# language governing permissions and limitations under the License.

module AWS
  class SQS
    module Errors

      extend Core::LazyErrorClasses

      # @api private
      def self.error_class(code)
        super(code.sub(/^AWS\.SimpleQueueService\./, ''))
      end

      # Raised when one or more messages fail to delete during a
      # batch delete operation.
      #
      # See {#failures} for a complete list of failures.
      #
      class BatchDeleteError < StandardError

        def initialize failures
          @failures = failures
          super("Failed to delete #{failures.size} messages")
        end

        # @return [Array<Hash>] Returns a list of hashes.  Each hash
        #   contains information about one message that failed to delete.
        #   Hash keys include:
        #
        #   * `:error_code`
        #   * `:error_message`
        #   * `:sender_fault`
        #   * `:receipt_handle`
        #
        attr_reader :failures

      end

      # Raised from a batch change message visibility call when one or more
      # of the updates fail.
      #
      # See {#failures} for a complete list of failures.
      #
      class BatchChangeVisibilityError < StandardError

        def initialize failures
          @failures = failures
          super("Failed to change visibility for #{failures.size} messages")
        end

        # @return [Array<Hash>] Returns a list of hashes.  Each hash
        #   contains information about one message that failed to change
        #   visibility. Hash keys include:
        #
        #   * `:error_code`
        #   * `:error_message`
        #   * `:sender_fault`
        #   * `:receipt_handle`
        #
        attr_reader :failures

      end

      class BatchSendError < StandardError

        def initialize sent, failures
          @sent = sent
          @failures = failures
          super("Failed to send #{failures.size} messages")
        end

        # @return [Array<Queue::SentMessage>] Returns a list of
        #   {Queue::SentMessage} objects.
        attr_reader :sent

        # @return [Array<Hash>] Returns a list of hashes.  Each hash
        #   contains information about one message that was not sent.   
        #
        #   * `:error_code` - identifies the type of failure
        #   * `:error_message` - human readable description of the failure
        #   * `:sender_fault` - whether the failure was caused by a server fault
        #   * `:message_body` - the message body as passed to `:batch_send`
        #   * `:batch_index` - the index in the list of messages passed 
        #      to `batch_send` of the failed message.
        #
        attr_reader :failures

      end

      class ChecksumError < StandardError

        def initialize failures
          # failures can also be a single failure, always generate an array
          @failures = failures.is_a?(Array) ? failures : [failures]
          super("#{@failures.size} messages failed checksum verification")
        end

        attr_reader :failures
      end

      class BatchSendMultiError < StandardError
        def initialize *error_set
          @errors = []
          error_set.each do |error|
            @errors << error
          end
        end

        attr_reader :errors
      end

    end
  end
end