Class: OCI::Ons::Models::SubscriptionSummary
- Inherits:
-
Object
- Object
- OCI::Ons::Models::SubscriptionSummary
- Defined in:
- lib/oci/ons/models/subscription_summary.rb
Overview
The subscription’s configuration summary.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_PENDING = 'PENDING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#created_time ⇒ Integer
The time when this suscription was created.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
- #delivery_policy ⇒ OCI::Ons::Models::DeliveryPolicy
-
#endpoint ⇒ String
[Required] The endpoint of the subscription.
-
#etag ⇒ String
For optimistic concurrency control.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription.
-
#lifecycle_state ⇒ String
[Required] The lifecycle state of the subscription.
-
#protocol ⇒ String
[Required] The protocol used for the subscription.
-
#topic_id ⇒ String
[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated topic.
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 = {}) ⇒ SubscriptionSummary
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.
Constructor Details
#initialize(attributes = {}) ⇒ SubscriptionSummary
Initializes the object
123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 123 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.id = attributes[:'id'] if attributes[:'id'] 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.protocol = attributes[:'protocol'] if attributes[:'protocol'] self.endpoint = attributes[:'endpoint'] if attributes[:'endpoint'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self.created_time = attributes[:'createdTime'] if attributes[:'createdTime'] raise 'You cannot provide both :createdTime and :created_time' if attributes.key?(:'createdTime') && attributes.key?(:'created_time') self.created_time = attributes[:'created_time'] if attributes[:'created_time'] self.delivery_policy = attributes[:'deliveryPolicy'] if attributes[:'deliveryPolicy'] raise 'You cannot provide both :deliveryPolicy and :delivery_policy' if attributes.key?(:'deliveryPolicy') && attributes.key?(:'delivery_policy') self.delivery_policy = attributes[:'delivery_policy'] if attributes[:'delivery_policy'] self.etag = attributes[:'etag'] if attributes[:'etag'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] end |
Instance Attribute Details
#created_time ⇒ Integer
The time when this suscription was created.
47 48 49 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 47 def created_time @created_time end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
Example: ‘{"CostCenter": "42"}`
69 70 71 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 69 def @defined_tags end |
#delivery_policy ⇒ OCI::Ons::Models::DeliveryPolicy
50 51 52 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 50 def delivery_policy @delivery_policy end |
#endpoint ⇒ String
[Required] The endpoint of the subscription. Valid values depend on the protocol. For EMAIL, only an email address is valid. For HTTPS, only a PagerDuty URL is valid. A URL cannot exceed 512 characters. Avoid entering confidential information.
38 39 40 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 38 def endpoint @endpoint end |
#etag ⇒ String
For optimistic concurrency control. See ‘if-match`.
55 56 57 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 55 def etag @etag end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
Example: ‘"Finance"`
62 63 64 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 62 def @freeform_tags end |
#id ⇒ String
[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription.
21 22 23 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 21 def id @id end |
#lifecycle_state ⇒ String
[Required] The lifecycle state of the subscription. Default value for a newly created subscription: PENDING.
43 44 45 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 43 def lifecycle_state @lifecycle_state end |
#protocol ⇒ String
[Required] The protocol used for the subscription. Valid values: EMAIL, HTTPS.
31 32 33 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 31 def protocol @protocol end |
#topic_id ⇒ String
[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the associated topic.
26 27 28 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 26 def topic_id @topic_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 72 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'topic_id': :'topicId', 'protocol': :'protocol', 'endpoint': :'endpoint', 'lifecycle_state': :'lifecycleState', 'created_time': :'createdTime', 'delivery_policy': :'deliveryPolicy', 'etag': :'etag', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 90 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'topic_id': :'String', 'protocol': :'String', 'endpoint': :'String', 'lifecycle_state': :'String', 'created_time': :'Integer', 'delivery_policy': :'OCI::Ons::Models::DeliveryPolicy', 'etag': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 194 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && topic_id == other.topic_id && protocol == other.protocol && endpoint == other.endpoint && lifecycle_state == other.lifecycle_state && created_time == other.created_time && delivery_policy == other.delivery_policy && etag == other.etag && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 233 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
213 214 215 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 213 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
222 223 224 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 222 def hash [id, topic_id, protocol, endpoint, lifecycle_state, created_time, delivery_policy, etag, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
266 267 268 269 270 271 272 273 274 275 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 266 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
260 261 262 |
# File 'lib/oci/ons/models/subscription_summary.rb', line 260 def to_s to_hash.to_s end |