CapacityManagementClient¶

class oci.capacity_management.CapacityManagementClient(config, **kwargs)¶

A description of the OciControlCenterCp API

Methods

`__init__`(config, **kwargs)	Creates a new service client
`create_occ_availability_catalog`(…)	Create availability catalog
`create_occ_capacity_request`(…)	Create Capacity Request.
`delete_occ_availability_catalog`(…)	Deletes the availability catalog resource.
`delete_occ_capacity_request`(…)	Deletes the capacity request resource.
`get_occ_availability_catalog`(…)	Get details about availability catalog.
`get_occ_availability_catalog_content`(…)	Returns the binary contents of the availability catalog.
`get_occ_capacity_request`(…)	Get details about the capacity request.
`get_occ_customer_group`(…)	Gets information about the specified customer group.
`list_occ_availabilities`(…)	Lists availabilities for a particular availability catalog.
`list_occ_availability_catalogs`(…)	Lists all availability catalogs.
`list_occ_availability_catalogs_internal`(…)	An internal api to list availability catalogs.
`list_occ_capacity_requests`(compartment_id, …)	Lists all capacity requests.
`list_occ_capacity_requests_internal`(…)	An internal api to list all capacity requests.
`list_occ_customer_groups`(compartment_id, …)	Lists all the customer groups.
`patch_occ_capacity_request`(…)	Updates the OccCapacityRequest by evaluating a sequence of instructions.
`publish_occ_availability_catalog`(…)	Publishes the version of availability catalog specified by the operator.
`update_internal_occ_capacity_request`(…)	The internal api to update the capacity request.
`update_occ_availability_catalog`(…)	The request to update the availability catalog.
`update_occ_capacity_request`(…)	The request to update the capacity request.

__init__(config, **kwargs)¶

Creates a new service client

Parameters:

config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
signer (AbstractBaseSigner) –
(optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument
retry_strategy (obj) –
(optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.
circuit_breaker_strategy (obj) – (optional) A circuit breaker strategy to apply to all calls made by this service client (i.e. at the client level). This client uses DEFAULT_CIRCUIT_BREAKER_STRATEGY as default if no circuit breaker strategy is provided. The specifics of circuit breaker strategy are described here.
circuit_breaker_callback (function) – (optional) Callback function to receive any exceptions triggerred by the circuit breaker.
client_level_realm_specific_endpoint_template_enabled (bool) – (optional) A boolean flag to indicate whether or not this client should be created with realm specific endpoint template enabled or disable. By default, this will be set as None.
allow_control_chars – (optional) allow_control_chars is a boolean to indicate whether or not this client should allow control characters in the response object. By default, the client will not allow control characters to be in the response object.

create_occ_availability_catalog(create_occ_availability_catalog_details, **kwargs)¶

Create availability catalog

Parameters:	create_occ_availability_catalog_details (oci.capacity_management.models.CreateOccAvailabilityCatalogDetails) – (required) The request details for creating an availability catalog. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccAvailabilityCatalog`
Return type:	`Response`
Example:

Click here to see an example of how to use create_occ_availability_catalog API.

create_occ_capacity_request(create_occ_capacity_request_details, **kwargs)¶

Create Capacity Request.

Parameters:	create_occ_capacity_request_details (oci.capacity_management.models.CreateOccCapacityRequestDetails) – (required) The request details for creating a capacity request. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccCapacityRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use create_occ_capacity_request API.

delete_occ_availability_catalog(occ_availability_catalog_id, **kwargs)¶

Deletes the availability catalog resource.

Parameters:	occ_availability_catalog_id (str) – (required) The OCID of the availability catalog. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_occ_availability_catalog API.

delete_occ_capacity_request(occ_capacity_request_id, **kwargs)¶

Deletes the capacity request resource.

Parameters:	occ_capacity_request_id (str) – (required) The OCID of the capacity request. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use delete_occ_capacity_request API.

get_occ_availability_catalog(occ_availability_catalog_id, **kwargs)¶

Get details about availability catalog.

Parameters:	occ_availability_catalog_id (str) – (required) The OCID of the availability catalog. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccAvailabilityCatalog`
Return type:	`Response`
Example:

Click here to see an example of how to use get_occ_availability_catalog API.

get_occ_availability_catalog_content(occ_availability_catalog_id, **kwargs)¶

Returns the binary contents of the availability catalog. Can be saved as a csv file.

Parameters:	occ_availability_catalog_id (str) – (required) The OCID of the availability catalog. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type stream
Return type:	`Response`
Example:

Click here to see an example of how to use get_occ_availability_catalog_content API.

get_occ_capacity_request(occ_capacity_request_id, **kwargs)¶

Get details about the capacity request.

Parameters:	occ_capacity_request_id (str) – (required) The OCID of the capacity request. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccCapacityRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use get_occ_capacity_request API.

get_occ_customer_group(occ_customer_group_id, **kwargs)¶

Gets information about the specified customer group.

Parameters:	occ_customer_group_id (str) – (required) The OCID of the customer group. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccCustomerGroup`
Return type:	`Response`
Example:

Click here to see an example of how to use get_occ_customer_group API.

list_occ_availabilities(occ_availability_catalog_id, **kwargs)¶

Lists availabilities for a particular availability catalog.

Parameters:	occ_availability_catalog_id (str) – (required) The OCID of the availability catalog. date_expected_capacity_handover (str) – (optional) The capacity handover date of the capacity constraint to filter the list of capacity constraints. resource_name (str) – (optional) The name of the resource to filter the list of capacity constraints. resource_type (str) – (optional) Resource type using which the capacity constraints of an availability catalog can be filtered. Allowed values are: “SERVER_HW”, “CAPACITY_CONSTRAINT” workload_type (str) – (optional) Workload type using the resources in an availability catalog can be filtered. Allowed values are: “GENERIC”, “ROW”, “US_PROD” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from opc-next-page header field of a previous response. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. The default order for resource name is ascending. The default order for date of capacity handover is descending. Allowed values are: “dateExpectedCapacityHandover”, “resourceName” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccAvailabilityCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_occ_availabilities API.

list_occ_availability_catalogs(compartment_id, **kwargs)¶

Lists all availability catalogs.

Parameters:	compartment_id (str) – (required) The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. namespace (str) – (optional) The namespace by which we would filter the list. Allowed values are: “COMPUTE” id (str) – (optional) The OCID of the availability catalog to filter the list of availability catalogs. display_name (str) – (optional) A filter to return only the resources that match the entire display name. The match is not case sensitive. catalog_state (str) – (optional) Filter the list of availability catalogs based on the catalog state. Allowed values are: “NOT_UPLOADED”, “UPLOAD_FAILED”, “STAGED”, “PUBLISHED”, “OUTDATED”, “DELETED” limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from opc-next-page header field of a previous response. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. The default order for displayName is ascending. The default order for timeCreated is descending. Allowed values are: “displayName”, “timeCreated” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccAvailabilityCatalogCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_occ_availability_catalogs API.

list_occ_availability_catalogs_internal(compartment_id, **kwargs)¶

An internal api to list availability catalogs.

Parameters:	compartment_id (str) – (required) The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. namespace (str) – (optional) The namespace by which we would filter the list. Allowed values are: “COMPUTE” id (str) – (optional) The OCID of the availability catalog to filter the list of availability catalogs. display_name (str) – (optional) A filter to return only the resources that match the entire display name. The match is not case sensitive. catalog_state (str) – (optional) Filter the list of availability catalogs based on the catalog state. Allowed values are: “NOT_UPLOADED”, “UPLOAD_FAILED”, “STAGED”, “PUBLISHED”, “OUTDATED”, “DELETED” occ_customer_group_id (str) – (optional) The customer group ocid by which we would filter the list. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from opc-next-page header field of a previous response. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. The default order for displayName is ascending. The default order for timeCreated is descending. Allowed values are: “displayName”, “timeCreated” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccAvailabilityCatalogCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_occ_availability_catalogs_internal API.

list_occ_capacity_requests(compartment_id, **kwargs)¶

Lists all capacity requests.

Parameters:	compartment_id (str) – (required) The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. occ_availability_catalog_id (str) – (optional) A filter to return the list of capacity requests based on the OCID of the availability catalog against which they were created. namespace (str) – (optional) The namespace by which we would filter the list. Allowed values are: “COMPUTE” display_name (str) – (optional) A filter to return only the resources that match the entire display name. The match is not case sensitive. id (str) – (optional) A filter to return the list of capacity requests based on the OCID of the capacity request. This is done for the users who have INSPECT permission on the resource but do not have READ permission. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from opc-next-page header field of a previous response. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. The default order for display name is ascending. The default order for time created is reverse chronological order(latest date at the top). Allowed values are: “displayName”, “timeCreated” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccCapacityRequestCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_occ_capacity_requests API.

list_occ_capacity_requests_internal(compartment_id, **kwargs)¶

An internal api to list all capacity requests.

Parameters:	compartment_id (str) – (required) The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. occ_customer_group_id (str) – (optional) The customer group ocid by which we would filter the list. occ_availability_catalog_id (str) – (optional) A filter to return the list of capacity requests based on the OCID of the availability catalog against which they were created. namespace (str) – (optional) The namespace by which we would filter the list. Allowed values are: “COMPUTE” display_name (str) – (optional) A filter to return only the resources that match the entire display name. The match is not case sensitive. id (str) – (optional) A filter to return the list of capacity requests based on the OCID of the capacity request. This is done for the users who have INSPECT permission on the resource but do not have READ permission. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from opc-next-page header field of a previous response. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. The default order for display name is ascending. The default order for time created is reverse chronological order(latest date at the top). Allowed values are: “displayName”, “timeCreated” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccCapacityRequestCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_occ_capacity_requests_internal API.

list_occ_customer_groups(compartment_id, **kwargs)¶

Lists all the customer groups.

Parameters:	compartment_id (str) – (required) The ocid of the compartment or tenancy in which resources are to be listed. This will also be used for authorization purposes. status (str) – (optional) A query filter to return the list result based on status. Allowed values are: “ENABLED”, “DISABLED” display_name (str) – (optional) A filter to return only the resources that match the entire display name. The match is not case sensitive. id (str) – (optional) A query filter to return the list result based on the customer group OCID. This is done for users who have INSPECT permission but do not have READ permission. limit (int) – (optional) The maximum number of items to return. page (str) – (optional) A token representing the position at which to start retrieving results. This must come from opc-next-page header field of a previous response. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. sort_order (str) – (optional) The sort order to use, either ‘ASC’ or ‘DESC’. Allowed values are: “ASC”, “DESC” sort_by (str) – (optional) The field to sort by. Only one sort order may be provided. Default order for name and compartment ID is ascending. Default order for time created is descending. Allowed values are: “compartmentId”, “name”, “timeCreated” retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccCustomerGroupCollection`
Return type:	`Response`
Example:

Click here to see an example of how to use list_occ_customer_groups API.

patch_occ_capacity_request(patch_occ_capacity_request_details, occ_capacity_request_id, **kwargs)¶

Updates the OccCapacityRequest by evaluating a sequence of instructions.

Parameters:	patch_occ_capacity_request_details (oci.capacity_management.models.PatchOccCapacityRequestDetails) – (required) Request to update the properties of the capacity request. occ_capacity_request_id (str) – (required) The OCID of the capacity request. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccCapacityRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use patch_occ_capacity_request API.

publish_occ_availability_catalog(occ_availability_catalog_id, **kwargs)¶

Publishes the version of availability catalog specified by the operator. This makes that catalog version visible to customers.

Parameters:	occ_availability_catalog_id (str) – (required) The OCID of the availability catalog. opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type None
Return type:	`Response`
Example:

Click here to see an example of how to use publish_occ_availability_catalog API.

update_internal_occ_capacity_request(update_internal_occ_capacity_request_details, occ_capacity_request_id, **kwargs)¶

The internal api to update the capacity request. This api will be used by operators for updating the capacity request to either completed, resubmitted or rejected.

Parameters:	update_internal_occ_capacity_request_details (oci.capacity_management.models.UpdateInternalOccCapacityRequestDetails) – (required) Request to update the properties of the capacity request. occ_capacity_request_id (str) – (required) The OCID of the capacity request. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccCapacityRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use update_internal_occ_capacity_request API.

update_occ_availability_catalog(update_occ_availability_catalog_details, occ_availability_catalog_id, **kwargs)¶

The request to update the availability catalog. Currently only freeform tags can be updated via this api.

Parameters:	update_occ_availability_catalog_details (oci.capacity_management.models.UpdateOccAvailabilityCatalogDetails) – (required) Request to update the properties of the availability catalog. occ_availability_catalog_id (str) – (required) The OCID of the availability catalog. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccAvailabilityCatalog`
Return type:	`Response`
Example:

Click here to see an example of how to use update_occ_availability_catalog API.

update_occ_capacity_request(update_occ_capacity_request_details, occ_capacity_request_id, **kwargs)¶

The request to update the capacity request. The user can perform actions like closing a partially completed request so that it doesn’t go ahead for full completion.

Parameters:	update_occ_capacity_request_details (oci.capacity_management.models.UpdateOccCapacityRequestDetails) – (required) Request to update the properties of the capacity request. occ_capacity_request_id (str) – (required) The OCID of the capacity request. if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value. opc_request_id (str) – (optional) The client request ID for tracing. The only valid characters for request IDs are letters, numbers, underscore, and dash. retry_strategy (obj) – (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level. This should be one of the strategies available in the `retry` module. This operation uses `DEFAULT_RETRY_STRATEGY` as default if no retry strategy is provided. The specifics of the default retry strategy are described here. To have this operation explicitly not perform any retries, pass an instance of `NoneRetryStrategy`. allow_control_chars (bool) – (optional) allow_control_chars is a boolean to indicate whether or not this request should allow control characters in the response object. By default, the response will not allow control characters in strings
Returns:	A `Response` object with data of type `OccCapacityRequest`
Return type:	`Response`
Example:

Click here to see an example of how to use update_occ_capacity_request API.