Class: OCI::Oda::Models::CreateApplicationChannelResult
- Inherits:
-
CreateChannelResult
- Object
- CreateChannelResult
- OCI::Oda::Models::CreateApplicationChannelResult
- Defined in:
- lib/oci/oda/models/create_application_channel_result.rb
Overview
The configuration for an Application channel.
Constant Summary
Constants inherited from CreateChannelResult
OCI::Oda::Models::CreateChannelResult::CATEGORY_ENUM, OCI::Oda::Models::CreateChannelResult::LIFECYCLE_STATE_ENUM, OCI::Oda::Models::CreateChannelResult::TYPE_ENUM
Instance Attribute Summary collapse
-
#is_authenticated_user_id ⇒ BOOLEAN
[Required] True if the user id in the AIC message should be treated as an authenticated user id.
-
#outbound_url ⇒ String
The URL to send response and error messages to.
-
#secret_key ⇒ String
[Required] The secret key used to verify the authenticity of received messages.
-
#webhook_url ⇒ String
[Required] The URL to use to send messages to this channel.
Attributes inherited from CreateChannelResult
#category, #defined_tags, #description, #freeform_tags, #id, #lifecycle_state, #name, #session_expiry_duration_in_milliseconds, #time_created, #time_updated, #type
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateApplicationChannelResult
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Methods inherited from CreateChannelResult
Constructor Details
#initialize(attributes = {}) ⇒ CreateApplicationChannelResult
Initializes the object
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 126 127 128 129 130 131 |
# File 'lib/oci/oda/models/create_application_channel_result.rb', line 98 def initialize(attributes = {}) return unless attributes.is_a?(Hash) attributes['type'] = 'APPLICATION' super(attributes) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.secret_key = attributes[:'secretKey'] if attributes[:'secretKey'] raise 'You cannot provide both :secretKey and :secret_key' if attributes.key?(:'secretKey') && attributes.key?(:'secret_key') self.secret_key = attributes[:'secret_key'] if attributes[:'secret_key'] self.outbound_url = attributes[:'outboundUrl'] if attributes[:'outboundUrl'] raise 'You cannot provide both :outboundUrl and :outbound_url' if attributes.key?(:'outboundUrl') && attributes.key?(:'outbound_url') self.outbound_url = attributes[:'outbound_url'] if attributes[:'outbound_url'] self.is_authenticated_user_id = attributes[:'isAuthenticatedUserId'] unless attributes[:'isAuthenticatedUserId'].nil? raise 'You cannot provide both :isAuthenticatedUserId and :is_authenticated_user_id' if attributes.key?(:'isAuthenticatedUserId') && attributes.key?(:'is_authenticated_user_id') self.is_authenticated_user_id = attributes[:'is_authenticated_user_id'] unless attributes[:'is_authenticated_user_id'].nil? self.webhook_url = attributes[:'webhookUrl'] if attributes[:'webhookUrl'] raise 'You cannot provide both :webhookUrl and :webhook_url' if attributes.key?(:'webhookUrl') && attributes.key?(:'webhook_url') self.webhook_url = attributes[:'webhook_url'] if attributes[:'webhook_url'] end |
Instance Attribute Details
#is_authenticated_user_id ⇒ BOOLEAN
[Required] True if the user id in the AIC message should be treated as an authenticated user id.
24 25 26 |
# File 'lib/oci/oda/models/create_application_channel_result.rb', line 24 def is_authenticated_user_id @is_authenticated_user_id end |
#outbound_url ⇒ String
The URL to send response and error messages to.
20 21 22 |
# File 'lib/oci/oda/models/create_application_channel_result.rb', line 20 def outbound_url @outbound_url end |
#secret_key ⇒ String
[Required] The secret key used to verify the authenticity of received messages. This is only returned this once. If it is lost the keys will need to be rotated to generate a new key.
16 17 18 |
# File 'lib/oci/oda/models/create_application_channel_result.rb', line 16 def secret_key @secret_key end |
#webhook_url ⇒ String
[Required] The URL to use to send messages to this channel. This will be generally be used to configure a webhook in a 3rd party messaging system to send messages to this channel.
30 31 32 |
# File 'lib/oci/oda/models/create_application_channel_result.rb', line 30 def webhook_url @webhook_url end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
# File 'lib/oci/oda/models/create_application_channel_result.rb', line 33 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'name': :'name', 'description': :'description', 'category': :'category', 'type': :'type', 'session_expiry_duration_in_milliseconds': :'sessionExpiryDurationInMilliseconds', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated', 'time_updated': :'timeUpdated', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'secret_key': :'secretKey', 'outbound_url': :'outboundUrl', 'is_authenticated_user_id': :'isAuthenticatedUserId', 'webhook_url': :'webhookUrl' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/oci/oda/models/create_application_channel_result.rb', line 56 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'name': :'String', 'description': :'String', 'category': :'String', 'type': :'String', 'session_expiry_duration_in_milliseconds': :'Integer', 'lifecycle_state': :'String', 'time_created': :'DateTime', 'time_updated': :'DateTime', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'secret_key': :'String', 'outbound_url': :'String', 'is_authenticated_user_id': :'BOOLEAN', 'webhook_url': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/oci/oda/models/create_application_channel_result.rb', line 140 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && name == other.name && description == other.description && category == other.category && type == other.type && session_expiry_duration_in_milliseconds == other.session_expiry_duration_in_milliseconds && lifecycle_state == other.lifecycle_state && time_created == other.time_created && time_updated == other.time_updated && == other. && == other. && secret_key == other.secret_key && outbound_url == other.outbound_url && is_authenticated_user_id == other.is_authenticated_user_id && webhook_url == other.webhook_url end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/oci/oda/models/create_application_channel_result.rb', line 184 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
164 165 166 |
# File 'lib/oci/oda/models/create_application_channel_result.rb', line 164 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
173 174 175 |
# File 'lib/oci/oda/models/create_application_channel_result.rb', line 173 def hash [id, name, description, category, type, session_expiry_duration_in_milliseconds, lifecycle_state, time_created, time_updated, , , secret_key, outbound_url, is_authenticated_user_id, webhook_url].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
217 218 219 220 221 222 223 224 225 226 |
# File 'lib/oci/oda/models/create_application_channel_result.rb', line 217 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
211 212 213 |
# File 'lib/oci/oda/models/create_application_channel_result.rb', line 211 def to_s to_hash.to_s end |