ApiPlatformInstanceSummary¶
- class oci.api_platform.models.ApiPlatformInstanceSummary(**kwargs)¶
Bases:
objectSummary information about an instance
Methods:
__init__(**kwargs)Initializes a new ApiPlatformInstanceSummary object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this ApiPlatformInstanceSummary.
[Required] Gets the defined_tags of this ApiPlatformInstanceSummary.
[Required] Gets the freeform_tags of this ApiPlatformInstanceSummary.
[Required] Gets the id of this ApiPlatformInstanceSummary.
Gets the lifecycle_details of this ApiPlatformInstanceSummary.
[Required] Gets the lifecycle_state of this ApiPlatformInstanceSummary.
[Required] Gets the name of this ApiPlatformInstanceSummary.
Gets the system_tags of this ApiPlatformInstanceSummary.
[Required] Gets the time_created of this ApiPlatformInstanceSummary.
Gets the time_updated of this ApiPlatformInstanceSummary.
- __init__(**kwargs)¶
Initializes a new ApiPlatformInstanceSummary 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 ApiPlatformInstanceSummary.
name (str) – The value to assign to the name property of this ApiPlatformInstanceSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ApiPlatformInstanceSummary.
time_created (datetime) – The value to assign to the time_created property of this ApiPlatformInstanceSummary.
time_updated (datetime) – The value to assign to the time_updated property of this ApiPlatformInstanceSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ApiPlatformInstanceSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ApiPlatformInstanceSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ApiPlatformInstanceSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ApiPlatformInstanceSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ApiPlatformInstanceSummary.
- property compartment_id¶
[Required] Gets the compartment_id of this ApiPlatformInstanceSummary. The OCID of the compartment
- Returns
The compartment_id of this ApiPlatformInstanceSummary.
- Return type
str
- property defined_tags¶
[Required] Gets the defined_tags of this ApiPlatformInstanceSummary. 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 ApiPlatformInstanceSummary.
- Return type
dict(str, dict(str, object))
- property freeform_tags¶
[Required] Gets the freeform_tags of this ApiPlatformInstanceSummary. 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 ApiPlatformInstanceSummary.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this ApiPlatformInstanceSummary. The OCID of the instance
- Returns
The id of this ApiPlatformInstanceSummary.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this ApiPlatformInstanceSummary. A message that describes the current state of the Instance in more detail. For example, can be used to provide actionable information for a resource in the Failed state.
- Returns
The lifecycle_details of this ApiPlatformInstanceSummary.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this ApiPlatformInstanceSummary. The current state of the instance
- Returns
The lifecycle_state of this ApiPlatformInstanceSummary.
- Return type
str
- property name¶
[Required] Gets the name of this ApiPlatformInstanceSummary. A regionally unique, non-changeable instance name provided by the user during creation
- Returns
The name of this ApiPlatformInstanceSummary.
- Return type
str
- property system_tags¶
Gets the system_tags of this ApiPlatformInstanceSummary. 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 ApiPlatformInstanceSummary.
- Return type
dict(str, dict(str, object))