Class: OCI::Ons::Models::ConfirmationResult

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ons/models/confirmation_result.rb

Overview

The confirmation details for the specified subscription. For information about confirming subscriptions, see To confirm a subscription.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConfirmationResult

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :topic_name (String) —

    The value to assign to the #topic_name property

  • :topic_id (String) —

    The value to assign to the #topic_id property

  • :endpoint (String) —

    The value to assign to the #endpoint property

  • :unsubscribe_url (String) —

    The value to assign to the #unsubscribe_url property

  • :message (String) —

    The value to assign to the #message property

  • :subscription_id (String) —

    The value to assign to the #subscription_id property

[View source]

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
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 82

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.topic_name = attributes[:'topicName'] if attributes[:'topicName']

  raise 'You cannot provide both :topicName and :topic_name' if attributes.key?(:'topicName') && attributes.key?(:'topic_name')

  self.topic_name = attributes[:'topic_name'] if attributes[:'topic_name']

  self.topic_id = attributes[:'topicId'] if attributes[:'topicId']

  raise 'You cannot provide both :topicId and :topic_id' if attributes.key?(:'topicId') && attributes.key?(:'topic_id')

  self.topic_id = attributes[:'topic_id'] if attributes[:'topic_id']

  self.endpoint = attributes[:'endpoint'] if attributes[:'endpoint']

  self.unsubscribe_url = attributes[:'unsubscribeUrl'] if attributes[:'unsubscribeUrl']

  raise 'You cannot provide both :unsubscribeUrl and :unsubscribe_url' if attributes.key?(:'unsubscribeUrl') && attributes.key?(:'unsubscribe_url')

  self.unsubscribe_url = attributes[:'unsubscribe_url'] if attributes[:'unsubscribe_url']

  self.message = attributes[:'message'] if attributes[:'message']

  self.subscription_id = attributes[:'subscriptionId'] if attributes[:'subscriptionId']

  raise 'You cannot provide both :subscriptionId and :subscription_id' if attributes.key?(:'subscriptionId') && attributes.key?(:'subscription_id')

  self.subscription_id = attributes[:'subscription_id'] if attributes[:'subscription_id']
end

Instance Attribute Details

#endpoint ⇒ String

[Required] A locator that corresponds to the subscription protocol. For example, an email address for a subscription that uses the EMAIL protocol, or a URL for a subscription that uses an HTTP-based protocol.

Returns:

  • (String) 

28
29
30
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 28

def endpoint
  @endpoint
end

#message ⇒ String

[Required] A human-readable string indicating the status of the subscription confirmation.

Returns:

  • (String) 

36
37
38
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 36

def message
  @message
end

#subscription_id ⇒ String

[Required] The OCID of the subscription specified in the request.

Returns:

  • (String) 

40
41
42
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 40

def subscription_id
  @subscription_id
end

#topic_id ⇒ String

[Required] The OCID of the topic associated with the specified subscription.

Returns:

  • (String) 

22
23
24
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 22

def topic_id
  @topic_id
end

#topic_name ⇒ String

[Required] The name of the subscribed topic.

Returns:

  • (String) 

17
18
19
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 17

def topic_name
  @topic_name
end

#unsubscribe_url ⇒ String

[Required] The URL for unsubscribing from the topic.

Returns:

  • (String) 

32
33
34
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 32

def unsubscribe_url
  @unsubscribe_url
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.

[View source]

43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 43

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'topic_name': :'topicName',
    'topic_id': :'topicId',
    'endpoint': :'endpoint',
    'unsubscribe_url': :'unsubscribeUrl',
    'message': :'message',
    'subscription_id': :'subscriptionId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 57

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'topic_name': :'String',
    'topic_id': :'String',
    'endpoint': :'String',
    'unsubscribe_url': :'String',
    'message': :'String',
    'subscription_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared

[View source]

124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 124

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    topic_name == other.topic_name &&
    topic_id == other.topic_id &&
    endpoint == other.endpoint &&
    unsubscribe_url == other.unsubscribe_url &&
    message == other.message &&
    subscription_id == other.subscription_id
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself

[View source]

159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 159

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method
[View source]

139
140
141
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 139

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

148
149
150
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 148

def hash
  [topic_name, topic_id, endpoint, unsubscribe_url, message, subscription_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 192

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object

[View source]

186
187
188
 
# File 'lib/oci/ons/models/confirmation_result.rb', line 186

def to_s
  to_hash.to_s
end