Class DemandSignalClient

Service client instance for DemandSignal.

Inheritance

object

ClientBase

RegionalClientBase

DemandSignalClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.CapacitymanagementService

Assembly: OCI.DotNetSDK.Capacitymanagement.dll

Syntax

public class DemandSignalClient : RegionalClientBase, IDisposable

Constructors

DemandSignalClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public DemandSignalClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public DemandSignalPaginators Paginators { get; }

Property Value

Type	Description
DemandSignalPaginators

Waiters

Declaration

public DemandSignalWaiters Waiters { get; }

Property Value

Type	Description
DemandSignalWaiters

Methods

BulkCreateOccmDemandSignalItem(BulkCreateOccmDemandSignalItemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<BulkCreateOccmDemandSignalItemResponse> BulkCreateOccmDemandSignalItem(BulkCreateOccmDemandSignalItemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
BulkCreateOccmDemandSignalItemRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<BulkCreateOccmDemandSignalItemResponse>	A response object containing details about the completed operation

Examples

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

CreateOccmDemandSignal(CreateOccmDemandSignalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

This is a post API to create occm demand signal.

Declaration

public Task<CreateOccmDemandSignalResponse> CreateOccmDemandSignal(CreateOccmDemandSignalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateOccmDemandSignalRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateOccmDemandSignalResponse>	A response object containing details about the completed operation

Examples

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

CreateOccmDemandSignalItem(CreateOccmDemandSignalItemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<CreateOccmDemandSignalItemResponse> CreateOccmDemandSignalItem(CreateOccmDemandSignalItemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateOccmDemandSignalItemRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateOccmDemandSignalItemResponse>	A response object containing details about the completed operation

Examples

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

DeleteOccmDemandSignal(DeleteOccmDemandSignalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<DeleteOccmDemandSignalResponse> DeleteOccmDemandSignal(DeleteOccmDemandSignalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteOccmDemandSignalRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteOccmDemandSignalResponse>	A response object containing details about the completed operation

Examples

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

DeleteOccmDemandSignalItem(DeleteOccmDemandSignalItemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<DeleteOccmDemandSignalItemResponse> DeleteOccmDemandSignalItem(DeleteOccmDemandSignalItemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteOccmDemandSignalItemRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteOccmDemandSignalItemResponse>	A response object containing details about the completed operation

Examples

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

GetOccmDemandSignal(GetOccmDemandSignalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<GetOccmDemandSignalResponse> GetOccmDemandSignal(GetOccmDemandSignalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOccmDemandSignalRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetOccmDemandSignalResponse>	A response object containing details about the completed operation

Examples

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

GetOccmDemandSignalItem(GetOccmDemandSignalItemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<GetOccmDemandSignalItemResponse> GetOccmDemandSignalItem(GetOccmDemandSignalItemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetOccmDemandSignalItemRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetOccmDemandSignalItemResponse>	A response object containing details about the completed operation

Examples

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

ListOccmDemandSignalCatalogResources(ListOccmDemandSignalCatalogResourcesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ListOccmDemandSignalCatalogResourcesResponse> ListOccmDemandSignalCatalogResources(ListOccmDemandSignalCatalogResourcesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOccmDemandSignalCatalogResourcesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListOccmDemandSignalCatalogResourcesResponse>	A response object containing details about the completed operation

Examples

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

ListOccmDemandSignalDeliveries(ListOccmDemandSignalDeliveriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ListOccmDemandSignalDeliveriesResponse> ListOccmDemandSignalDeliveries(ListOccmDemandSignalDeliveriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOccmDemandSignalDeliveriesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListOccmDemandSignalDeliveriesResponse>	A response object containing details about the completed operation

Examples

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

ListOccmDemandSignalItems(ListOccmDemandSignalItemsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ListOccmDemandSignalItemsResponse> ListOccmDemandSignalItems(ListOccmDemandSignalItemsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOccmDemandSignalItemsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListOccmDemandSignalItemsResponse>	A response object containing details about the completed operation

Examples

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

ListOccmDemandSignals(ListOccmDemandSignalsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ListOccmDemandSignalsResponse> ListOccmDemandSignals(ListOccmDemandSignalsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListOccmDemandSignalsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListOccmDemandSignalsResponse>	A response object containing details about the completed operation

Examples

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

UpdateOccmDemandSignal(UpdateOccmDemandSignalRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<UpdateOccmDemandSignalResponse> UpdateOccmDemandSignal(UpdateOccmDemandSignalRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateOccmDemandSignalRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateOccmDemandSignalResponse>	A response object containing details about the completed operation

Examples

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

UpdateOccmDemandSignalItem(UpdateOccmDemandSignalItemRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<UpdateOccmDemandSignalItemResponse> UpdateOccmDemandSignalItem(UpdateOccmDemandSignalItemRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateOccmDemandSignalItemRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateOccmDemandSignalItemResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable