CreateOccCustomerGroupDetails¶

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

Bases: object

Details about the create request for the customer group.

Attributes

`STATUS_DISABLED`	A constant which can be used with the status property of a CreateOccCustomerGroupDetails.
`STATUS_ENABLED`	A constant which can be used with the status property of a CreateOccCustomerGroupDetails.
`compartment_id`	[Required] Gets the compartment_id of this CreateOccCustomerGroupDetails.
`customers_list`	Gets the customers_list of this CreateOccCustomerGroupDetails.
`defined_tags`	Gets the defined_tags of this CreateOccCustomerGroupDetails.
`description`	Gets the description of this CreateOccCustomerGroupDetails.
`display_name`	[Required] Gets the display_name of this CreateOccCustomerGroupDetails.
`freeform_tags`	Gets the freeform_tags of this CreateOccCustomerGroupDetails.
`lifecycle_details`	Gets the lifecycle_details of this CreateOccCustomerGroupDetails.
`status`	Gets the status of this CreateOccCustomerGroupDetails.

Methods

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

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

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

__init__(**kwargs)¶

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

Parameters:

compartment_id (str) – The value to assign to the compartment_id property of this CreateOccCustomerGroupDetails.
display_name (str) – The value to assign to the display_name property of this CreateOccCustomerGroupDetails.
description (str) – The value to assign to the description property of this CreateOccCustomerGroupDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateOccCustomerGroupDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateOccCustomerGroupDetails.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this CreateOccCustomerGroupDetails.
status (str) – The value to assign to the status property of this CreateOccCustomerGroupDetails. Allowed values for this property are: “ENABLED”, “DISABLED”
customers_list (list[oci.capacity_management.models.CreateOccCustomerDetails]) – The value to assign to the customers_list property of this CreateOccCustomerGroupDetails.

compartment_id¶

[Required] Gets the compartment_id of this CreateOccCustomerGroupDetails. Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.

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

customers_list¶

Gets the customers_list of this CreateOccCustomerGroupDetails. A list containing all the customers that belong to this customer group.

Returns:	The customers_list of this CreateOccCustomerGroupDetails.
Return type:	list[oci.capacity_management.models.CreateOccCustomerDetails]

defined_tags¶

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

description¶

Gets the description of this CreateOccCustomerGroupDetails. A description about the customer group.

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

display_name¶

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

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

freeform_tags¶

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

lifecycle_details¶

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

status¶

Gets the status of this CreateOccCustomerGroupDetails. To determine whether the customer group is enabled/disabled.

Allowed values for this property are: “ENABLED”, “DISABLED”

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