Class StreamSummary

Summary representation of a stream.

Inheritance

object

StreamSummary

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.StreamingService.Models

Assembly: OCI.DotNetSDK.Streaming.dll

Syntax

public class StreamSummary

Properties

CompartmentId

Declaration

[Required(ErrorMessage = "CompartmentId is required.")]
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }

Property Value

Type	Description
string	The OCID of the compartment that contains the stream.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<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"}}

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<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"}

Id

Declaration

[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }

Property Value

Type	Description
string	The OCID of the stream.

Remarks

Required

LifecycleState

Declaration

[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public StreamSummary.LifecycleStateEnum? LifecycleState { get; set; }

Property Value

Type	Description
StreamSummary.LifecycleStateEnum?	The current state of the stream.

Remarks

Required

MessagesEndpoint

Declaration

[Required(ErrorMessage = "MessagesEndpoint is required.")]
[JsonProperty(PropertyName = "messagesEndpoint")]
public string MessagesEndpoint { get; set; }

Property Value

Type	Description
string	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.

Remarks

Required

Name

Declaration

[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }

Property Value

Type	Description
string	The name of the stream. Example: TelemetryEvents

Remarks

Required

Partitions

Declaration

[Required(ErrorMessage = "Partitions is required.")]
[JsonProperty(PropertyName = "partitions")]
public int? Partitions { get; set; }

Property Value

Type	Description
int?	The number of partitions in the stream.

Remarks

Required

StreamPoolId

Declaration

[Required(ErrorMessage = "StreamPoolId is required.")]
[JsonProperty(PropertyName = "streamPoolId")]
public string StreamPoolId { get; set; }

Property Value

Type	Description
string	The OCID of the stream pool that contains the stream.

Remarks

Required

TimeCreated

Declaration

[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	The date and time the stream was created, expressed in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z

Remarks

Required