ApiPlatformInstance¶
- class oci.api_platform.models.ApiPlatformInstance(**kwargs)¶
Bases:
objectA Logical Entity that can be used to create, manage, secure, and advertise APIs to connect to new or existing services
Attributes:
A constant which can be used with the lifecycle_state property of a ApiPlatformInstance.
A constant which can be used with the lifecycle_state property of a ApiPlatformInstance.
A constant which can be used with the lifecycle_state property of a ApiPlatformInstance.
A constant which can be used with the lifecycle_state property of a ApiPlatformInstance.
A constant which can be used with the lifecycle_state property of a ApiPlatformInstance.
A constant which can be used with the lifecycle_state property of a ApiPlatformInstance.
[Required] Gets the compartment_id of this ApiPlatformInstance.
[Required] Gets the defined_tags of this ApiPlatformInstance.
Gets the description of this ApiPlatformInstance.
[Required] Gets the freeform_tags of this ApiPlatformInstance.
[Required] Gets the id of this ApiPlatformInstance.
Gets the idcs_app of this ApiPlatformInstance.
Gets the lifecycle_details of this ApiPlatformInstance.
[Required] Gets the lifecycle_state of this ApiPlatformInstance.
[Required] Gets the name of this ApiPlatformInstance.
Gets the system_tags of this ApiPlatformInstance.
[Required] Gets the time_created of this ApiPlatformInstance.
Gets the time_updated of this ApiPlatformInstance.
Gets the uris of this ApiPlatformInstance.
Methods:
__init__(**kwargs)Initializes a new ApiPlatformInstance object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a ApiPlatformInstance. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a ApiPlatformInstance. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a ApiPlatformInstance. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a ApiPlatformInstance. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a ApiPlatformInstance. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a ApiPlatformInstance. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new ApiPlatformInstance 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 ApiPlatformInstance.
description (str) – The value to assign to the description property of this ApiPlatformInstance.
name (str) – The value to assign to the name property of this ApiPlatformInstance.
compartment_id (str) – The value to assign to the compartment_id property of this ApiPlatformInstance.
idcs_app (oci.api_platform.models.IdcsApp) – The value to assign to the idcs_app property of this ApiPlatformInstance.
uris (oci.api_platform.models.Uris) – The value to assign to the uris property of this ApiPlatformInstance.
time_created (datetime) – The value to assign to the time_created property of this ApiPlatformInstance.
time_updated (datetime) – The value to assign to the time_updated property of this ApiPlatformInstance.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ApiPlatformInstance. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ApiPlatformInstance.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ApiPlatformInstance.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ApiPlatformInstance.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ApiPlatformInstance.
- property compartment_id¶
[Required] Gets the compartment_id of this ApiPlatformInstance. The OCID of the compartment
- Returns
The compartment_id of this ApiPlatformInstance.
- Return type
str
- property defined_tags¶
[Required] Gets the defined_tags of this ApiPlatformInstance. 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 ApiPlatformInstance.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this ApiPlatformInstance. User-provided changeable and non-unique description of the instance
- Returns
The description of this ApiPlatformInstance.
- Return type
str
- property freeform_tags¶
[Required] Gets the freeform_tags of this ApiPlatformInstance. 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 ApiPlatformInstance.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this ApiPlatformInstance. The OCID of the instance
- Returns
The id of this ApiPlatformInstance.
- Return type
str
- property idcs_app¶
Gets the idcs_app of this ApiPlatformInstance.
- Returns
The idcs_app of this ApiPlatformInstance.
- Return type
- property lifecycle_details¶
Gets the lifecycle_details of this ApiPlatformInstance. 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 ApiPlatformInstance.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this ApiPlatformInstance. The current state of the instance
Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 ApiPlatformInstance.
- Return type
str
- property name¶
[Required] Gets the name of this ApiPlatformInstance. A regionally unique, non-changeable instance name provided by the user during instance creation
- Returns
The name of this ApiPlatformInstance.
- Return type
str
- property system_tags¶
Gets the system_tags of this ApiPlatformInstance. 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 ApiPlatformInstance.
- Return type
dict(str, dict(str, object))
- property time_created¶
[Required] Gets the time_created of this ApiPlatformInstance. The date and time the instance was created, in the format defined by RFC 3339
Example: 2016-08-25T21:10:29.600Z
- Returns
The time_created of this ApiPlatformInstance.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this ApiPlatformInstance. The date and time the instance was updated, in the format defined by RFC 3339
Example: 2016-08-25T21:10:29.600Z
- Returns
The time_updated of this ApiPlatformInstance.
- Return type
datetime
- property uris¶
Gets the uris of this ApiPlatformInstance.
- Returns
The uris of this ApiPlatformInstance.
- Return type