CreateApiPlatformInstanceDetails¶
- class oci.api_platform.models.CreateApiPlatformInstanceDetails(**kwargs)¶
Bases:
objectThe data to create an instance
Methods:
__init__(**kwargs)Initializes a new CreateApiPlatformInstanceDetails object with values from keyword arguments.
Attributes:
[Required] Gets the compartment_id of this CreateApiPlatformInstanceDetails.
Gets the defined_tags of this CreateApiPlatformInstanceDetails.
Gets the description of this CreateApiPlatformInstanceDetails.
Gets the freeform_tags of this CreateApiPlatformInstanceDetails.
[Required] Gets the name of this CreateApiPlatformInstanceDetails.
- __init__(**kwargs)¶
Initializes a new CreateApiPlatformInstanceDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):
- Parameters
name (str) – The value to assign to the name property of this CreateApiPlatformInstanceDetails.
description (str) – The value to assign to the description property of this CreateApiPlatformInstanceDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateApiPlatformInstanceDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateApiPlatformInstanceDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateApiPlatformInstanceDetails.
- property compartment_id¶
[Required] Gets the compartment_id of this CreateApiPlatformInstanceDetails. The OCID of the compartment to create the instance in.
- Returns
The compartment_id of this CreateApiPlatformInstanceDetails.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this CreateApiPlatformInstanceDetails. 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 CreateApiPlatformInstanceDetails.
- Return type
dict(str, dict(str, object))
- property description¶
Gets the description of this CreateApiPlatformInstanceDetails. User-provided changeable and non-unique description of the instance
- Returns
The description of this CreateApiPlatformInstanceDetails.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this CreateApiPlatformInstanceDetails. 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 CreateApiPlatformInstanceDetails.
- Return type
dict(str, str)
- property name¶
[Required] Gets the name of this CreateApiPlatformInstanceDetails. A regionally unique, non-changeable instance name provided by the user during creation
- Returns
The name of this CreateApiPlatformInstanceDetails.
- Return type
str