OccCustomerGroup¶

class oci.capacity_management.models.OccCustomerGroup(**kwargs)¶

Bases: object

Details of the customer group resource.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OccCustomerGroup.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OccCustomerGroup.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OccCustomerGroup.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OccCustomerGroup.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OccCustomerGroup.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OccCustomerGroup.
`STATUS_DISABLED`	A constant which can be used with the status property of a OccCustomerGroup.
`STATUS_ENABLED`	A constant which can be used with the status property of a OccCustomerGroup.
`compartment_id`	[Required] Gets the compartment_id of this OccCustomerGroup.
`customers_list`	[Required] Gets the customers_list of this OccCustomerGroup.
`defined_tags`	Gets the defined_tags of this OccCustomerGroup.
`description`	Gets the description of this OccCustomerGroup.
`display_name`	[Required] Gets the display_name of this OccCustomerGroup.
`freeform_tags`	Gets the freeform_tags of this OccCustomerGroup.
`id`	[Required] Gets the id of this OccCustomerGroup.
`lifecycle_details`	Gets the lifecycle_details of this OccCustomerGroup.
`lifecycle_state`	[Required] Gets the lifecycle_state of this OccCustomerGroup.
`status`	[Required] Gets the status of this OccCustomerGroup.
`system_tags`	Gets the system_tags of this OccCustomerGroup.
`time_created`	Gets the time_created of this OccCustomerGroup.
`time_updated`	Gets the time_updated of this OccCustomerGroup.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a OccCustomerGroup. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a OccCustomerGroup. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a OccCustomerGroup. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a OccCustomerGroup. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a OccCustomerGroup. This constant has a value of “FAILED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a OccCustomerGroup. This constant has a value of “UPDATING”

STATUS_DISABLED = 'DISABLED'¶: A constant which can be used with the status property of a OccCustomerGroup. This constant has a value of “DISABLED”

STATUS_ENABLED = 'ENABLED'¶: A constant which can be used with the status property of a OccCustomerGroup. This constant has a value of “ENABLED”

__init__(**kwargs)¶

Initializes a new OccCustomerGroup 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 OccCustomerGroup.
compartment_id (str) – The value to assign to the compartment_id property of this OccCustomerGroup.
display_name (str) – The value to assign to the display_name property of this OccCustomerGroup.
description (str) – The value to assign to the description property of this OccCustomerGroup.
time_created (datetime) – The value to assign to the time_created property of this OccCustomerGroup.
time_updated (datetime) – The value to assign to the time_updated property of this OccCustomerGroup.
status (str) – The value to assign to the status property of this OccCustomerGroup. Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OccCustomerGroup. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 OccCustomerGroup.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OccCustomerGroup.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OccCustomerGroup.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OccCustomerGroup.
customers_list (list[oci.capacity_management.models.OccCustomer]) – The value to assign to the customers_list property of this OccCustomerGroup.

compartment_id¶

[Required] Gets the compartment_id of this OccCustomerGroup. The OCID of the tenancy containing the customer group.

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

customers_list¶

[Required] Gets the customers_list of this OccCustomerGroup. A list containing all the customers that belong to this customer group

Returns:	The customers_list of this OccCustomerGroup.
Return type:	list[oci.capacity_management.models.OccCustomer]

defined_tags¶

Gets the defined_tags of this OccCustomerGroup. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this OccCustomerGroup.
Return type:	dict(str, dict(str, object))

description¶

Gets the description of this OccCustomerGroup. The description about the customer group.

Returns:	The description of this OccCustomerGroup.
Return type:	str

display_name¶

[Required] Gets the display_name of this OccCustomerGroup. The display name of the customer group.

Returns:	The display_name of this OccCustomerGroup.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this OccCustomerGroup. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this OccCustomerGroup.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this OccCustomerGroup. The OCID of the customer group.

Returns:	The id of this OccCustomerGroup.
Return type:	str

lifecycle_details¶

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this OccCustomerGroup. The current lifecycle state of the resource.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “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 OccCustomerGroup.
Return type:	str

status¶

[Required] Gets the status of this OccCustomerGroup. To determine whether the customer group is enabled/disabled.

Allowed values for this property are: “ENABLED”, “DISABLED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this OccCustomerGroup.
Return type:	str

system_tags¶

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

time_created¶

Gets the time_created of this OccCustomerGroup. The time when the customer group was created.

Returns:	The time_created of this OccCustomerGroup.
Return type:	datetime

time_updated¶

Gets the time_updated of this OccCustomerGroup. The time when the customer group was last updated.

Returns:	The time_updated of this OccCustomerGroup.
Return type:	datetime