CreateUsagePlanDetails

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

Bases: object

Information about a new usage plan.

Methods:

__init__(**kwargs)

Initializes a new CreateUsagePlanDetails object with values from keyword arguments.

Attributes:

compartment_id

[Required] Gets the compartment_id of this CreateUsagePlanDetails.

defined_tags

Gets the defined_tags of this CreateUsagePlanDetails.

display_name

Gets the display_name of this CreateUsagePlanDetails.

entitlements

[Required] Gets the entitlements of this CreateUsagePlanDetails.

freeform_tags

Gets the freeform_tags of this CreateUsagePlanDetails.

locks

Gets the locks of this CreateUsagePlanDetails.

__init__(**kwargs)

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

Parameters
  • display_name (str) – The value to assign to the display_name property of this CreateUsagePlanDetails.

  • entitlements (list[oci.apigateway.models.Entitlement]) – The value to assign to the entitlements property of this CreateUsagePlanDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this CreateUsagePlanDetails.

  • locks (list[oci.apigateway.models.AddResourceLockDetails]) – The value to assign to the locks property of this CreateUsagePlanDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateUsagePlanDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateUsagePlanDetails.

property compartment_id

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

Returns

The compartment_id of this CreateUsagePlanDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateUsagePlanDetails. 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 CreateUsagePlanDetails.

Return type

dict(str, dict(str, object))

property display_name

Gets the display_name of this CreateUsagePlanDetails. 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 CreateUsagePlanDetails.

Return type

str

property entitlements

[Required] Gets the entitlements of this CreateUsagePlanDetails. A collection of entitlements to assign to the newly created usage plan.

Returns

The entitlements of this CreateUsagePlanDetails.

Return type

list[oci.apigateway.models.Entitlement]

property freeform_tags

Gets the freeform_tags of this CreateUsagePlanDetails. 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 CreateUsagePlanDetails.

Return type

dict(str, str)

property locks

Gets the locks of this CreateUsagePlanDetails. Locks associated with this resource.

Returns

The locks of this CreateUsagePlanDetails.

Return type

list[oci.apigateway.models.AddResourceLockDetails]