CreateSubscriberDetails¶

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

Bases: object

Information about a new subscriber.

Methods

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

Attributes

`clients`	[Required] Gets the clients of this CreateSubscriberDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateSubscriberDetails.
`defined_tags`	Gets the defined_tags of this CreateSubscriberDetails.
`display_name`	Gets the display_name of this CreateSubscriberDetails.
`freeform_tags`	Gets the freeform_tags of this CreateSubscriberDetails.
`usage_plans`	[Required] Gets the usage_plans of this CreateSubscriberDetails.

__init__(**kwargs)¶

Initializes a new CreateSubscriberDetails 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 CreateSubscriberDetails.
compartment_id (str) – The value to assign to the compartment_id property of this CreateSubscriberDetails.
clients (list[oci.apigateway.models.Client]) – The value to assign to the clients property of this CreateSubscriberDetails.
usage_plans (list[str]) – The value to assign to the usage_plans property of this CreateSubscriberDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateSubscriberDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateSubscriberDetails.

clients¶

[Required] Gets the clients of this CreateSubscriberDetails. The clients belonging to this subscriber.

Returns:	The clients of this CreateSubscriberDetails.
Return type:	list[oci.apigateway.models.Client]

compartment_id¶

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

Returns:	The compartment_id of this CreateSubscriberDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateSubscriberDetails. 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 CreateSubscriberDetails.
Return type:	dict(str, dict(str, object))

display_name¶

Gets the display_name of this CreateSubscriberDetails. 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 CreateSubscriberDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateSubscriberDetails. 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 CreateSubscriberDetails.
Return type:	dict(str, str)

usage_plans¶

[Required] Gets the usage_plans of this CreateSubscriberDetails. An array of `OCID`__s of usage plan resources.

Returns:	The usage_plans of this CreateSubscriberDetails.
Return type:	list[str]