ApiMetadata¶

class oci.apiaccesscontrol.models.ApiMetadata(**kwargs)¶

Bases: object

An ApiDetail contains details such as the service it belongs to, the name of the api, the type of api, and the parameters of the api if it contains.

To use any of the API operations, you must be authorized in an IAM policy. If you’re not authorized, talk to an administrator. If you’re an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ApiMetadata.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ApiMetadata.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ApiMetadata.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ApiMetadata.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ApiMetadata.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a ApiMetadata.
`api_name`	Gets the api_name of this ApiMetadata.
`defined_tags`	Gets the defined_tags of this ApiMetadata.
`display_name`	[Required] Gets the display_name of this ApiMetadata.
`entity_type`	Gets the entity_type of this ApiMetadata.
`fields`	Gets the fields of this ApiMetadata.
`freeform_tags`	Gets the freeform_tags of this ApiMetadata.
`id`	[Required] Gets the id of this ApiMetadata.
`lifecycle_details`	Gets the lifecycle_details of this ApiMetadata.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ApiMetadata.
`path`	Gets the path of this ApiMetadata.
`service_name`	Gets the service_name of this ApiMetadata.
`system_tags`	Gets the system_tags of this ApiMetadata.
`time_created`	[Required] Gets the time_created of this ApiMetadata.
`time_deleted`	Gets the time_deleted of this ApiMetadata.
`time_updated`	Gets the time_updated of this ApiMetadata.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ApiMetadata. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ApiMetadata. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ApiMetadata. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ApiMetadata. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a ApiMetadata. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a ApiMetadata. This constant has a value of “UPDATING”

__init__(**kwargs)¶

Initializes a new ApiMetadata 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 ApiMetadata.
service_name (str) – The value to assign to the service_name property of this ApiMetadata.
display_name (str) – The value to assign to the display_name property of this ApiMetadata.
path (str) – The value to assign to the path property of this ApiMetadata.
entity_type (str) – The value to assign to the entity_type property of this ApiMetadata.
api_name (str) – The value to assign to the api_name property of this ApiMetadata.
fields (list[str]) – The value to assign to the fields property of this ApiMetadata.
time_created (datetime) – The value to assign to the time_created property of this ApiMetadata.
time_updated (datetime) – The value to assign to the time_updated property of this ApiMetadata.
time_deleted (datetime) – The value to assign to the time_deleted property of this ApiMetadata.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ApiMetadata. 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 ApiMetadata.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ApiMetadata.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ApiMetadata.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this ApiMetadata.

api_name¶

Gets the api_name of this ApiMetadata. The name of the api to execute the api request.

Returns:	The api_name of this ApiMetadata.
Return type:	str

defined_tags¶

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

display_name¶

[Required] Gets the display_name of this ApiMetadata. The operation Name of the api. The name must be unique.

Returns:	The display_name of this ApiMetadata.
Return type:	str

entity_type¶

Gets the entity_type of this ApiMetadata. ResourceType to which the apiMetadata belongs to.

Returns:	The entity_type of this ApiMetadata.
Return type:	str

fields¶

Gets the fields of this ApiMetadata. List of the fields that is use while calling post or put for the data.

Returns:	The fields of this ApiMetadata.
Return type:	list[str]

freeform_tags¶

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

id¶

[Required] Gets the id of this ApiMetadata. The OCID of the ApiDetail.

Returns:	The id of this ApiMetadata.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this ApiMetadata. A message that describes the current state of the ApiMetadata 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 ApiMetadata.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ApiMetadata. The current state of the ApiMetadata.

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 ApiMetadata.
Return type:	str

path¶

Gets the path of this ApiMetadata. rest path of the api.

Returns:	The path of this ApiMetadata.
Return type:	str

service_name¶

Gets the service_name of this ApiMetadata. The service Name to which the api belongs to.

Returns:	The service_name of this ApiMetadata.
Return type:	str

system_tags¶

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

time_created¶

[Required] Gets the time_created of this ApiMetadata. The date and time the PrivilegedApiControl was created, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_created of this ApiMetadata.
Return type:	datetime

time_deleted¶

Gets the time_deleted of this ApiMetadata. The date and time the PrivilegedApiControl was marked for delete, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_deleted of this ApiMetadata.
Return type:	datetime

time_updated¶

Gets the time_updated of this ApiMetadata. The date and time the PrivilegedApiControl was updated, in the format defined by RFC 3339.

Example: 2016-08-25T21:10:29.600Z

Returns:	The time_updated of this ApiMetadata.
Return type:	datetime