ApiMetadataSummary¶

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

Bases: object

Summary information about a ApiMetadata.

Methods

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

Attributes

`api_name`	Gets the api_name of this ApiMetadataSummary.
`attributes`	Gets the attributes of this ApiMetadataSummary.
`defined_tags`	Gets the defined_tags of this ApiMetadataSummary.
`display_name`	[Required] Gets the display_name of this ApiMetadataSummary.
`entity_type`	Gets the entity_type of this ApiMetadataSummary.
`freeform_tags`	Gets the freeform_tags of this ApiMetadataSummary.
`id`	[Required] Gets the id of this ApiMetadataSummary.
`lifecycle_details`	Gets the lifecycle_details of this ApiMetadataSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ApiMetadataSummary.
`service_name`	Gets the service_name of this ApiMetadataSummary.
`system_tags`	Gets the system_tags of this ApiMetadataSummary.
`time_created`	[Required] Gets the time_created of this ApiMetadataSummary.
`time_updated`	Gets the time_updated of this ApiMetadataSummary.

__init__(**kwargs)¶

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

api_name¶

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

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

attributes¶

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

Returns:	The attributes of this ApiMetadataSummary.
Return type:	list[str]

defined_tags¶

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

display_name¶

[Required] Gets the display_name of this ApiMetadataSummary. Name of the Api.

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

entity_type¶

Gets the entity_type of this ApiMetadataSummary. EntityType to which the apiMetadata belongs to.

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

freeform_tags¶

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

id¶

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

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

lifecycle_details¶

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

lifecycle_state¶

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

Returns:	The lifecycle_state of this ApiMetadataSummary.
Return type:	str

service_name¶

Gets the service_name of this ApiMetadataSummary. The service Name to which the Api belongs to.

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

system_tags¶

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

time_created¶

[Required] Gets the time_created of this ApiMetadataSummary. 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 ApiMetadataSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this ApiMetadataSummary. 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 ApiMetadataSummary.
Return type:	datetime