OccCapacityRequest¶

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

Bases: object

A single request of some quantity of a specific server type, in a specific location and expected delivery date. The maximum amount possible to request is the smallest number between the number of servers available for purchase and the number of servers allowed by the constraints (For example, power, network, physical space, and so on).

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a OccCapacityRequest.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a OccCapacityRequest.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a OccCapacityRequest.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a OccCapacityRequest.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a OccCapacityRequest.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a OccCapacityRequest.
`NAMESPACE_COMPUTE`	A constant which can be used with the namespace property of a OccCapacityRequest.
`REQUEST_STATE_CANCELLED`	A constant which can be used with the request_state property of a OccCapacityRequest.
`REQUEST_STATE_COMPLETED`	A constant which can be used with the request_state property of a OccCapacityRequest.
`REQUEST_STATE_CREATED`	A constant which can be used with the request_state property of a OccCapacityRequest.
`REQUEST_STATE_DELETED`	A constant which can be used with the request_state property of a OccCapacityRequest.
`REQUEST_STATE_IN_PROGRESS`	A constant which can be used with the request_state property of a OccCapacityRequest.
`REQUEST_STATE_PARTIALLY_COMPLETED`	A constant which can be used with the request_state property of a OccCapacityRequest.
`REQUEST_STATE_REJECTED`	A constant which can be used with the request_state property of a OccCapacityRequest.
`REQUEST_STATE_SUBMITTED`	A constant which can be used with the request_state property of a OccCapacityRequest.
`REQUEST_TYPE_NEW`	A constant which can be used with the request_type property of a OccCapacityRequest.
`REQUEST_TYPE_TRANSFER`	A constant which can be used with the request_type property of a OccCapacityRequest.
`availability_domain`	[Required] Gets the availability_domain of this OccCapacityRequest.
`compartment_id`	[Required] Gets the compartment_id of this OccCapacityRequest.
`date_expected_capacity_handover`	[Required] Gets the date_expected_capacity_handover of this OccCapacityRequest.
`defined_tags`	Gets the defined_tags of this OccCapacityRequest.
`description`	Gets the description of this OccCapacityRequest.
`details`	[Required] Gets the details of this OccCapacityRequest.
`display_name`	[Required] Gets the display_name of this OccCapacityRequest.
`freeform_tags`	Gets the freeform_tags of this OccCapacityRequest.
`id`	[Required] Gets the id of this OccCapacityRequest.
`lifecycle_details`	Gets the lifecycle_details of this OccCapacityRequest.
`lifecycle_state`	[Required] Gets the lifecycle_state of this OccCapacityRequest.
`namespace`	[Required] Gets the namespace of this OccCapacityRequest.
`occ_availability_catalog_id`	[Required] Gets the occ_availability_catalog_id of this OccCapacityRequest.
`occ_customer_group_id`	[Required] Gets the occ_customer_group_id of this OccCapacityRequest.
`region`	[Required] Gets the region of this OccCapacityRequest.
`request_state`	[Required] Gets the request_state of this OccCapacityRequest.
`request_type`	Gets the request_type of this OccCapacityRequest.
`system_tags`	Gets the system_tags of this OccCapacityRequest.
`time_created`	[Required] Gets the time_created of this OccCapacityRequest.
`time_updated`	[Required] Gets the time_updated of this OccCapacityRequest.

Methods

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

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

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

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

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

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

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

NAMESPACE_COMPUTE = 'COMPUTE'¶: A constant which can be used with the namespace property of a OccCapacityRequest. This constant has a value of “COMPUTE”

REQUEST_STATE_CANCELLED = 'CANCELLED'¶: A constant which can be used with the request_state property of a OccCapacityRequest. This constant has a value of “CANCELLED”

REQUEST_STATE_COMPLETED = 'COMPLETED'¶: A constant which can be used with the request_state property of a OccCapacityRequest. This constant has a value of “COMPLETED”

REQUEST_STATE_CREATED = 'CREATED'¶: A constant which can be used with the request_state property of a OccCapacityRequest. This constant has a value of “CREATED”

REQUEST_STATE_DELETED = 'DELETED'¶: A constant which can be used with the request_state property of a OccCapacityRequest. This constant has a value of “DELETED”

REQUEST_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the request_state property of a OccCapacityRequest. This constant has a value of “IN_PROGRESS”

REQUEST_STATE_PARTIALLY_COMPLETED = 'PARTIALLY_COMPLETED'¶: A constant which can be used with the request_state property of a OccCapacityRequest. This constant has a value of “PARTIALLY_COMPLETED”

REQUEST_STATE_REJECTED = 'REJECTED'¶: A constant which can be used with the request_state property of a OccCapacityRequest. This constant has a value of “REJECTED”

REQUEST_STATE_SUBMITTED = 'SUBMITTED'¶: A constant which can be used with the request_state property of a OccCapacityRequest. This constant has a value of “SUBMITTED”

REQUEST_TYPE_NEW = 'NEW'¶: A constant which can be used with the request_type property of a OccCapacityRequest. This constant has a value of “NEW”

REQUEST_TYPE_TRANSFER = 'TRANSFER'¶: A constant which can be used with the request_type property of a OccCapacityRequest. This constant has a value of “TRANSFER”

__init__(**kwargs)¶

Initializes a new OccCapacityRequest 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 OccCapacityRequest.
compartment_id (str) – The value to assign to the compartment_id property of this OccCapacityRequest.
occ_availability_catalog_id (str) – The value to assign to the occ_availability_catalog_id property of this OccCapacityRequest.
display_name (str) – The value to assign to the display_name property of this OccCapacityRequest.
description (str) – The value to assign to the description property of this OccCapacityRequest.
namespace (str) – The value to assign to the namespace property of this OccCapacityRequest. Allowed values for this property are: “COMPUTE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
occ_customer_group_id (str) – The value to assign to the occ_customer_group_id property of this OccCapacityRequest.
request_type (str) – The value to assign to the request_type property of this OccCapacityRequest. Allowed values for this property are: “NEW”, “TRANSFER”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
region (str) – The value to assign to the region property of this OccCapacityRequest.
availability_domain (str) – The value to assign to the availability_domain property of this OccCapacityRequest.
date_expected_capacity_handover (datetime) – The value to assign to the date_expected_capacity_handover property of this OccCapacityRequest.
request_state (str) – The value to assign to the request_state property of this OccCapacityRequest. Allowed values for this property are: “CREATED”, “SUBMITTED”, “REJECTED”, “IN_PROGRESS”, “COMPLETED”, “PARTIALLY_COMPLETED”, “CANCELLED”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_created (datetime) – The value to assign to the time_created property of this OccCapacityRequest.
time_updated (datetime) – The value to assign to the time_updated property of this OccCapacityRequest.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this OccCapacityRequest. 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 OccCapacityRequest.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this OccCapacityRequest.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this OccCapacityRequest.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this OccCapacityRequest.
details (list[oci.capacity_management.models.OccCapacityRequestBaseDetails]) – The value to assign to the details property of this OccCapacityRequest.

availability_domain¶

[Required] Gets the availability_domain of this OccCapacityRequest. The availability domain (AD) for which the capacity request was made.

Returns:	The availability_domain of this OccCapacityRequest.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this OccCapacityRequest. The OCID of the tenancy from which the request was made.

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

date_expected_capacity_handover¶

[Required] Gets the date_expected_capacity_handover of this OccCapacityRequest. The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.

Returns:	The date_expected_capacity_handover of this OccCapacityRequest.
Return type:	datetime

defined_tags¶

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

description¶

Gets the description of this OccCapacityRequest. Meaningful text about the capacity request.

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

details¶

[Required] Gets the details of this OccCapacityRequest. A list of resources requested as part of this request

Returns:	The details of this OccCapacityRequest.
Return type:	list[oci.capacity_management.models.OccCapacityRequestBaseDetails]

display_name¶

[Required] Gets the display_name of this OccCapacityRequest. The display name of the capacity request.

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

freeform_tags¶

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

id¶

[Required] Gets the id of this OccCapacityRequest. The OCID of the capacity request.

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

lifecycle_details¶

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this OccCapacityRequest. 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 OccCapacityRequest.
Return type:	str

namespace¶

[Required] Gets the namespace of this OccCapacityRequest. The name of the OCI service in consideration. For example, Compute, Exadata, and so on.

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

Returns:	The namespace of this OccCapacityRequest.
Return type:	str

occ_availability_catalog_id¶

[Required] Gets the occ_availability_catalog_id of this OccCapacityRequest. The OCID of the availability catalog against which the capacity request was placed.

Returns:	The occ_availability_catalog_id of this OccCapacityRequest.
Return type:	str

occ_customer_group_id¶

[Required] Gets the occ_customer_group_id of this OccCapacityRequest. The OCID of the customer group to which this customer belongs to.

Returns:	The occ_customer_group_id of this OccCapacityRequest.
Return type:	str

region¶

[Required] Gets the region of this OccCapacityRequest. The name of the region for which the capacity request was made.

Returns:	The region of this OccCapacityRequest.
Return type:	str

request_state¶

[Required] Gets the request_state of this OccCapacityRequest. The different states the capacity request goes through.

Allowed values for this property are: “CREATED”, “SUBMITTED”, “REJECTED”, “IN_PROGRESS”, “COMPLETED”, “PARTIALLY_COMPLETED”, “CANCELLED”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The request_state of this OccCapacityRequest.
Return type:	str

request_type¶

Gets the request_type of this OccCapacityRequest. Type of Capacity Request(New or Transfer)

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

Returns:	The request_type of this OccCapacityRequest.
Return type:	str

system_tags¶

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

time_created¶

[Required] Gets the time_created of this OccCapacityRequest. The time when the capacity request was created.

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

time_updated¶

[Required] Gets the time_updated of this OccCapacityRequest. The time when the capacity request was updated.

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