Class StreamPool

The details of a stream pool.

Inheritance

object

StreamPool

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 StreamPool

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	Compartment OCID that the pool belongs to.

Remarks

Required

CustomEncryptionKey

Declaration

[Required(ErrorMessage = "CustomEncryptionKey is required.")]
[JsonProperty(PropertyName = "customEncryptionKey")]
public CustomEncryptionKey CustomEncryptionKey { get; set; }

Property Value

Type	Description
CustomEncryptionKey

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"}}'

EndpointFqdn

Declaration

[JsonProperty(PropertyName = "endpointFqdn")]
public string EndpointFqdn { get; set; }

Property Value

Type	Description
string	The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a {@link Stream} object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.

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 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 pool.

Remarks

Required

IsPrivate

Declaration

[JsonProperty(PropertyName = "isPrivate")]
public bool? IsPrivate { get; set; }

Property Value

Type	Description
bool?	True if the stream pool is private, false otherwise. If the stream pool is private, the streams inside the stream pool can only be accessed from inside the associated subnetId.

KafkaSettings

Declaration

[Required(ErrorMessage = "KafkaSettings is required.")]
[JsonProperty(PropertyName = "kafkaSettings")]
public KafkaSettings KafkaSettings { get; set; }

Property Value

Type	Description
KafkaSettings

Remarks

Required

LifecycleState

Declaration

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

Property Value

Type	Description
StreamPool.LifecycleStateEnum?	The current state of the stream pool.

Remarks

Required

LifecycleStateDetails

Declaration

[JsonProperty(PropertyName = "lifecycleStateDetails")]
public string LifecycleStateDetails { get; set; }

Property Value

Type	Description
string	Any additional details about the current state of the stream.

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 pool.

Remarks

Required

PrivateEndpointSettings

Declaration

[JsonProperty(PropertyName = "privateEndpointSettings")]
public PrivateEndpointSettings PrivateEndpointSettings { get; set; }

Property Value

Type	Description
PrivateEndpointSettings

SecurityAttributes

Declaration

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

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}

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 pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z

Remarks

Required