Class UsageapiClient

Service client instance for Usageapi.

Inheritance

object

ClientBase

RegionalClientBase

UsageapiClient

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

Assembly: OCI.DotNetSDK.Usageapi.dll

Syntax

public class UsageapiClient : RegionalClientBase, IDisposable

Constructors

UsageapiClient(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 UsageapiClient(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 UsageapiPaginators Paginators { get; }

Property Value

Type	Description
UsageapiPaginators

Waiters

Declaration

public UsageapiWaiters Waiters { get; }

Property Value

Type	Description
UsageapiWaiters

Methods

CreateCustomTable(CreateCustomTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the created custom table.

Declaration

public Task<CreateCustomTableResponse> CreateCustomTable(CreateCustomTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateEmailRecipientsGroup(CreateEmailRecipientsGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Add a list of email recipients that can receive usage statements for the subscription.

Declaration

public Task<CreateEmailRecipientsGroupResponse> CreateEmailRecipientsGroup(CreateEmailRecipientsGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateQuery(CreateQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the created query.

Declaration

public Task<CreateQueryResponse> CreateQuery(CreateQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateSchedule(CreateScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the created schedule.

Declaration

public Task<CreateScheduleResponse> CreateSchedule(CreateScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateUsageCarbonEmissionsQuery(CreateUsageCarbonEmissionsQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the created usage carbon emissions query.

Declaration

public Task<CreateUsageCarbonEmissionsQueryResponse> CreateUsageCarbonEmissionsQuery(CreateUsageCarbonEmissionsQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteCustomTable(DeleteCustomTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a saved custom table by the OCID.

Declaration

public Task<DeleteCustomTableResponse> DeleteCustomTable(DeleteCustomTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteEmailRecipientsGroup(DeleteEmailRecipientsGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete the email recipients group for the usage statement subscription.

Declaration

public Task<DeleteEmailRecipientsGroupResponse> DeleteEmailRecipientsGroup(DeleteEmailRecipientsGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteQuery(DeleteQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a saved query by the OCID.

Declaration

public Task<DeleteQueryResponse> DeleteQuery(DeleteQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteSchedule(DeleteScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a saved scheduled report by the OCID.

Declaration

public Task<DeleteScheduleResponse> DeleteSchedule(DeleteScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteUsageCarbonEmissionsQuery(DeleteUsageCarbonEmissionsQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Delete a usage carbon emissions saved query by the OCID.

Declaration

public Task<DeleteUsageCarbonEmissionsQueryResponse> DeleteUsageCarbonEmissionsQuery(DeleteUsageCarbonEmissionsQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetCustomTable(GetCustomTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the saved custom table.

Declaration

public Task<GetCustomTableResponse> GetCustomTable(GetCustomTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetEmailRecipientsGroup(GetEmailRecipientsGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Return the saved usage statement email recipient group.

Declaration

public Task<GetEmailRecipientsGroupResponse> GetEmailRecipientsGroup(GetEmailRecipientsGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetQuery(GetQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the saved query.

Declaration

public Task<GetQueryResponse> GetQuery(GetQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetSchedule(GetScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the saved schedule.

Declaration

public Task<GetScheduleResponse> GetSchedule(GetScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetScheduledRun(GetScheduledRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the saved schedule run.

Declaration

public Task<GetScheduledRunResponse> GetScheduledRun(GetScheduledRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetUsageCarbonEmissionsQuery(GetUsageCarbonEmissionsQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the usage carbon emissions saved query.

Declaration

public Task<GetUsageCarbonEmissionsQueryResponse> GetUsageCarbonEmissionsQuery(GetUsageCarbonEmissionsQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListCustomTables(ListCustomTablesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the saved custom table list.

Declaration

public Task<ListCustomTablesResponse> ListCustomTables(ListCustomTablesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListEmailRecipientsGroups(ListEmailRecipientsGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Return the saved usage statement email recipient group.

Declaration

public Task<ListEmailRecipientsGroupsResponse> ListEmailRecipientsGroups(ListEmailRecipientsGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListQueries(ListQueriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the saved query list.

Declaration

public Task<ListQueriesResponse> ListQueries(ListQueriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListScheduledRuns(ListScheduledRunsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns schedule history list.

Declaration

public Task<ListScheduledRunsResponse> ListScheduledRuns(ListScheduledRunsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListSchedules(ListSchedulesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the saved schedule list.

Declaration

public Task<ListSchedulesResponse> ListSchedules(ListSchedulesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListUsageCarbonEmissionsQueries(ListUsageCarbonEmissionsQueriesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the usage carbon emissions saved query list.

Declaration

public Task<ListUsageCarbonEmissionsQueriesResponse> ListUsageCarbonEmissionsQueries(ListUsageCarbonEmissionsQueriesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

RequestAverageCarbonEmission(RequestAverageCarbonEmissionRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the average carbon emissions summary by SKU.

Declaration

public Task<RequestAverageCarbonEmissionResponse> RequestAverageCarbonEmission(RequestAverageCarbonEmissionRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

RequestCleanEnergyUsage(RequestCleanEnergyUsageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the clean energy usage summary by region.

Declaration

public Task<RequestCleanEnergyUsageResponse> RequestCleanEnergyUsage(RequestCleanEnergyUsageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

RequestSummarizedConfigurations(RequestSummarizedConfigurationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the configurations list for the UI drop-down list.

Declaration

public Task<RequestSummarizedConfigurationsResponse> RequestSummarizedConfigurations(RequestSummarizedConfigurationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

RequestSummarizedUsages(RequestSummarizedUsagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns usage for the given account.

Declaration

public Task<RequestSummarizedUsagesResponse> RequestSummarizedUsages(RequestSummarizedUsagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

RequestUsageCarbonEmissionConfig(RequestUsageCarbonEmissionConfigRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns the configuration list for the UI drop-down list of carbon emission console.

Declaration

public Task<RequestUsageCarbonEmissionConfigResponse> RequestUsageCarbonEmissionConfig(RequestUsageCarbonEmissionConfigRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

RequestUsageCarbonEmissions(RequestUsageCarbonEmissionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns usage carbon emission for the given account.

Declaration

public Task<RequestUsageCarbonEmissionsResponse> RequestUsageCarbonEmissions(RequestUsageCarbonEmissionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateCustomTable(UpdateCustomTableRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a saved custom table by table id.

Declaration

public Task<UpdateCustomTableResponse> UpdateCustomTable(UpdateCustomTableRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateEmailRecipientsGroup(UpdateEmailRecipientsGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a saved email recipients group.

Declaration

public Task<UpdateEmailRecipientsGroupResponse> UpdateEmailRecipientsGroup(UpdateEmailRecipientsGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateQuery(UpdateQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a saved query by the OCID.

Declaration

public Task<UpdateQueryResponse> UpdateQuery(UpdateQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateSchedule(UpdateScheduleRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a saved schedule

Declaration

public Task<UpdateScheduleResponse> UpdateSchedule(UpdateScheduleRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateUsageCarbonEmissionsQuery(UpdateUsageCarbonEmissionsQueryRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Update a usage carbon emissions saved query by the OCID.

Declaration

public Task<UpdateUsageCarbonEmissionsQueryResponse> UpdateUsageCarbonEmissionsQuery(UpdateUsageCarbonEmissionsQueryRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable