ContainerInstanceSummary¶

class oci.container_instances.models.ContainerInstanceSummary(**kwargs)¶

Bases: object

A set of details about a single container instance returned by list APIs.

Methods:

__init__(**kwargs)

Initializes a new ContainerInstanceSummary object with values from keyword arguments.

Attributes:

`availability_domain`	[Required] Gets the availability_domain of this ContainerInstanceSummary.
`compartment_id`	[Required] Gets the compartment_id of this ContainerInstanceSummary.
`container_count`	[Required] Gets the container_count of this ContainerInstanceSummary.
`container_restart_policy`	[Required] Gets the container_restart_policy of this ContainerInstanceSummary.
`defined_tags`	Gets the defined_tags of this ContainerInstanceSummary.
`display_name`	[Required] Gets the display_name of this ContainerInstanceSummary.
`fault_domain`	Gets the fault_domain of this ContainerInstanceSummary.
`freeform_tags`	Gets the freeform_tags of this ContainerInstanceSummary.
`graceful_shutdown_timeout_in_seconds`	Gets the graceful_shutdown_timeout_in_seconds of this ContainerInstanceSummary.
`id`	[Required] Gets the id of this ContainerInstanceSummary.
`lifecycle_details`	Gets the lifecycle_details of this ContainerInstanceSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ContainerInstanceSummary.
`security_context`	Gets the security_context of this ContainerInstanceSummary.
`shape`	[Required] Gets the shape of this ContainerInstanceSummary.
`shape_config`	[Required] Gets the shape_config of this ContainerInstanceSummary.
`system_tags`	Gets the system_tags of this ContainerInstanceSummary.
`time_created`	[Required] Gets the time_created of this ContainerInstanceSummary.
`time_updated`	Gets the time_updated of this ContainerInstanceSummary.
`volume_count`	Gets the volume_count of this ContainerInstanceSummary.

__init__(**kwargs)¶

Initializes a new ContainerInstanceSummary 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 ContainerInstanceSummary.
display_name (str) – The value to assign to the display_name property of this ContainerInstanceSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ContainerInstanceSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ContainerInstanceSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ContainerInstanceSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ContainerInstanceSummary.
availability_domain (str) – The value to assign to the availability_domain property of this ContainerInstanceSummary.
fault_domain (str) – The value to assign to the fault_domain property of this ContainerInstanceSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ContainerInstanceSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ContainerInstanceSummary.
time_created (datetime) – The value to assign to the time_created property of this ContainerInstanceSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ContainerInstanceSummary.
shape (str) – The value to assign to the shape property of this ContainerInstanceSummary.
shape_config (oci.container_instances.models.ContainerInstanceShapeConfig) – The value to assign to the shape_config property of this ContainerInstanceSummary.
container_count (int) – The value to assign to the container_count property of this ContainerInstanceSummary.
graceful_shutdown_timeout_in_seconds (int) – The value to assign to the graceful_shutdown_timeout_in_seconds property of this ContainerInstanceSummary.
volume_count (int) – The value to assign to the volume_count property of this ContainerInstanceSummary.
container_restart_policy (str) – The value to assign to the container_restart_policy property of this ContainerInstanceSummary.
security_context (oci.container_instances.models.ContainerInstanceSecurityContext) – The value to assign to the security_context property of this ContainerInstanceSummary.

property availability_domain¶

[Required] Gets the availability_domain of this ContainerInstanceSummary. The availability domain where the container instance runs.

Returns: The availability_domain of this ContainerInstanceSummary.
Return type: str

property compartment_id¶

[Required] Gets the compartment_id of this ContainerInstanceSummary. The OCID of the compartment to create the container instance in.

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

property container_count¶

[Required] Gets the container_count of this ContainerInstanceSummary. The number of containers in the container instance.

Returns: The container_count of this ContainerInstanceSummary.
Return type: int

property container_restart_policy¶

[Required] Gets the container_restart_policy of this ContainerInstanceSummary. Container Restart Policy

Returns: The container_restart_policy of this ContainerInstanceSummary.
Return type: str

property defined_tags¶

Gets the defined_tags of this ContainerInstanceSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}.

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

property display_name¶

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

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

property fault_domain¶

Gets the fault_domain of this ContainerInstanceSummary. The fault domain where the container instance runs.

Returns: The fault_domain of this ContainerInstanceSummary.
Return type: str

property freeform_tags¶

Gets the freeform_tags of this ContainerInstanceSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

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

property graceful_shutdown_timeout_in_seconds¶

Gets the graceful_shutdown_timeout_in_seconds of this ContainerInstanceSummary. The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted.

Returns: The graceful_shutdown_timeout_in_seconds of this ContainerInstanceSummary.
Return type: int

property id¶

[Required] Gets the id of this ContainerInstanceSummary. OCID that cannot be changed.

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

property lifecycle_details¶

Gets the lifecycle_details of this ContainerInstanceSummary. A message that describes the current state of the container instance in more detail. Can be used to provide actionable information.

Returns: The lifecycle_details of this ContainerInstanceSummary.
Return type: str

property lifecycle_state¶

[Required] Gets the lifecycle_state of this ContainerInstanceSummary. The current state of the container instance.

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

property security_context¶

Gets the security_context of this ContainerInstanceSummary.

Returns: The security_context of this ContainerInstanceSummary.
Return type: oci.container_instances.models.ContainerInstanceSecurityContext

property shape¶

[Required] Gets the shape of this ContainerInstanceSummary. The shape of the container instance. The shape determines the resources available to the container instance.

Returns: The shape of this ContainerInstanceSummary.
Return type: str

property shape_config¶

[Required] Gets the shape_config of this ContainerInstanceSummary.

Returns: The shape_config of this ContainerInstanceSummary.
Return type: oci.container_instances.models.ContainerInstanceShapeConfig

property system_tags¶

Gets the system_tags of this ContainerInstanceSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}.

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

property time_created¶

[Required] Gets the time_created of this ContainerInstanceSummary. The time the container instance was created, in the format defined by RFC3339.

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

property time_updated¶

Gets the time_updated of this ContainerInstanceSummary. The time the container instance was updated, in the format defined by RFC3339.

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

property volume_count¶

Gets the volume_count of this ContainerInstanceSummary. The number of volumes that are attached to the container instance.

Returns: The volume_count of this ContainerInstanceSummary.
Return type: int