IotFlowRuntime¶

class oci.iot.models.IotFlowRuntime(**kwargs)¶

Bases: object

An IoT flow runtime is a managed Node-RED runtime in an IoT domain for building and running Node-RED flows.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a IotFlowRuntime.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a IotFlowRuntime.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a IotFlowRuntime.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a IotFlowRuntime.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a IotFlowRuntime.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a IotFlowRuntime.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a IotFlowRuntime.
`SCALE_HIGH`	A constant which can be used with the scale property of a IotFlowRuntime.
`SCALE_HIGHEST`	A constant which can be used with the scale property of a IotFlowRuntime.
`SCALE_LOW`	A constant which can be used with the scale property of a IotFlowRuntime.
`SCALE_LOWEST`	A constant which can be used with the scale property of a IotFlowRuntime.
`SCALE_MEDIUM`	A constant which can be used with the scale property of a IotFlowRuntime.
`compartment_id`	[Required] Gets the compartment_id of this IotFlowRuntime.
`defined_tags`	Gets the defined_tags of this IotFlowRuntime.
`description`	Gets the description of this IotFlowRuntime.
`display_name`	[Required] Gets the display_name of this IotFlowRuntime.
`flow_runtime_host`	Gets the flow_runtime_host of this IotFlowRuntime.
`freeform_tags`	Gets the freeform_tags of this IotFlowRuntime.
`id`	[Required] Gets the id of this IotFlowRuntime.
`iot_domain_id`	[Required] Gets the iot_domain_id of this IotFlowRuntime.
`lifecycle_state`	[Required] Gets the lifecycle_state of this IotFlowRuntime.
`log_config`	Gets the log_config of this IotFlowRuntime.
`network_config`	Gets the network_config of this IotFlowRuntime.
`scale`	[Required] Gets the scale of this IotFlowRuntime.
`system_tags`	Gets the system_tags of this IotFlowRuntime.
`time_created`	[Required] Gets the time_created of this IotFlowRuntime.
`time_updated`	Gets the time_updated of this IotFlowRuntime.

Methods

__init__(**kwargs) Initializes a new IotFlowRuntime object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a IotFlowRuntime. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a IotFlowRuntime. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a IotFlowRuntime. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a IotFlowRuntime. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a IotFlowRuntime. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a IotFlowRuntime. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a IotFlowRuntime. This constant has a value of “UPDATING”

SCALE_HIGH = 'HIGH'¶: A constant which can be used with the scale property of a IotFlowRuntime. This constant has a value of “HIGH”

SCALE_HIGHEST = 'HIGHEST'¶: A constant which can be used with the scale property of a IotFlowRuntime. This constant has a value of “HIGHEST”

SCALE_LOW = 'LOW'¶: A constant which can be used with the scale property of a IotFlowRuntime. This constant has a value of “LOW”

SCALE_LOWEST = 'LOWEST'¶: A constant which can be used with the scale property of a IotFlowRuntime. This constant has a value of “LOWEST”

SCALE_MEDIUM = 'MEDIUM'¶: A constant which can be used with the scale property of a IotFlowRuntime. This constant has a value of “MEDIUM”

__init__(**kwargs)¶

Initializes a new IotFlowRuntime object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this IotFlowRuntime.
iot_domain_id (str) – The value to assign to the iot_domain_id property of this IotFlowRuntime.
compartment_id (str) – The value to assign to the compartment_id property of this IotFlowRuntime.
display_name (str) – The value to assign to the display_name property of this IotFlowRuntime.
description (str) – The value to assign to the description property of this IotFlowRuntime.
scale (str) – The value to assign to the scale property of this IotFlowRuntime. Allowed values for this property are: “LOWEST”, “LOW”, “MEDIUM”, “HIGH”, “HIGHEST”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
log_config (oci.iot.models.LogConfigDetails) – The value to assign to the log_config property of this IotFlowRuntime.
flow_runtime_host (str) – The value to assign to the flow_runtime_host property of this IotFlowRuntime.
network_config (oci.iot.models.NetworkConfigDetails) – The value to assign to the network_config property of this IotFlowRuntime.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this IotFlowRuntime. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this IotFlowRuntime.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this IotFlowRuntime.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this IotFlowRuntime.
time_created (datetime) – The value to assign to the time_created property of this IotFlowRuntime.
time_updated (datetime) – The value to assign to the time_updated property of this IotFlowRuntime.

compartment_id¶

[Required] Gets the compartment_id of this IotFlowRuntime. The OCID of the compartment corresponding to the resource.

Returns:	The compartment_id of this IotFlowRuntime.
Return type:	str

defined_tags¶

Gets the defined_tags of this IotFlowRuntime. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {“Operations”: {“CostCenter”: “42”}}

Returns:	The defined_tags of this IotFlowRuntime.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this IotFlowRuntime. A short description of the resource.

Returns:	The description of this IotFlowRuntime.
Return type:	str

display_name¶

[Required] Gets the display_name of this IotFlowRuntime. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:	The display_name of this IotFlowRuntime.
Return type:	str

flow_runtime_host¶

Gets the flow_runtime_host of this IotFlowRuntime. Hostname of the IoT flow runtime.

Returns:	The flow_runtime_host of this IotFlowRuntime.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this IotFlowRuntime. 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.

Example: {“Department”: “Finance”}

Returns:	The freeform_tags of this IotFlowRuntime.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this IotFlowRuntime. The OCID of the resource.

Returns:	The id of this IotFlowRuntime.
Return type:	str

iot_domain_id¶

[Required] Gets the iot_domain_id of this IotFlowRuntime. The OCID of the IoT domain.

Returns:	The iot_domain_id of this IotFlowRuntime.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this IotFlowRuntime. The current state of the IoT flow runtime.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this IotFlowRuntime.
Return type:	str

log_config¶

Gets the log_config of this IotFlowRuntime.

Returns:	The log_config of this IotFlowRuntime.
Return type:	oci.iot.models.LogConfigDetails

network_config¶

Gets the network_config of this IotFlowRuntime.

Returns:	The network_config of this IotFlowRuntime.
Return type:	oci.iot.models.NetworkConfigDetails

scale¶

[Required] Gets the scale of this IotFlowRuntime. 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.

Allowed values for this property are: “LOWEST”, “LOW”, “MEDIUM”, “HIGH”, “HIGHEST”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The scale of this IotFlowRuntime.
Return type:	str

system_tags¶

Gets the system_tags of this IotFlowRuntime. System tags for this resource. Each key is predefined and scoped to a namespace.

Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:	The system_tags of this IotFlowRuntime.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this IotFlowRuntime. The date and time when the resource was created, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this IotFlowRuntime.
Return type:	datetime

time_updated¶

Gets the time_updated of this IotFlowRuntime. The date and time when the resource was last updated, in the format defined by RFC 3339. Example: 2016-08-25T21:10:29.600Z

Returns:	The time_updated of this IotFlowRuntime.
Return type:	datetime