Class IotFlowRuntime
An IoT flow runtime is a managed Node-RED runtime in an IoT domain for building and running Node-RED flows.
Inherited Members
Namespace: Oci.IotService.Models
Assembly: OCI.DotNetSDK.Iot.dll
Syntax
public class IotFlowRuntime
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 corresponding to the resource. |
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.
|
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
| Type | Description |
|---|---|
| string | A short description of the resource. |
DisplayName
Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
| Type | Description |
|---|---|
| string | A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. |
Remarks
Required
FlowRuntimeHost
Declaration
[JsonProperty(PropertyName = "flowRuntimeHost")]
public string FlowRuntimeHost { get; set; }
Property Value
| Type | Description |
|---|---|
| string | Hostname of the IoT flow runtime. |
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.
For more information, see Resource Tags.
|
Id
Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The OCID of the resource. |
Remarks
Required
IotDomainId
Declaration
[Required(ErrorMessage = "IotDomainId is required.")]
[JsonProperty(PropertyName = "iotDomainId")]
public string IotDomainId { get; set; }
Property Value
| Type | Description |
|---|---|
| string | The OCID of the IoT domain. |
Remarks
Required
LifecycleState
Declaration
[Required(ErrorMessage = "LifecycleState is required.")]
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public IotFlowRuntime.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
| Type | Description |
|---|---|
| IotFlowRuntime.LifecycleStateEnum? | The current state of the IoT flow runtime. |
Remarks
Required
LogConfig
Declaration
[JsonProperty(PropertyName = "logConfig")]
public LogConfigDetails LogConfig { get; set; }
Property Value
| Type | Description |
|---|---|
| LogConfigDetails |
NetworkConfig
Declaration
[JsonProperty(PropertyName = "networkConfig")]
public NetworkConfigDetails NetworkConfig { get; set; }
Property Value
| Type | Description |
|---|---|
| NetworkConfigDetails |
Scale
Declaration
[Required(ErrorMessage = "Scale is required.")]
[JsonProperty(PropertyName = "scale")]
[JsonConverter(typeof(ResponseEnumConverter))]
public IotFlowRuntime.ScaleEnum? Scale { get; set; }
Property Value
| Type | Description |
|---|---|
| IotFlowRuntime.ScaleEnum? | The scale of the IoT flow runtime. Larger values allocate more CPU and memory for higher throughput and operational headroom. MEDIUM is the default value. |
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>> | System tags for this resource. Each key is predefined and scoped to a namespace.
|
TimeCreated
Declaration
[Required(ErrorMessage = "TimeCreated is required.")]
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime? | The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z |
Remarks
Required
TimeUpdated
Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
| Type | Description |
|---|---|
| DateTime? | The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z |