Class CostAdClient
Service client instance for CostAd.
Implements
Inherited Members
Namespace: Oci.BudgetService
Assembly: OCI.DotNetSDK.Budget.dll
Syntax
public class CostAdClient : RegionalClientBase, IDisposable
Constructors
CostAdClient(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 CostAdClient(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 CostAdPaginators Paginators { get; }
Property Value
| Type | Description |
|---|---|
| CostAdPaginators |
Waiters
Declaration
public CostAdWaiters Waiters { get; }
Property Value
| Type | Description |
|---|---|
| CostAdWaiters |
Methods
CreateCostAlertSubscription(CreateCostAlertSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new CostAlert Subscription.
Declaration
public Task<CreateCostAlertSubscriptionResponse> CreateCostAlertSubscription(CreateCostAlertSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateCostAlertSubscriptionRequest | 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<CreateCostAlertSubscriptionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateCostAlertSubscription API.
CreateCostAnomalyMonitor(CreateCostAnomalyMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new costAnomaly Monitor.
Declaration
public Task<CreateCostAnomalyMonitorResponse> CreateCostAnomalyMonitor(CreateCostAnomalyMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| CreateCostAnomalyMonitorRequest | 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<CreateCostAnomalyMonitorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateCostAnomalyMonitor API.
DeleteCostAlertSubscription(DeleteCostAlertSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specified CostAlertSubscription resource.
Declaration
public Task<DeleteCostAlertSubscriptionResponse> DeleteCostAlertSubscription(DeleteCostAlertSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteCostAlertSubscriptionRequest | 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<DeleteCostAlertSubscriptionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteCostAlertSubscription API.
DeleteCostAnomalyMonitor(DeleteCostAnomalyMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a specified CostAnomalyMonitor resource.
Declaration
public Task<DeleteCostAnomalyMonitorResponse> DeleteCostAnomalyMonitor(DeleteCostAnomalyMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| DeleteCostAnomalyMonitorRequest | 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<DeleteCostAnomalyMonitorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteCostAnomalyMonitor API.
DisableCostAnomalyMonitor(DisableCostAnomalyMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Disables the cost anomaly monitor. This stops cost anomaly detection for targeted resource(s).
Declaration
public Task<DisableCostAnomalyMonitorResponse> DisableCostAnomalyMonitor(DisableCostAnomalyMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| DisableCostAnomalyMonitorRequest | 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<DisableCostAnomalyMonitorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DisableCostAnomalyMonitor API.
EnableCostAnomalyMonitor(EnableCostAnomalyMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Enables the cost anomaly monitor. This (re)starts the cost anomaly detection for targeted resource(s).
Declaration
public Task<EnableCostAnomalyMonitorResponse> EnableCostAnomalyMonitor(EnableCostAnomalyMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| EnableCostAnomalyMonitorRequest | 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<EnableCostAnomalyMonitorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use EnableCostAnomalyMonitor API.
GetCostAlertSubscription(GetCostAlertSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a CostAlertSubscription by the identifier.
Declaration
public Task<GetCostAlertSubscriptionResponse> GetCostAlertSubscription(GetCostAlertSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| GetCostAlertSubscriptionRequest | 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<GetCostAlertSubscriptionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCostAlertSubscription API.
GetCostAnomalyEvent(GetCostAnomalyEventRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a CostAnomalyEvent by the identifier.
Declaration
public Task<GetCostAnomalyEventResponse> GetCostAnomalyEvent(GetCostAnomalyEventRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| GetCostAnomalyEventRequest | 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<GetCostAnomalyEventResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCostAnomalyEvent API.
GetCostAnomalyMonitor(GetCostAnomalyMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a CostAnomalyMonitor by the identifier.
Declaration
public Task<GetCostAnomalyMonitorResponse> GetCostAnomalyMonitor(GetCostAnomalyMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| GetCostAnomalyMonitorRequest | 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<GetCostAnomalyMonitorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCostAnomalyMonitor API.
ListCostAlertSubscriptions(ListCostAlertSubscriptionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of Cost Alert Subscription in a compartment.
Declaration
public Task<ListCostAlertSubscriptionsResponse> ListCostAlertSubscriptions(ListCostAlertSubscriptionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| ListCostAlertSubscriptionsRequest | 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<ListCostAlertSubscriptionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCostAlertSubscriptions API.
ListCostAnomalyEvents(ListCostAnomalyEventsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of Cost Anomaly Event in a compartment.
Declaration
public Task<ListCostAnomalyEventsResponse> ListCostAnomalyEvents(ListCostAnomalyEventsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| ListCostAnomalyEventsRequest | 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<ListCostAnomalyEventsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCostAnomalyEvents API.
ListCostAnomalyMonitors(ListCostAnomalyMonitorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of Cost Anomaly Monitors in a compartment.
Declaration
public Task<ListCostAnomalyMonitorsResponse> ListCostAnomalyMonitors(ListCostAnomalyMonitorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| ListCostAnomalyMonitorsRequest | 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<ListCostAnomalyMonitorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCostAnomalyMonitors API.
SummarizeCostAnomalyEventAnalytics(SummarizeCostAnomalyEventAnalyticsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of Cost Anomaly Events analytics summary - aggregated metrics for a given time period.
Declaration
public Task<SummarizeCostAnomalyEventAnalyticsResponse> SummarizeCostAnomalyEventAnalytics(SummarizeCostAnomalyEventAnalyticsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| SummarizeCostAnomalyEventAnalyticsRequest | 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<SummarizeCostAnomalyEventAnalyticsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use SummarizeCostAnomalyEventAnalytics API.
UpdateCostAlertSubscription(UpdateCostAlertSubscriptionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update a CostAlertSubscription identified by the OCID.
Declaration
public Task<UpdateCostAlertSubscriptionResponse> UpdateCostAlertSubscription(UpdateCostAlertSubscriptionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateCostAlertSubscriptionRequest | 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<UpdateCostAlertSubscriptionResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCostAlertSubscription API.
UpdateCostAnomalyEvent(UpdateCostAnomalyEventRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update a CostAnomalyEvent identified by the OCID.
Declaration
public Task<UpdateCostAnomalyEventResponse> UpdateCostAnomalyEvent(UpdateCostAnomalyEventRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateCostAnomalyEventRequest | 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<UpdateCostAnomalyEventResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCostAnomalyEvent API.
UpdateCostAnomalyMonitor(UpdateCostAnomalyMonitorRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update a CostAnomalyMonitor identified by the OCID.
Declaration
public Task<UpdateCostAnomalyMonitorResponse> UpdateCostAnomalyMonitor(UpdateCostAnomalyMonitorRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
| Type | Name | Description |
|---|---|---|
| UpdateCostAnomalyMonitorRequest | 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<UpdateCostAnomalyMonitorResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateCostAnomalyMonitor API.