Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsageapiClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • UsageapiClient

Constructors

constructor

  • new UsageapiClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): UsageapiClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: UsageapiWaiter

targetService

targetService: string = "Usageapi"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://usageapi.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

close

  • close(): void

createCustomTable

createEmailRecipientsGroup

createQuery

createSchedule

createUsageCarbonEmissionsQuery

createWaiters

  • Creates a new UsageapiWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns UsageapiWaiter

    The service waiters.

deleteCustomTable

deleteEmailRecipientsGroup

deleteQuery

  • Delete a saved query by the OCID.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteQuery API.

    Parameters

    Returns Promise<DeleteQueryResponse>

    DeleteQueryResponse

deleteSchedule

deleteUsageCarbonEmissionsQuery

getCustomTable

getEmailRecipientsGroup

getQuery

  • Returns the saved query.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetQuery API.

    Parameters

    Returns Promise<GetQueryResponse>

    GetQueryResponse

getSchedule

getScheduledRun

getUsageCarbonEmissionsQuery

getWaiters

listCustomTables

listEmailRecipientsGroups

listQueries

listScheduledRuns

listSchedules

listUsageCarbonEmissionsQueries

requestAverageCarbonEmission

requestCleanEnergyUsage

requestSummarizedConfigurations

requestSummarizedUsages

requestUsageCarbonEmissionConfig

requestUsageCarbonEmissions

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateCustomTable

updateEmailRecipientsGroup

updateQuery

updateSchedule

updateUsageCarbonEmissionsQuery