UsagePlan¶
- class oci.apigateway.models.UsagePlan(**kwargs)¶
Bases:
objectA usage plan controls access of subscribers to deployments, controlling rate limits and quotas for usage.
Attributes:
A constant which can be used with the lifecycle_state property of a UsagePlan.
A constant which can be used with the lifecycle_state property of a UsagePlan.
A constant which can be used with the lifecycle_state property of a UsagePlan.
A constant which can be used with the lifecycle_state property of a UsagePlan.
A constant which can be used with the lifecycle_state property of a UsagePlan.
A constant which can be used with the lifecycle_state property of a UsagePlan.
[Required] Gets the compartment_id of this UsagePlan.
Gets the defined_tags of this UsagePlan.
Gets the display_name of this UsagePlan.
[Required] Gets the entitlements of this UsagePlan.
Gets the freeform_tags of this UsagePlan.
[Required] Gets the id of this UsagePlan.
Gets the lifecycle_details of this UsagePlan.
[Required] Gets the lifecycle_state of this UsagePlan.
Gets the locks of this UsagePlan.
Gets the system_tags of this UsagePlan.
[Required] Gets the time_created of this UsagePlan.
[Required] Gets the time_updated of this UsagePlan.
Methods:
__init__(**kwargs)Initializes a new UsagePlan object with values from keyword arguments.
- LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶
A constant which can be used with the lifecycle_state property of a UsagePlan. This constant has a value of “ACTIVE”
- LIFECYCLE_STATE_CREATING = 'CREATING'¶
A constant which can be used with the lifecycle_state property of a UsagePlan. This constant has a value of “CREATING”
- LIFECYCLE_STATE_DELETED = 'DELETED'¶
A constant which can be used with the lifecycle_state property of a UsagePlan. This constant has a value of “DELETED”
- LIFECYCLE_STATE_DELETING = 'DELETING'¶
A constant which can be used with the lifecycle_state property of a UsagePlan. This constant has a value of “DELETING”
- LIFECYCLE_STATE_FAILED = 'FAILED'¶
A constant which can be used with the lifecycle_state property of a UsagePlan. This constant has a value of “FAILED”
- LIFECYCLE_STATE_UPDATING = 'UPDATING'¶
A constant which can be used with the lifecycle_state property of a UsagePlan. This constant has a value of “UPDATING”
- __init__(**kwargs)¶
Initializes a new UsagePlan 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 UsagePlan.
display_name (str) – The value to assign to the display_name property of this UsagePlan.
entitlements (list[oci.apigateway.models.Entitlement]) – The value to assign to the entitlements property of this UsagePlan.
compartment_id (str) – The value to assign to the compartment_id property of this UsagePlan.
time_created (datetime) – The value to assign to the time_created property of this UsagePlan.
time_updated (datetime) – The value to assign to the time_updated property of this UsagePlan.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this UsagePlan. 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 UsagePlan.
locks (list[oci.apigateway.models.ResourceLock]) – The value to assign to the locks property of this UsagePlan.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this UsagePlan.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this UsagePlan.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this UsagePlan.
- property compartment_id¶
[Required] Gets the compartment_id of this UsagePlan. The OCID of the compartment in which the resource is created.
- Returns
The compartment_id of this UsagePlan.
- Return type
str
- property defined_tags¶
Gets the defined_tags of this UsagePlan. 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 UsagePlan.
- Return type
dict(str, dict(str, object))
- property display_name¶
Gets the display_name of this UsagePlan. 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 UsagePlan.
- Return type
str
- property entitlements¶
[Required] Gets the entitlements of this UsagePlan. A collection of entitlements currently assigned to the usage plan.
- Returns
The entitlements of this UsagePlan.
- Return type
- property freeform_tags¶
Gets the freeform_tags of this UsagePlan. 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 UsagePlan.
- Return type
dict(str, str)
- property id¶
[Required] Gets the id of this UsagePlan. The OCID of a usage plan resource.
- Returns
The id of this UsagePlan.
- Return type
str
- property lifecycle_details¶
Gets the lifecycle_details of this UsagePlan. 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 UsagePlan.
- Return type
str
- property lifecycle_state¶
[Required] Gets the lifecycle_state of this UsagePlan. The current state of the usage plan.
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 UsagePlan.
- Return type
str
- property locks¶
Gets the locks of this UsagePlan. Locks associated with this resource.
- Returns
The locks of this UsagePlan.
- Return type
- property system_tags¶
Gets the system_tags of this UsagePlan. 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 UsagePlan.
- Return type
dict(str, dict(str, object))
- property time_created¶
[Required] Gets the time_created of this UsagePlan. The time this resource was created. An RFC3339 formatted datetime string.
- Returns
The time_created of this UsagePlan.
- Return type
datetime
- property time_updated¶
[Required] Gets the time_updated of this UsagePlan. The time this resource was last updated. An RFC3339 formatted datetime string.
- Returns
The time_updated of this UsagePlan.
- Return type
datetime