SubscriberSummary

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

Bases: object

A summary of a subscriber.

Methods:

__init__(**kwargs)

Initializes a new SubscriberSummary object with values from keyword arguments.

Attributes:

clients

[Required] Gets the clients of this SubscriberSummary.

compartment_id

[Required] Gets the compartment_id of this SubscriberSummary.

defined_tags

Gets the defined_tags of this SubscriberSummary.

display_name

Gets the display_name of this SubscriberSummary.

freeform_tags

Gets the freeform_tags of this SubscriberSummary.

id

[Required] Gets the id of this SubscriberSummary.

lifecycle_details

Gets the lifecycle_details of this SubscriberSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this SubscriberSummary.

locks

Gets the locks of this SubscriberSummary.

system_tags

Gets the system_tags of this SubscriberSummary.

time_created

[Required] Gets the time_created of this SubscriberSummary.

time_updated

[Required] Gets the time_updated of this SubscriberSummary.

usage_plans

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

__init__(**kwargs)

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

Parameters
  • id (str) – The value to assign to the id property of this SubscriberSummary.

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

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

  • clients (list[oci.apigateway.models.ClientSummary]) – The value to assign to the clients property of this SubscriberSummary.

  • usage_plans (list[str]) – The value to assign to the usage_plans property of this SubscriberSummary.

  • time_created (datetime) – The value to assign to the time_created property of this SubscriberSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this SubscriberSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this SubscriberSummary.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this SubscriberSummary.

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

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

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

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

property clients

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

Returns

The clients of this SubscriberSummary.

Return type

list[oci.apigateway.models.ClientSummary]

property compartment_id

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

Returns

The compartment_id of this SubscriberSummary.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property display_name

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

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

[Required] Gets the id of this SubscriberSummary. The `OCID`__ of the resource.

Returns

The id of this SubscriberSummary.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this SubscriberSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed state.

Returns

The lifecycle_details of this SubscriberSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this SubscriberSummary. The current state of the subscriber.

Returns

The lifecycle_state of this SubscriberSummary.

Return type

str

property locks

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

Returns

The locks of this SubscriberSummary.

Return type

list[oci.apigateway.models.ResourceLock]

property system_tags

Gets the system_tags of this SubscriberSummary. System tags for this resource. Each key is predefined and scoped to a namespace. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this SubscriberSummary.

Return type

dict(str, dict(str, object))

property time_created

[Required] Gets the time_created of this SubscriberSummary. The time this resource was created. An RFC3339 formatted datetime string.

Returns

The time_created of this SubscriberSummary.

Return type

datetime

property time_updated

[Required] Gets the time_updated of this SubscriberSummary. The time this resource was last updated. An RFC3339 formatted datetime string.

Returns

The time_updated of this SubscriberSummary.

Return type

datetime

property usage_plans

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

Returns

The usage_plans of this SubscriberSummary.

Return type

list[str]