Entitlement¶

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

Bases: object

A usage plan entitlement, comprising of rate limits, quotas and the deployments they are applied to.

Methods

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

Attributes

`description`	Gets the description of this Entitlement.
`name`	[Required] Gets the name of this Entitlement.
`quota`	Gets the quota of this Entitlement.
`rate_limit`	Gets the rate_limit of this Entitlement.
`targets`	Gets the targets of this Entitlement.

__init__(**kwargs)¶

Initializes a new Entitlement object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

name (str) – The value to assign to the name property of this Entitlement.
description (str) – The value to assign to the description property of this Entitlement.
rate_limit (oci.apigateway.models.RateLimit) – The value to assign to the rate_limit property of this Entitlement.
quota (oci.apigateway.models.Quota) – The value to assign to the quota property of this Entitlement.
targets (list[oci.apigateway.models.EntitlementTarget]) – The value to assign to the targets property of this Entitlement.

description¶

Gets the description of this Entitlement. A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.

Returns:	The description of this Entitlement.
Return type:	str

name¶

[Required] Gets the name of this Entitlement. An entitlement name, unique within a usage plan.

Returns:	The name of this Entitlement.
Return type:	str

quota¶

Gets the quota of this Entitlement.

Returns:	The quota of this Entitlement.
Return type:	oci.apigateway.models.Quota

rate_limit¶

Gets the rate_limit of this Entitlement.

Returns:	The rate_limit of this Entitlement.
Return type:	oci.apigateway.models.RateLimit

targets¶

Gets the targets of this Entitlement. A collection of targeted deployments that the entitlement will be applied to.

Returns:	The targets of this Entitlement.
Return type:	list[oci.apigateway.models.EntitlementTarget]