class OCI::Streaming::Models::Stream
Detailed representation of a stream, including all its partitions.
Constants
- LIFECYCLE_STATE_ENUM
Attributes
[Required] The OCID of the stream. @return [String]
[Required] The OCID of the stream. @return [String]
[Required] The current state of the stream. @return [String]
Any additional details about the current state of the stream. @return [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.
@return [String]
[Required] The name of the stream. Avoid entering confidential information.
Example: `TelemetryEvents`
@return [String]
[Required] The number of partitions in the stream. @return [Integer]
[Required] The retention period of the stream, in hours. This property is read-only. @return [Integer]
[Required] The OCID of the stream pool that contains the stream. @return [String]
[Required] The date and time the stream was created, expressed in in [RFC 3339](tools.ietf.org/rfc/rfc3339) timestamp format.
Example: `2018-04-20T00:00:07.405Z`
@return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :id The value to assign to the {#id} property @option attributes [Integer] :partitions The value to assign to the {#partitions} property @option attributes [Integer] :retention_in_hours The value to assign to the {#retention_in_hours} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :stream_pool_id The value to assign to the {#stream_pool_id} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [String] :lifecycle_state_details The value to assign to the {#lifecycle_state_details} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :messages_endpoint The value to assign to the {#messages_endpoint} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property
# 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.messages_endpoint = attributes[:'messagesEndpoint'] if attributes[:'messagesEndpoint'] raise 'You cannot provide both :messagesEndpoint and :messages_endpoint' if attributes.key?(:'messagesEndpoint') && attributes.key?(:'messages_endpoint') self.messages_endpoint = attributes[:'messages_endpoint'] if attributes[:'messages_endpoint'] 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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# 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 && messages_endpoint == other.messages_endpoint && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/streaming/models/stream.rb, line 250 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# 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, messages_endpoint, freeform_tags, defined_tags].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/streaming/models/stream.rb, line 213 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/streaming/models/stream.rb, line 297 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/streaming/models/stream.rb, line 320 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end