Class: OCI::Apigateway::Models::CreateSubscriberDetails
- Inherits:
-
Object
- Object
- OCI::Apigateway::Models::CreateSubscriberDetails
- Defined in:
- lib/oci/apigateway/models/create_subscriber_details.rb
Overview
Information about a new subscriber.
Instance Attribute Summary collapse
-
#clients ⇒ Array<OCI::Apigateway::Models::Client>
[Required] The clients belonging to this subscriber.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment in which the resource is created.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#display_name ⇒ String
A user-friendly name.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#usage_plans ⇒ Array<String>
[Required] An array of OCID[https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm]s of usage plan resources.
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 = {}) ⇒ CreateSubscriberDetails
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 = {}) ⇒ CreateSubscriberDetails
Initializes the object
93 94 95 96 97 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 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 93 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.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] 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.clients = attributes[:'clients'] if attributes[:'clients'] self.usage_plans = attributes[:'usagePlans'] if attributes[:'usagePlans'] raise 'You cannot provide both :usagePlans and :usage_plans' if attributes.key?(:'usagePlans') && attributes.key?(:'usage_plans') self.usage_plans = attributes[:'usage_plans'] if attributes[:'usage_plans'] 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
#clients ⇒ Array<OCI::Apigateway::Models::Client>
[Required] The clients belonging to this subscriber.
27 28 29 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 27 def clients @clients end |
#compartment_id ⇒ String
[Required] The OCID of the compartment in which the resource is created.
23 24 25 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 23 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\"}}
51 52 53 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 51 def @defined_tags end |
#display_name ⇒ String
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Example: My new resource
17 18 19 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 17 def display_name @display_name 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\"}
42 43 44 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 42 def @freeform_tags end |
#usage_plans ⇒ Array<String>
[Required] An array of OCID[https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm]s of usage plan resources.
33 34 35 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 33 def usage_plans @usage_plans end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
54 55 56 57 58 59 60 61 62 63 64 65 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 54 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'display_name': :'displayName', 'compartment_id': :'compartmentId', 'clients': :'clients', 'usage_plans': :'usagePlans', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 68 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'display_name': :'String', 'compartment_id': :'String', 'clients': :'Array<OCI::Apigateway::Models::Client>', 'usage_plans': :'Array<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.
139 140 141 142 143 144 145 146 147 148 149 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 139 def ==(other) return true if equal?(other) self.class == other.class && display_name == other.display_name && compartment_id == other.compartment_id && clients == other.clients && usage_plans == other.usage_plans && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 174 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
154 155 156 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 154 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
163 164 165 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 163 def hash [display_name, compartment_id, clients, usage_plans, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
207 208 209 210 211 212 213 214 215 216 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 207 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
201 202 203 |
# File 'lib/oci/apigateway/models/create_subscriber_details.rb', line 201 def to_s to_hash.to_s end |