CreateApiDetails¶

class oci.apigateway.models.CreateApiDetails(**kwargs)¶

Bases: object

Information about the new API.

Methods

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

Attributes

`compartment_id`	[Required] Gets the compartment_id of this CreateApiDetails.
`content`	Gets the content of this CreateApiDetails.
`defined_tags`	Gets the defined_tags of this CreateApiDetails.
`display_name`	Gets the display_name of this CreateApiDetails.
`freeform_tags`	Gets the freeform_tags of this CreateApiDetails.
`locks`	Gets the locks of this CreateApiDetails.

__init__(**kwargs)¶

Initializes a new CreateApiDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this CreateApiDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateApiDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateApiDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateApiDetails.
locks (list[oci.apigateway.models.AddResourceLockDetails]) – The value to assign to the locks property of this CreateApiDetails.
content (str) – The value to assign to the content property of this CreateApiDetails.

compartment_id¶

[Required] Gets the compartment_id of this CreateApiDetails. The OCID of the compartment in which the resource is created.

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

content¶

Gets the content of this CreateApiDetails. API Specification content in json or yaml format

Returns:	The content of this CreateApiDetails.
Return type:	str

defined_tags¶

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

display_name¶

Gets the display_name of this CreateApiDetails. 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 CreateApiDetails.
Return type:	str

freeform_tags¶

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

locks¶

Gets the locks of this CreateApiDetails. Locks associated with this resource.

Returns:	The locks of this CreateApiDetails.
Return type:	list[oci.apigateway.models.AddResourceLockDetails]