Class: OCI::Ons::Models::CreateSubscriptionDetails

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

Overview

The configuration details for creating the subscription.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSubscriptionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :topic_id (String) —

    The value to assign to the #topic_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :protocol (String) —

    The value to assign to the #protocol property

  • :endpoint (String) —

    The value to assign to the #endpoint property

  • :metadata (String) —

    The value to assign to the #metadata property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



112
113
114
115
116
117
118
119
120
121
122
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
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 112

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_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.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment for the subscription.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 20

def compartment_id
  @compartment_id
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.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


67
68
69
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 67

def defined_tags
  @defined_tags
end

#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. HTTP-based protocols use URL endpoints that begin with "http:" or "https:". A URL cannot exceed 512 characters. Avoid entering confidential information.

For protocol-specific endpoint formats and steps to get or create endpoints, see To create a subscription.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 49

def endpoint
  @endpoint
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.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


60
61
62
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 60

def freeform_tags
  @freeform_tags
end

#metadata ⇒ String

Metadata for the subscription.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 53

def metadata
  @metadata
end

#protocol ⇒ String

[Required] The protocol used for the subscription.

Allowed values: * CUSTOM_HTTPS * EMAIL * HTTPS (deprecated; for PagerDuty endpoints, use PAGERDUTY) * ORACLE_FUNCTIONS * PAGERDUTY * SLACK * SMS

For information about subscription protocols, see To create a subscription.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 37

def protocol
  @protocol
end

#topic_id ⇒ String

[Required] The OCID of the topic for the subscription.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 15

def topic_id
  @topic_id
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 70

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'topic_id': :'topicId',
    'compartment_id': :'compartmentId',
    'protocol': :'protocol',
    'endpoint': :'endpoint',
    'metadata': :'metadata',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 85

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'topic_id': :'String',
    'compartment_id': :'String',
    'protocol': :'String',
    'endpoint': :'String',
    'metadata': :'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.

Parameters:

  • other (Object) —

    the other object to be compared



156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 156

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

  self.class == other.class &&
    topic_id == other.topic_id &&
    compartment_id == other.compartment_id &&
    protocol == other.protocol &&
    endpoint == other.endpoint &&
    metadata == other.metadata &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 192

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


172
173
174
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 172

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



181
182
183
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 181

def hash
  [topic_id, compartment_id, protocol, endpoint, metadata, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



225
226
227
228
229
230
231
232
233
234
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 225

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



219
220
221
 
# File 'lib/oci/ons/models/create_subscription_details.rb', line 219

def to_s
  to_hash.to_s
end