Class: OCI::Streaming::Models::Stream
- Inherits:
-
Object
- Object
- OCI::Streaming::Models::Stream
- Defined in:
- lib/oci/streaming/models/stream.rb
Overview
Detailed representation of a stream, including all its partitions.
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 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.
-
#lifecycle_state_details ⇒ String
Any additional details about 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.
-
#retention_in_hours ⇒ Integer
[Required] The retention period of the stream, in hours.
-
#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 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 = {}) ⇒ Stream
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 = {}) ⇒ Stream
Initializes the object
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 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
# File 'lib/oci/streaming/models/stream.rb', line 142 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.retention_in_hours = attributes[:'retentionInHours'] if attributes[:'retentionInHours'] raise 'You cannot provide both :retentionInHours and :retention_in_hours' if attributes.key?(:'retentionInHours') && attributes.key?(:'retention_in_hours') self.retention_in_hours = attributes[:'retention_in_hours'] if attributes[:'retention_in_hours'] 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.lifecycle_state_details = attributes[:'lifecycleStateDetails'] if attributes[:'lifecycleStateDetails'] raise 'You cannot provide both :lifecycleStateDetails and :lifecycle_state_details' if attributes.key?(:'lifecycleStateDetails') && attributes.key?(:'lifecycle_state_details') self.lifecycle_state_details = attributes[:'lifecycle_state_details'] if attributes[:'lifecycle_state_details'] 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 stream.
42 43 44 |
# File 'lib/oci/streaming/models/stream.rb', line 42 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: `{"CostCenter": "42"}'
82 83 84 |
# File 'lib/oci/streaming/models/stream.rb', line 82 def @defined_tags 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. Exists for cross-compatibility only. For more information, see Resource Tags.
Example: {\"Department\": \"Finance\"}
75 76 77 |
# File 'lib/oci/streaming/models/stream.rb', line 75 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the stream.
30 31 32 |
# File 'lib/oci/streaming/models/stream.rb', line 30 def id @id end |
#lifecycle_state ⇒ String
[Required] The current state of the stream.
50 51 52 |
# File 'lib/oci/streaming/models/stream.rb', line 50 def lifecycle_state @lifecycle_state end |
#lifecycle_state_details ⇒ String
Any additional details about the current state of the stream.
54 55 56 |
# File 'lib/oci/streaming/models/stream.rb', line 54 def lifecycle_state_details @lifecycle_state_details 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.
67 68 69 |
# File 'lib/oci/streaming/models/stream.rb', line 67 def @messages_endpoint end |
#name ⇒ String
[Required] The name of the stream. Avoid entering confidential information.
Example: TelemetryEvents
26 27 28 |
# File 'lib/oci/streaming/models/stream.rb', line 26 def name @name end |
#partitions ⇒ Integer
[Required] The number of partitions in the stream.
34 35 36 |
# File 'lib/oci/streaming/models/stream.rb', line 34 def partitions @partitions end |
#retention_in_hours ⇒ Integer
[Required] The retention period of the stream, in hours. This property is read-only.
38 39 40 |
# File 'lib/oci/streaming/models/stream.rb', line 38 def retention_in_hours @retention_in_hours end |
#stream_pool_id ⇒ String
[Required] The OCID of the stream pool that contains the stream.
46 47 48 |
# File 'lib/oci/streaming/models/stream.rb', line 46 def stream_pool_id @stream_pool_id end |
#time_created ⇒ DateTime
[Required] The date and time the stream was created, expressed in in RFC 3339 timestamp format.
Example: 2018-04-20T00:00:07.405Z
61 62 63 |
# File 'lib/oci/streaming/models/stream.rb', line 61 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/oci/streaming/models/stream.rb', line 85 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'name': :'name', 'id': :'id', 'partitions': :'partitions', 'retention_in_hours': :'retentionInHours', 'compartment_id': :'compartmentId', 'stream_pool_id': :'streamPoolId', 'lifecycle_state': :'lifecycleState', 'lifecycle_state_details': :'lifecycleStateDetails', 'time_created': :'timeCreated', 'messages_endpoint': :'messagesEndpoint', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/oci/streaming/models/stream.rb', line 105 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'name': :'String', 'id': :'String', 'partitions': :'Integer', 'retention_in_hours': :'Integer', 'compartment_id': :'String', 'stream_pool_id': :'String', 'lifecycle_state': :'String', 'lifecycle_state_details': :'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.
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/oci/streaming/models/stream.rb', line 229 def ==(other) return true if equal?(other) self.class == other.class && name == other.name && id == other.id && partitions == other.partitions && retention_in_hours == other.retention_in_hours && compartment_id == other.compartment_id && stream_pool_id == other.stream_pool_id && lifecycle_state == other.lifecycle_state && lifecycle_state_details == other.lifecycle_state_details && time_created == other.time_created && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/oci/streaming/models/stream.rb', line 270 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
250 251 252 |
# File 'lib/oci/streaming/models/stream.rb', line 250 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
259 260 261 |
# File 'lib/oci/streaming/models/stream.rb', line 259 def hash [name, id, partitions, retention_in_hours, compartment_id, stream_pool_id, lifecycle_state, lifecycle_state_details, time_created, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
303 304 305 306 307 308 309 310 311 312 |
# File 'lib/oci/streaming/models/stream.rb', line 303 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
297 298 299 |
# File 'lib/oci/streaming/models/stream.rb', line 297 def to_s to_hash.to_s end |