DemandSignalClient¶

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

OCI Control Center (OCC) Capacity Management enables you to manage capacity requests in realms where OCI Control Center Capacity Management is available. For more information, see [OCI Control Center](/iaas/Content/control-center/home.htm).

Methods

`__init__`(config, **kwargs)	Creates a new service client
`bulk_create_occm_demand_signal_item`(…)	This API will help in bulk creation of demand signal items.
`create_occm_demand_signal`(…)	This is a post API to create occm demand signal.
`create_occm_demand_signal_item`(…)	This API will create a demand signal item representing a resource request.
`delete_occm_demand_signal`(…)	This is a DELETE API which deletes a demand signal with the provided demand signal ocid.
`delete_occm_demand_signal_item`(…)	This is a DELETE API which deletes a demand signal item with the provided demand signal item ocid.
`get_occm_demand_signal`(…)	This is a GET API which gets the detailed information about a specific demand signal.
`get_occm_demand_signal_item`(…)	This is a GET API to get the details of a demand signal item resource representing the details of the resource demanded by you.
`list_occm_demand_signal_catalog_resources`(…)	This API will list all the resources across all demand signal catalogs for a given namespace and customer group containing the caller compartment.
`list_occm_demand_signal_deliveries`(…)	This GET call is used to list all demand signals delivery resources within the compartment passed as a query param.
`list_occm_demand_signal_items`(…)	This API will list the detailed information about the resources demanded as part of the demand signal.
`list_occm_demand_signals`(compartment_id, …)	This GET call is used to list all demand signals within the compartment passed as a query parameter.
`update_occm_demand_signal`(…)	This is a PUT API which shall be used to update the metadata of the demand signal.
`update_occm_demand_signal_item`(…)	This is a PUT API which can be used to update the demand signal item resource.

__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.

bulk_create_occm_demand_signal_item(bulk_create_occm_demand_signal_item_details, **kwargs)¶

This API will help in bulk creation of demand signal items. This API is atomic i.e either all the demand signal item resources will be created or none will be created.

Parameters:	bulk_create_occm_demand_signal_item_details (oci.capacity_management.models.BulkCreateOccmDemandSignalItemDetails) – (required) The request details for bulk creating the demand signal items. 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 None
Return type:	`Response`
Example:

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

create_occm_demand_signal(create_occm_demand_signal_details, **kwargs)¶

This is a post API to create occm demand signal.

Parameters:	create_occm_demand_signal_details (oci.capacity_management.models.CreateOccmDemandSignalDetails) – (required) The request details for creating occm demand signal. 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 `OccmDemandSignal`
Return type:	`Response`
Example:

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

create_occm_demand_signal_item(create_occm_demand_signal_item_details, **kwargs)¶

This API will create a demand signal item representing a resource request. This needs to be grouped under a demand signal.

Parameters:	create_occm_demand_signal_item_details (oci.capacity_management.models.CreateOccmDemandSignalItemDetails) – (required) The request details for creating occm demand signal item. 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 `OccmDemandSignalItem`
Return type:	`Response`
Example:

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

delete_occm_demand_signal(occm_demand_signal_id, **kwargs)¶

This is a DELETE API which deletes a demand signal with the provided demand signal ocid.

Parameters:	occm_demand_signal_id (str) – (required) The OCID of the demand signal. 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_occm_demand_signal API.

delete_occm_demand_signal_item(occm_demand_signal_item_id, **kwargs)¶

This is a DELETE API which deletes a demand signal item with the provided demand signal item ocid.

Parameters:	occm_demand_signal_item_id (str) – (required) The OCID of the demand signal item. 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_occm_demand_signal_item API.

get_occm_demand_signal(occm_demand_signal_id, **kwargs)¶

This is a GET API which gets the detailed information about a specific demand signal.

Parameters:	occm_demand_signal_id (str) – (required) The OCID of the demand signal. 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 `OccmDemandSignal`
Return type:	`Response`
Example:

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

get_occm_demand_signal_item(occm_demand_signal_item_id, **kwargs)¶

This is a GET API to get the details of a demand signal item resource representing the details of the resource demanded by you.

Parameters:	occm_demand_signal_item_id (str) – (required) The OCID of the demand signal item. 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 `OccmDemandSignalItem`
Return type:	`Response`
Example:

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

list_occm_demand_signal_catalog_resources(compartment_id, **kwargs)¶

This API will list all the resources across all demand signal catalogs for a given namespace and customer group containing the caller compartment.

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. name (str) – (optional) A query parameter to filter the list of demand signal catalog resource based on the resource name. demand_signal_namespace (str) – (optional) A query parameter to filter the list of demand signal catalog resources based on the namespace. Allowed values are: “COMPUTE”, “NETWORK”, “GPU”, “STORAGE” 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 the response of List Demand catalog resources API. Only one sort order may be provided. The default order for name is case sensitive alphabetical order. Allowed values are: “name” 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 `OccmDemandSignalCatalogResourceCollection`
Return type:	`Response`
Example:

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

list_occm_demand_signal_deliveries(compartment_id, **kwargs)¶

This GET call is used to list all demand signals delivery resources within the compartment passed as a query param.

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. id (str) – (optional) A query parameter to filter the list of demand signals based on it’s OCID. occm_demand_signal_item_id (str) – (optional) A query parameter to filter the list of demand signal items based on it’s OCID. 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 the response of List Demand Signal Delivery API. Only one sort order may be provided. The default order for resource name is case sensitive alphabetical order. Allowed values are: “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 `OccmDemandSignalDeliveryCollection`
Return type:	`Response`
Example:

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

list_occm_demand_signal_items(compartment_id, **kwargs)¶

This API will list the detailed information about the resources demanded as part of the demand signal.

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. occm_demand_signal_id (str) – (optional) A query parameter to filter the list of demand signal items based on a demand signal id. resource_name (str) – (optional) A query parameter to filter the list of demand signal details based on the resource name. demand_signal_namespace (str) – (optional) A query parameter to filter the list of demand signal details based on the namespace. Allowed values are: “COMPUTE”, “NETWORK”, “GPU”, “STORAGE” 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 the response of List Demand Signal Details API. Only one sort order may be provided. The default order for resource name is case sensitive alphabetical order. Allowed values are: “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 `OccmDemandSignalItemCollection`
Return type:	`Response`
Example:

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

list_occm_demand_signals(compartment_id, **kwargs)¶

This GET call is used to list all demand signals within the compartment passed as a query parameter.

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. id (str) – (optional) A query parameter to filter the list of demand signals based on it’s OCID. lifecycle_details (str) – (optional) A query parameter to filter the list of demand signals based on its state. display_name (str) – (optional) A filter to return only the resources that match the entire display name. The match is not case sensitive. 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 the response of List Demand Signal API. Only one sort order may be provided. The default order for timeCreated is reverse chronological order (latest date at the top). The default order for displayName is case sensitive alphabetical order. Allowed values are: “timeCreated”, “displayName” 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 `OccmDemandSignalCollection`
Return type:	`Response`
Example:

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

update_occm_demand_signal(update_occm_demand_signal_details, occm_demand_signal_id, **kwargs)¶

This is a PUT API which shall be used to update the metadata of the demand signal.

Parameters:	update_occm_demand_signal_details (oci.capacity_management.models.UpdateOccmDemandSignalDetails) – (required) The request details for this PUT API to update the metadata for a given demand signal resource. occm_demand_signal_id (str) – (required) The OCID of the demand signal. 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 `OccmDemandSignal`
Return type:	`Response`
Example:

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

update_occm_demand_signal_item(update_occm_demand_signal_item_details, occm_demand_signal_item_id, **kwargs)¶

This is a PUT API which can be used to update the demand signal item resource.

Parameters:	update_occm_demand_signal_item_details (oci.capacity_management.models.UpdateOccmDemandSignalItemDetails) – (required) The details about the request to update the specified demand signal item. occm_demand_signal_item_id (str) – (required) The OCID of the demand signal item. 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 `OccmDemandSignalItem`
Return type:	`Response`
Example:

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