EntitlementSummary

class oci.apigateway.models.EntitlementSummary(**kwargs)

Bases: object

A summary of an entitlement included in a usage plan.

Methods:

__init__(**kwargs)

Initializes a new EntitlementSummary object with values from keyword arguments.

Attributes:

description

Gets the description of this EntitlementSummary.

name

[Required] Gets the name of this EntitlementSummary.

quota

Gets the quota of this EntitlementSummary.

rate_limit

Gets the rate_limit of this EntitlementSummary.

__init__(**kwargs)

Initializes a new EntitlementSummary 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 EntitlementSummary.

  • description (str) – The value to assign to the description property of this EntitlementSummary.

  • rate_limit (oci.apigateway.models.RateLimit) – The value to assign to the rate_limit property of this EntitlementSummary.

  • quota (oci.apigateway.models.Quota) – The value to assign to the quota property of this EntitlementSummary.

property description

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

Returns

The description of this EntitlementSummary.

Return type

str

property name

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

Returns

The name of this EntitlementSummary.

Return type

str

property quota

Gets the quota of this EntitlementSummary.

Returns

The quota of this EntitlementSummary.

Return type

oci.apigateway.models.Quota

property rate_limit

Gets the rate_limit of this EntitlementSummary.

Returns

The rate_limit of this EntitlementSummary.

Return type

oci.apigateway.models.RateLimit