Class: OCI::Streaming::Models::StreamSummary
- Inherits:
-
Object
- Object
- OCI::Streaming::Models::StreamSummary
- Defined in:
- lib/oci/streaming/models/stream_summary.rb
Overview
Summary representation of a stream.
Constant Summary collapse
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_FAILED = 'FAILED'.freeze, LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the stream.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource.
-
#id ⇒ String
[Required] The OCID of the stream.
-
#lifecycle_state ⇒ String
[Required] The current state of the stream.
-
#messages_endpoint ⇒ String
[Required] The endpoint to use when creating the StreamClient to consume or publish messages in the stream.
-
#name ⇒ String
[Required] The name of the stream.
-
#partitions ⇒ Integer
[Required] The number of partitions in the stream.
-
#stream_pool_id ⇒ String
[Required] The OCID of the stream pool that contains the stream.
-
#time_created ⇒ DateTime
[Required] The date and time the stream was created, expressed in RFC 3339 timestamp format.
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 = {}) ⇒ StreamSummary
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 = {}) ⇒ StreamSummary
Initializes the object
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 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 129 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.name = attributes[:'name'] if attributes[:'name'] self.id = attributes[:'id'] if attributes[:'id'] self.partitions = attributes[:'partitions'] if attributes[:'partitions'] 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.stream_pool_id = attributes[:'streamPoolId'] if attributes[:'streamPoolId'] raise 'You cannot provide both :streamPoolId and :stream_pool_id' if attributes.key?(:'streamPoolId') && attributes.key?(:'stream_pool_id') self.stream_pool_id = attributes[:'stream_pool_id'] if attributes[:'stream_pool_id'] 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.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self. = attributes[:'messagesEndpoint'] if attributes[:'messagesEndpoint'] raise 'You cannot provide both :messagesEndpoint and :messages_endpoint' if attributes.key?(:'messagesEndpoint') && attributes.key?(:'messages_endpoint') self. = attributes[:'messages_endpoint'] if attributes[:'messages_endpoint'] 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
#compartment_id ⇒ String
[Required] The OCID of the compartment that contains the stream.
39 40 41 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 39 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\"}}
75 76 77 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 75 def @defined_tags end |
#freeform_tags ⇒ Hash<String, String>
Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags.
Example: {\"Department\": \"Finance\"}
68 69 70 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 68 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the stream.
31 32 33 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 31 def id @id end |
#lifecycle_state ⇒ String
[Required] The current state of the stream.
47 48 49 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 47 def lifecycle_state @lifecycle_state end |
#messages_endpoint ⇒ String
[Required] The endpoint to use when creating the StreamClient to consume or publish messages in the stream. If the associated stream pool is private, the endpoint is also private and can only be accessed from inside the stream pool's associated subnet.
60 61 62 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 60 def @messages_endpoint end |
#name ⇒ String
[Required] The name of the stream.
Example: TelemetryEvents
27 28 29 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 27 def name @name end |
#partitions ⇒ Integer
[Required] The number of partitions in the stream.
35 36 37 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 35 def partitions @partitions end |
#stream_pool_id ⇒ String
[Required] The OCID of the stream pool that contains the stream.
43 44 45 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 43 def stream_pool_id @stream_pool_id end |
#time_created ⇒ DateTime
[Required] The date and time the stream was created, expressed in RFC 3339 timestamp format.
Example: 2018-04-20T00:00:07.405Z
54 55 56 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 54 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 78 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'name': :'name', 'id': :'id', 'partitions': :'partitions', 'compartment_id': :'compartmentId', 'stream_pool_id': :'streamPoolId', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated', 'messages_endpoint': :'messagesEndpoint', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 96 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'name': :'String', 'id': :'String', 'partitions': :'Integer', 'compartment_id': :'String', 'stream_pool_id': :'String', 'lifecycle_state': :'String', 'time_created': :'DateTime', 'messages_endpoint': :'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.
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 204 def ==(other) return true if equal?(other) self.class == other.class && name == other.name && id == other.id && partitions == other.partitions && compartment_id == other.compartment_id && stream_pool_id == other.stream_pool_id && lifecycle_state == other.lifecycle_state && time_created == other.time_created && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 243 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
223 224 225 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 223 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
232 233 234 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 232 def hash [name, id, partitions, compartment_id, stream_pool_id, lifecycle_state, time_created, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
276 277 278 279 280 281 282 283 284 285 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 276 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
270 271 272 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 270 def to_s to_hash.to_s end |