UsagePlanSummary¶

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

Bases: object

A summary of the usage plan.

Methods

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

Attributes

`compartment_id`	[Required] Gets the compartment_id of this UsagePlanSummary.
`defined_tags`	Gets the defined_tags of this UsagePlanSummary.
`display_name`	Gets the display_name of this UsagePlanSummary.
`entitlements`	[Required] Gets the entitlements of this UsagePlanSummary.
`freeform_tags`	Gets the freeform_tags of this UsagePlanSummary.
`id`	[Required] Gets the id of this UsagePlanSummary.
`lifecycle_details`	Gets the lifecycle_details of this UsagePlanSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this UsagePlanSummary.
`time_created`	[Required] Gets the time_created of this UsagePlanSummary.
`time_updated`	[Required] Gets the time_updated of this UsagePlanSummary.

__init__(**kwargs)¶

Initializes a new UsagePlanSummary 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 UsagePlanSummary.
display_name (str) – The value to assign to the display_name property of this UsagePlanSummary.
entitlements (list[oci.apigateway.models.EntitlementSummary]) – The value to assign to the entitlements property of this UsagePlanSummary.
compartment_id (str) – The value to assign to the compartment_id property of this UsagePlanSummary.
time_created (datetime) – The value to assign to the time_created property of this UsagePlanSummary.
time_updated (datetime) – The value to assign to the time_updated property of this UsagePlanSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this UsagePlanSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this UsagePlanSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UsagePlanSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UsagePlanSummary.

compartment_id¶

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

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

defined_tags¶

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

display_name¶

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

entitlements¶

[Required] Gets the entitlements of this UsagePlanSummary. A collection of entitlements applied by the usage plan.

Returns:	The entitlements of this UsagePlanSummary.
Return type:	list[oci.apigateway.models.EntitlementSummary]

freeform_tags¶

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

id¶

[Required] Gets the id of this UsagePlanSummary. The OCID of a usage plan resource.

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

lifecycle_details¶

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this UsagePlanSummary. The current state of the usage plan.

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

time_created¶

[Required] Gets the time_created of this UsagePlanSummary. The time this resource was created. An RFC3339 formatted datetime string.

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

time_updated¶

[Required] Gets the time_updated of this UsagePlanSummary. The time this resource was last updated. An RFC3339 formatted datetime string.

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