Subscriber

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

Bases: object

A subscriber, which encapsulates a number of clients and usage plans that they are subscribed to.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Subscriber.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a Subscriber.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Subscriber.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a Subscriber.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Subscriber.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a Subscriber.

clients

[Required] Gets the clients of this Subscriber.

compartment_id

[Required] Gets the compartment_id of this Subscriber.

defined_tags

Gets the defined_tags of this Subscriber.

display_name

Gets the display_name of this Subscriber.

freeform_tags

Gets the freeform_tags of this Subscriber.

id

[Required] Gets the id of this Subscriber.

lifecycle_details

Gets the lifecycle_details of this Subscriber.

lifecycle_state

[Required] Gets the lifecycle_state of this Subscriber.

locks

Gets the locks of this Subscriber.

system_tags

Gets the system_tags of this Subscriber.

time_created

[Required] Gets the time_created of this Subscriber.

time_updated

[Required] Gets the time_updated of this Subscriber.

usage_plans

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

Methods:

__init__(**kwargs)

Initializes a new Subscriber object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Subscriber. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Subscriber. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Subscriber. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Subscriber. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Subscriber. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Subscriber. This constant has a value of “UPDATING”

__init__(**kwargs)

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

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

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

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

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

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

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

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Subscriber. Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

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

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

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

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

property clients

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

Returns

The clients of this Subscriber.

Return type

list[oci.apigateway.models.Client]

property compartment_id

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

Returns

The compartment_id of this Subscriber.

Return type

str

property defined_tags

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

Return type

dict(str, dict(str, object))

property display_name

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

Return type

str

property freeform_tags

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

Return type

dict(str, str)

property id

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

Returns

The id of this Subscriber.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this Subscriber. 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 Subscriber.

Return type

str

property lifecycle_state

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

Allowed values for this property are: “CREATING”, “ACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this Subscriber.

Return type

str

property locks

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

Returns

The locks of this Subscriber.

Return type

list[oci.apigateway.models.ResourceLock]

property system_tags

Gets the system_tags of this Subscriber. 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 Subscriber.

Return type

dict(str, dict(str, object))

property time_created

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

Returns

The time_created of this Subscriber.

Return type

datetime

property time_updated

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

Returns

The time_updated of this Subscriber.

Return type

datetime

property usage_plans

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

Returns

The usage_plans of this Subscriber.

Return type

list[str]