ContainerSummary¶

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

Bases: object

Summary information about a container.

Methods

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

Attributes

`availability_domain`	[Required] Gets the availability_domain of this ContainerSummary.
`compartment_id`	[Required] Gets the compartment_id of this ContainerSummary.
`container_instance_id`	[Required] Gets the container_instance_id of this ContainerSummary.
`defined_tags`	Gets the defined_tags of this ContainerSummary.
`display_name`	[Required] Gets the display_name of this ContainerSummary.
`fault_domain`	Gets the fault_domain of this ContainerSummary.
`freeform_tags`	Gets the freeform_tags of this ContainerSummary.
`id`	[Required] Gets the id of this ContainerSummary.
`image_url`	[Required] Gets the image_url of this ContainerSummary.
`is_resource_principal_disabled`	Gets the is_resource_principal_disabled of this ContainerSummary.
`lifecycle_details`	Gets the lifecycle_details of this ContainerSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ContainerSummary.
`resource_config`	Gets the resource_config of this ContainerSummary.
`security_context`	Gets the security_context of this ContainerSummary.
`system_tags`	Gets the system_tags of this ContainerSummary.
`time_created`	[Required] Gets the time_created of this ContainerSummary.
`time_updated`	Gets the time_updated of this ContainerSummary.

__init__(**kwargs)¶

Initializes a new ContainerSummary 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 ContainerSummary.
display_name (str) – The value to assign to the display_name property of this ContainerSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ContainerSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ContainerSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ContainerSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ContainerSummary.
availability_domain (str) – The value to assign to the availability_domain property of this ContainerSummary.
fault_domain (str) – The value to assign to the fault_domain property of this ContainerSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ContainerSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ContainerSummary.
time_created (datetime) – The value to assign to the time_created property of this ContainerSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ContainerSummary.
container_instance_id (str) – The value to assign to the container_instance_id property of this ContainerSummary.
resource_config (oci.container_instances.models.ContainerResourceConfig) – The value to assign to the resource_config property of this ContainerSummary.
image_url (str) – The value to assign to the image_url property of this ContainerSummary.
is_resource_principal_disabled (bool) – The value to assign to the is_resource_principal_disabled property of this ContainerSummary.
security_context (oci.container_instances.models.SecurityContext) – The value to assign to the security_context property of this ContainerSummary.

availability_domain¶

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

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

compartment_id¶

[Required] Gets the compartment_id of this ContainerSummary. The compartment OCID.

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

container_instance_id¶

[Required] Gets the container_instance_id of this ContainerSummary. The OCID of the container instance on which the container is running.

Returns:	The container_instance_id of this ContainerSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this ContainerSummary. 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 ContainerSummary.
Return type:	dict(str, dict(str, object))

display_name¶

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

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

fault_domain¶

Gets the fault_domain of this ContainerSummary. The fault domain where the container instance that hosts the container runs.

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

freeform_tags¶

Gets the freeform_tags of this ContainerSummary. 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 ContainerSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ContainerSummary. The OCID of the container.

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

image_url¶

[Required] Gets the image_url of this ContainerSummary. A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest.

If no registry is provided, will default the registry to public docker hub docker.io/library. The registry used for container image must be reachable over the Container Instance’s VNIC.

Returns:	The image_url of this ContainerSummary.
Return type:	str

is_resource_principal_disabled¶

Gets the is_resource_principal_disabled of this ContainerSummary. Determines whether the container will have access to the container instance resource principal.

This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.

Returns:	The is_resource_principal_disabled of this ContainerSummary.
Return type:	bool

lifecycle_details¶

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

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

lifecycle_state¶

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

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

resource_config¶

Gets the resource_config of this ContainerSummary.

Returns:	The resource_config of this ContainerSummary.
Return type:	oci.container_instances.models.ContainerResourceConfig

security_context¶

Gets the security_context of this ContainerSummary.

Returns:	The security_context of this ContainerSummary.
Return type:	oci.container_instances.models.SecurityContext

system_tags¶

Gets the system_tags of this ContainerSummary. 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 ContainerSummary.
Return type:	dict(str, dict(str, object))

time_created¶

[Required] Gets the time_created of this ContainerSummary. The time the the container was created in the format defined by RFC 3339.

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

time_updated¶

Gets the time_updated of this ContainerSummary. The time the container was updated in the format defined by RFC 3339.

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