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_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.
-
#time_created ⇒ DateTime
[Required] The date and time the stream was created, expressed in [RFC 3339](tools.ietf.org/rfc/rfc3339) 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
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 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 117 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.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.
36 37 38 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 36 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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
Example: ‘{"CostCenter": "42"}`
66 67 68 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 66 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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
Example: ‘"Finance"`
59 60 61 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 59 def @freeform_tags end |
#id ⇒ String
[Required] The OCID of the stream.
28 29 30 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 28 def id @id end |
#lifecycle_state ⇒ String
[Required] The current state of the stream.
40 41 42 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 40 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.
51 52 53 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 51 def @messages_endpoint end |
#name ⇒ String
[Required] The name of the stream.
Example: ‘TelemetryEvents`
24 25 26 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 24 def name @name end |
#partitions ⇒ Integer
[Required] The number of partitions in the stream.
32 33 34 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 32 def partitions @partitions end |
#time_created ⇒ DateTime
[Required] The date and time the stream was created, expressed in [RFC 3339](tools.ietf.org/rfc/rfc3339) timestamp format.
Example: ‘2018-04-20T00:00:07.405Z`
47 48 49 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 47 def time_created @time_created end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 69 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'name': :'name', 'id': :'id', 'partitions': :'partitions', 'compartment_id': :'compartmentId', '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.
86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 86 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'name': :'String', 'id': :'String', 'partitions': :'Integer', 'compartment_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.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 186 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 && lifecycle_state == other.lifecycle_state && time_created == other.time_created && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 224 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
204 205 206 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 204 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
213 214 215 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 213 def hash [name, id, partitions, compartment_id, lifecycle_state, time_created, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
257 258 259 260 261 262 263 264 265 266 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 257 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
251 252 253 |
# File 'lib/oci/streaming/models/stream_summary.rb', line 251 def to_s to_hash.to_s end |