UsagePlan class
Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.
In a usage plan, you associate an API by specifying the API's Id and a stage
name of the specified API. You add plan customers by adding API keys to the
plan.
Constructors
-
UsagePlan({List<
ApiStage> ? apiStages, String? description, String? id, String? name, String? productCode, QuotaSettings? quota, Map<String, String> ? tags, ThrottleSettings? throttle}) -
UsagePlan.fromJson(Map<
String, dynamic> json) -
factory
Properties
-
apiStages
→ List<
ApiStage> ? -
The associated API stages of a usage plan.
final
- description → String?
-
The description of a usage plan.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String?
-
The identifier of a UsagePlan resource.
final
- name → String?
-
The name of a usage plan.
final
- productCode → String?
-
The AWS Markeplace product identifier to associate with the usage plan as a
SaaS product on AWS Marketplace.
final
- quota → QuotaSettings?
-
The maximum number of permitted requests per a given unit time interval.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
The collection of tags. Each tag element is associated with a given
resource.
final
- throttle → ThrottleSettings?
-
The request throttle limits of a usage plan.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited