IotFlowRuntimeSummary

class oci.iot.models.IotFlowRuntimeSummary(**kwargs)

Bases: object

Summary information about an IoT flow runtime.

Attributes:

SCALE_HIGH

A constant which can be used with the scale property of a IotFlowRuntimeSummary.

SCALE_HIGHEST

A constant which can be used with the scale property of a IotFlowRuntimeSummary.

SCALE_LOW

A constant which can be used with the scale property of a IotFlowRuntimeSummary.

SCALE_LOWEST

A constant which can be used with the scale property of a IotFlowRuntimeSummary.

SCALE_MEDIUM

A constant which can be used with the scale property of a IotFlowRuntimeSummary.

compartment_id

[Required] Gets the compartment_id of this IotFlowRuntimeSummary.

defined_tags

Gets the defined_tags of this IotFlowRuntimeSummary.

description

Gets the description of this IotFlowRuntimeSummary.

display_name

[Required] Gets the display_name of this IotFlowRuntimeSummary.

freeform_tags

Gets the freeform_tags of this IotFlowRuntimeSummary.

id

[Required] Gets the id of this IotFlowRuntimeSummary.

iot_domain_id

[Required] Gets the iot_domain_id of this IotFlowRuntimeSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this IotFlowRuntimeSummary.

scale

[Required] Gets the scale of this IotFlowRuntimeSummary.

system_tags

Gets the system_tags of this IotFlowRuntimeSummary.

time_created

[Required] Gets the time_created of this IotFlowRuntimeSummary.

time_updated

Gets the time_updated of this IotFlowRuntimeSummary.

Methods:

__init__(**kwargs)

Initializes a new IotFlowRuntimeSummary object with values from keyword arguments.

SCALE_HIGH = 'HIGH'

A constant which can be used with the scale property of a IotFlowRuntimeSummary. This constant has a value of “HIGH”

SCALE_HIGHEST = 'HIGHEST'

A constant which can be used with the scale property of a IotFlowRuntimeSummary. This constant has a value of “HIGHEST”

SCALE_LOW = 'LOW'

A constant which can be used with the scale property of a IotFlowRuntimeSummary. This constant has a value of “LOW”

SCALE_LOWEST = 'LOWEST'

A constant which can be used with the scale property of a IotFlowRuntimeSummary. This constant has a value of “LOWEST”

SCALE_MEDIUM = 'MEDIUM'

A constant which can be used with the scale property of a IotFlowRuntimeSummary. This constant has a value of “MEDIUM”

__init__(**kwargs)

Initializes a new IotFlowRuntimeSummary 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 IotFlowRuntimeSummary.

  • iot_domain_id (str) – The value to assign to the iot_domain_id property of this IotFlowRuntimeSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this IotFlowRuntimeSummary.

  • scale (str) – The value to assign to the scale property of this IotFlowRuntimeSummary. 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’.

  • display_name (str) – The value to assign to the display_name property of this IotFlowRuntimeSummary.

  • description (str) – The value to assign to the description property of this IotFlowRuntimeSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this IotFlowRuntimeSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this IotFlowRuntimeSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this IotFlowRuntimeSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this IotFlowRuntimeSummary.

  • time_created (datetime) – The value to assign to the time_created property of this IotFlowRuntimeSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this IotFlowRuntimeSummary.

property compartment_id

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

Returns

The compartment_id of this IotFlowRuntimeSummary.

Return type

str

property defined_tags

Gets the defined_tags of this IotFlowRuntimeSummary. 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 IotFlowRuntimeSummary.

Return type

dict(str, dict(str, object))

property description

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

Returns

The description of this IotFlowRuntimeSummary.

Return type

str

property display_name

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

Returns

The display_name of this IotFlowRuntimeSummary.

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

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

Returns

The id of this IotFlowRuntimeSummary.

Return type

str

property iot_domain_id

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

Returns

The iot_domain_id of this IotFlowRuntimeSummary.

Return type

str

property lifecycle_state

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

Returns

The lifecycle_state of this IotFlowRuntimeSummary.

Return type

str

property scale

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

Return type

str

property system_tags

Gets the system_tags of this IotFlowRuntimeSummary. 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 IotFlowRuntimeSummary.

Return type

dict(str, dict(str, object))

property time_created

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

Return type

datetime

property time_updated

Gets the time_updated of this IotFlowRuntimeSummary. 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 IotFlowRuntimeSummary.

Return type

datetime