Api

class oci.apigateway.models.Api(**kwargs)

Bases: object

An API is simple container for an API Specification. For more information, see API Gateway Concepts.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Api.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a Api.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Api.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a Api.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Api.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a Api.

compartment_id

[Required] Gets the compartment_id of this Api.

defined_tags

Gets the defined_tags of this Api.

display_name

Gets the display_name of this Api.

freeform_tags

Gets the freeform_tags of this Api.

id

[Required] Gets the id of this Api.

lifecycle_details

Gets the lifecycle_details of this Api.

lifecycle_state

Gets the lifecycle_state of this Api.

locks

Gets the locks of this Api.

specification_type

Gets the specification_type of this Api.

system_tags

Gets the system_tags of this Api.

time_created

Gets the time_created of this Api.

time_updated

Gets the time_updated of this Api.

validation_results

Gets the validation_results of this Api.

Methods:

__init__(**kwargs)

Initializes a new Api object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Api. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Api. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Api. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Api. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Api. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Api. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new Api 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 Api.

  • display_name (str) – The value to assign to the display_name property of this Api.

  • compartment_id (str) – The value to assign to the compartment_id property of this Api.

  • time_created (datetime) – The value to assign to the time_created property of this Api.

  • time_updated (datetime) – The value to assign to the time_updated property of this Api.

  • locks (list[oci.apigateway.models.ResourceLock]) – The value to assign to the locks property of this Api.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Api. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “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 Api.

  • specification_type (str) – The value to assign to the specification_type property of this Api.

  • validation_results (list[oci.apigateway.models.ApiValidationResult]) – The value to assign to the validation_results property of this Api.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Api.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Api.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Api.

property compartment_id

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

Returns

The compartment_id of this Api.

Return type

str

property defined_tags

Gets the defined_tags of this Api. 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 Api.

Return type

dict(str, dict(str, object))

property display_name

Gets the display_name of this Api. 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 Api.

Return type

str

property freeform_tags

Gets the freeform_tags of this Api. 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 Api.

Return type

dict(str, str)

property id

[Required] Gets the id of this Api. The OCID of the resource.

Returns

The id of this Api.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this Api. A message describing the current lifecycleState in more detail. For ACTIVE state it describes if the document has been validated and the possible values are: - ‘New’ for just updated API Specifications - ‘Validating’ for a document which is being validated. - ‘Valid’ the document has been validated without any errors or warnings - ‘Warning’ the document has been validated and contains warnings - ‘Error’ the document has been validated and contains errors - ‘Failed’ the document validation failed - ‘Canceled’ the document validation was canceled

For other states it may provide more details like actionable information.

Returns

The lifecycle_details of this Api.

Return type

str

property lifecycle_state

Gets the lifecycle_state of this Api. The current state of the API.

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “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 Api.

Return type

str

property locks

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

Returns

The locks of this Api.

Return type

list[oci.apigateway.models.ResourceLock]

property specification_type

Gets the specification_type of this Api. Type of API Specification file.

Returns

The specification_type of this Api.

Return type

str

property system_tags

Gets the system_tags of this Api. 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 Api.

Return type

dict(str, dict(str, object))

property time_created

Gets the time_created of this Api. The time this resource was created. An RFC3339 formatted datetime string.

Returns

The time_created of this Api.

Return type

datetime

property time_updated

Gets the time_updated of this Api. The time this resource was last updated. An RFC3339 formatted datetime string.

Returns

The time_updated of this Api.

Return type

datetime

property validation_results

Gets the validation_results of this Api. Status of each feature available from the API.

Returns

The validation_results of this Api.

Return type

list[oci.apigateway.models.ApiValidationResult]