Class ConsumerGroupSummary
Summary of the consumer group.
Inherited Members
Namespace: Oci.QueueService.Models
Assembly: OCI.DotNetSDK.Queue.dll
Syntax
public class ConsumerGroupSummaryProperties
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. Example: {"foo-namespace": {"bar-key": "value"}} |
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }Property Value
| Type | Description |
|---|---|
| string | A user-friendly name for the consumer group. It has to be unique within the same queue in a case-insensitive manner. It's changeable. Avoid entering confidential information. |
Remarks
Required
Filter
Declaration
[Required(ErrorMessage = "Filter is required.")]
[JsonProperty(PropertyName = "filter")]
public string Filter { get; set; }Property Value
| Type | Description |
|---|---|
| string | The filter used by the consumer group. Only messages matching the filter will be available by consumers of the group. |
Remarks
Required
FreeformTags
Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }Property Value
| Type | Description |
|---|---|
| Dictionary<string, string> | Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"} |
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }Property Value
| Type | Description |
|---|---|
| string | A unique identifier for the consumer group that is immutable on creation. |
Remarks
Required
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }Property Value
| Type | Description |
|---|---|
| string | Any additional details about the current state of the consumer group. |
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(StringEnumConverter))]
public ConsumerGroup.LifecycleStateEnum? LifecycleState { get; set; }Property Value
| Type | Description |
|---|---|
| ConsumerGroup.LifecycleStateEnum? | The current state of the consumer group. |
Remarks
Required
QueueId
Declaration
[Required(ErrorMessage = "QueueId is required.")]
[JsonProperty(PropertyName = "queueId")]
public string QueueId { get; set; }Property Value
| Type | Description |
|---|---|
| string | The OCID of the associated queue. |
Remarks
Required
SystemTags
Declaration
[JsonProperty(PropertyName = "systemTags")]
public Dictionary<string, Dictionary<string, object>> SystemTags { get; set; }Property Value
| Type | Description |
|---|---|
| Dictionary<string, Dictionary<string, object>> | Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}} |
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime? | The time that the consumer group was created, expressed in RFC 3339 timestamp format.
|
Remarks
Required
TimeUpdated
Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime? | The time that the consumer group was updated, expressed in RFC 3339 timestamp format.
|
Remarks
Required