Sdk¶
- class oci.apigateway.models.Sdk(**kwargs)¶
Bases:
objectInformation about the SDK.
Attributes:
A constant which can be used with the lifecycle_state property of a Sdk.
A constant which can be used with the lifecycle_state property of a Sdk.
A constant which can be used with the lifecycle_state property of a Sdk.
A constant which can be used with the lifecycle_state property of a Sdk.
A constant which can be used with the lifecycle_state property of a Sdk.
[Required] Gets the api_id of this Sdk.
Gets the artifact_url of this Sdk.
Gets the compartment_id of this Sdk.
Gets the defined_tags of this Sdk.
[Required] Gets the display_name of this Sdk.
Gets the freeform_tags of this Sdk.
[Required] Gets the id of this Sdk.
Gets the lifecycle_details of this Sdk.
Gets the lifecycle_state of this Sdk.
Gets the locks of this Sdk.
Gets the parameters of this Sdk.
Gets the system_tags of this Sdk.
[Required] Gets the target_language of this Sdk.
Gets the time_artifact_url_expires_at of this Sdk.
Gets the time_created of this Sdk.
Gets the time_updated of this Sdk.
Methods:
__init__(**kwargs)Initializes a new Sdk object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a Sdk. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a Sdk. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a Sdk. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a Sdk. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a Sdk. This constant has a value of “FAILED”
- __init__(**kwargs)¶
Initializes a new Sdk 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 Sdk.
api_id (str) – The value to assign to the api_id property of this Sdk.
compartment_id (str) – The value to assign to the compartment_id property of this Sdk.
time_created (datetime) – The value to assign to the time_created property of this Sdk.
time_updated (datetime) – The value to assign to the time_updated property of this Sdk.
display_name (str) – The value to assign to the display_name property of this Sdk.
target_language (str) – The value to assign to the target_language property of this Sdk.
artifact_url (str) – The value to assign to the artifact_url property of this Sdk.
time_artifact_url_expires_at (datetime) – The value to assign to the time_artifact_url_expires_at property of this Sdk.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Sdk. Allowed values for this property are: “CREATING”, “ACTIVE”, “FAILED”, “DELETING”, “DELETED”, ‘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 Sdk.
locks (list[oci.apigateway.models.ResourceLock]) – The value to assign to the locks property of this Sdk.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Sdk.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Sdk.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Sdk.
parameters (dict(str, str)) – The value to assign to the parameters property of this Sdk.
- property api_id¶
[Required] Gets the api_id of this Sdk. The OCID of API resource
- Returns
The api_id of this Sdk.
- Return type
str
- property artifact_url¶
Gets the artifact_url of this Sdk. File location for generated SDK.
- Returns
The artifact_url of this Sdk.
- Return type
str
- property compartment_id¶
Gets the compartment_id of this Sdk. The OCID of the compartment in which the resource is created.
- Returns
The compartment_id of this Sdk.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this Sdk. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {“Operations”: {“CostCenter”: “42”}}
- Returns
The defined_tags of this Sdk.
- Return type
dict(str, dict(str, object))
- property display_name¶
[Required] Gets the display_name of this Sdk. A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
Example: My new resource
- Returns
The display_name of this Sdk.
- Return type
str
- property freeform_tags¶
Gets the freeform_tags of this Sdk. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {“Department”: “Finance”}
- Returns
The freeform_tags of this Sdk.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this Sdk. The OCID of the resource.
- Returns
The id of this Sdk.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this Sdk. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.
- Returns
The lifecycle_details of this Sdk.
- Return type
str
- property lifecycle_state¶
Gets the lifecycle_state of this Sdk. The current state of the SDK. - The SDK will be in CREATING state if the SDK creation is in progress. - The SDK will be in ACTIVE state if create is successful. - The SDK will be in FAILED state if the create, or delete fails. - The SDK will be in DELETING state if the deletion in in progress. - The SDK will be in DELETED state if the delete is successful.
Allowed values for this property are: “CREATING”, “ACTIVE”, “FAILED”, “DELETING”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
- Returns
The lifecycle_state of this Sdk.
- Return type
str
- property locks¶
Gets the locks of this Sdk. Locks associated with this resource.
- Returns
The locks of this Sdk.
- Return type
- property parameters¶
Gets the parameters of this Sdk. Additional optional configurations passed. The applicable config keys are listed under “parameters” when “/sdkLanguageTypes” is called.
Example: {“configName”: “configValue”}
- Returns
The parameters of this Sdk.
- Return type
dict(str, str)
- property system_tags¶
Gets the system_tags of this Sdk. 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 Sdk.
- Return type
dict(str, dict(str, object))
- property target_language¶
[Required] Gets the target_language of this Sdk. The string representing the target programming language for generating the SDK.
- Returns
The target_language of this Sdk.
- Return type
str
- property time_artifact_url_expires_at¶
Gets the time_artifact_url_expires_at of this Sdk. Expiry of artifact url.
- Returns
The time_artifact_url_expires_at of this Sdk.
- Return type
datetime
- property time_created¶
Gets the time_created of this Sdk. The time this resource was created. An RFC3339 formatted datetime string.
- Returns
The time_created of this Sdk.
- Return type
datetime
- property time_updated¶
Gets the time_updated of this Sdk. The time this resource was last updated. An RFC3339 formatted datetime string.
- Returns
The time_updated of this Sdk.
- Return type
datetime