File: has_delivery_policy.rb

package info (click to toggle)
ruby-aws-sdk 1.66.0-1
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 6,808 kB
  • ctags: 4,854
  • sloc: ruby: 28,354; makefile: 7
file content (68 lines) | stat: -rw-r--r-- 2,029 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
# 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 SNS

    # A module shared between {Topic} and {Subscription}.  Provides methods
    # for getting and setting the delivery policy and for getting the
    # effective delivery policy.
    module HasDeliveryPolicy

      # @return [nil,Hash] Returns the delivery policy.
      def delivery_policy
        parse_delivery_policy(delivery_policy_json)
      end

      # @return [Hash] Returns the effective delivery policy.
      def effective_delivery_policy
        parse_delivery_policy(effective_delivery_policy_json)
      end

      # @param [nil,Hash,String<JSON>] policy A delivery policy.  You can
      #   pass a JSON string, A policy hash or nil.
      def delivery_policy= policy

        policy_json = case policy
        when nil then ''
        when String then policy
        else policy.to_json
        end

        update_delivery_policy(policy_json)

      end

      # @return [nil,String] Returns the delivery policy JSON string.
      def delivery_policy_json
        raise NotImplementedError
      end

      # @return [String] Returns the effective delivery policy JSON string.
      def effective_delivery_policy_json
        raise NotImplementedError
      end

      protected
      def parse_delivery_policy policy_json
        policy_json.nil? ? nil : JSON.parse(policy_json)
      end

      protected
      def update_delivery_policy policy_json
        raise NotImplementedError
      end

    end
  end
end