Class BudgetClient

Service client instance for Budget.

Inheritance

object

ClientBase

RegionalClientBase

BudgetClient

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

Assembly: OCI.DotNetSDK.Budget.dll

Syntax

public class BudgetClient : RegionalClientBase, IDisposable

Constructors

BudgetClient(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 BudgetClient(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 BudgetPaginators Paginators { get; }

Property Value

Type	Description
BudgetPaginators

Waiters

Declaration

public BudgetWaiters Waiters { get; }

Property Value

Type	Description
BudgetWaiters

Methods

CreateAlertRule(CreateAlertRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new Alert Rule.

Declaration

public Task<CreateAlertRuleResponse> CreateAlertRule(CreateAlertRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateAlertRuleRequest	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<CreateAlertRuleResponse>	A response object containing details about the completed operation

Examples

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

CreateBudget(CreateBudgetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new budget.

Declaration

public Task<CreateBudgetResponse> CreateBudget(CreateBudgetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateBudgetRequest	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<CreateBudgetResponse>	A response object containing details about the completed operation

Examples

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

DeleteAlertRule(DeleteAlertRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a specified Alert Rule resource.

Declaration

public Task<DeleteAlertRuleResponse> DeleteAlertRule(DeleteAlertRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteAlertRuleRequest	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<DeleteAlertRuleResponse>	A response object containing details about the completed operation

Examples

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

DeleteBudget(DeleteBudgetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes a specified budget resource.

Declaration

public Task<DeleteBudgetResponse> DeleteBudget(DeleteBudgetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteBudgetRequest	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<DeleteBudgetResponse>	A response object containing details about the completed operation

Examples

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

GetAlertRule(GetAlertRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets an Alert Rule for a specified budget.

Declaration

public Task<GetAlertRuleResponse> GetAlertRule(GetAlertRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetAlertRuleRequest	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<GetAlertRuleResponse>	A response object containing details about the completed operation

Examples

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

GetBudget(GetBudgetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a budget by the identifier.

Declaration

public Task<GetBudgetResponse> GetBudget(GetBudgetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetBudgetRequest	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<GetBudgetResponse>	A response object containing details about the completed operation

Examples

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

ListAlertRules(ListAlertRulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of Alert Rules for a specified budget.

Declaration

public Task<ListAlertRulesResponse> ListAlertRules(ListAlertRulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListAlertRulesRequest	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<ListAlertRulesResponse>	A response object containing details about the completed operation

Examples

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

ListBudgets(ListBudgetsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a list of budgets in a compartment. <br/> By default, ListBudgets returns budgets of the 'COMPARTMENT' target type, and the budget records with only one target compartment OCID. <br/> To list all budgets, set the targetType query parameter to ALL (for example: 'targetType=ALL'). <br/> Clients should ignore new targetTypes, or upgrade to the latest version of the client SDK to handle new targetTypes.

Declaration

public Task<ListBudgetsResponse> ListBudgets(ListBudgetsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListBudgetsRequest	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<ListBudgetsResponse>	A response object containing details about the completed operation

Examples

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

UpdateAlertRule(UpdateAlertRuleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update an Alert Rule for the budget identified by the OCID.

Declaration

public Task<UpdateAlertRuleResponse> UpdateAlertRule(UpdateAlertRuleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateAlertRuleRequest	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<UpdateAlertRuleResponse>	A response object containing details about the completed operation

Examples

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

UpdateBudget(UpdateBudgetRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a budget identified by the OCID.

Declaration

public Task<UpdateBudgetResponse> UpdateBudget(UpdateBudgetRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateBudgetRequest	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<UpdateBudgetResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable