Class Channel
A Channel connecting a DB System to an external entity.
Inherited Members
Namespace: Oci.MysqlService.Models
Assembly: OCI.DotNetSDK.Mysql.dll
Syntax
public class Channel
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. |
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>> | Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}} |
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | User provided description of the Channel. |
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | The user-friendly name for the Channel. It does not have to be unique. |
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 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 | The OCID of the Channel. |
Remarks
Required
IsEnabled
Declaration
[Required(ErrorMessage = "IsEnabled is required.")]
[JsonProperty(PropertyName = "isEnabled")]
public bool? IsEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool? | Whether the Channel has been enabled by the user. |
Remarks
Required
LifecycleDetails
Declaration
[JsonProperty(PropertyName = "lifecycleDetails")]
public string LifecycleDetails { get; set; }
Property Value
Type | Description |
---|---|
string | A message describing the state of the Channel. |
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Channel.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
Channel.LifecycleStateEnum? | The state of the Channel. |
Remarks
Required
Source
Declaration
[Required(ErrorMessage = "Source is required.")]
[JsonProperty(PropertyName = "source")]
public ChannelSource Source { get; set; }
Property Value
Type | Description |
---|---|
ChannelSource |
Remarks
Required
Target
Declaration
[Required(ErrorMessage = "Target is required.")]
[JsonProperty(PropertyName = "target")]
public ChannelTarget Target { get; set; }
Property Value
Type | Description |
---|---|
ChannelTarget |
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 Channel was created, as described by RFC 3339. |
Remarks
Required
TimeUpdated
Declaration
[Required(ErrorMessage = "TimeUpdated is required.")]
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | The time the Channel was last updated, as described by RFC 3339. |
Remarks
Required