Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QuotasClient

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

  • QuotasClient

Constructors

constructor

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

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: QuotasWaiter

targetService

targetService: string = "Quotas"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://limits.{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

addQuotaLock

close

  • close(): void

createQuota

  • Creates a new quota with the details supplied. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateQuota API.

    Parameters

    Returns Promise<CreateQuotaResponse>

    CreateQuotaResponse

createWaiters

  • createWaiters(config?: common.WaiterConfiguration): QuotasWaiter
  • Creates a new QuotasWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns QuotasWaiter

    The service waiters.

deleteQuota

  • Deletes the quota corresponding to the given OCID. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteQuota API.

    Parameters

    Returns Promise<DeleteQuotaResponse>

    DeleteQuotaResponse

getQuota

  • Gets the quota for the OCID specified. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetQuota API.

    Parameters

    Returns Promise<GetQuotaResponse>

    GetQuotaResponse

getWaiters

listAllQuotas

  • NOTE: This function is deprecated in favor of listQuotasRecordIterator function. Creates a new async iterator which will iterate over the models.QuotaSummary objects contained in responses from the listQuotas operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<QuotaSummary>

listAllQuotasResponses

  • NOTE: This function is deprecated in favor of listQuotasResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listQuotas operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListQuotasResponse>

listQuotas

  • Lists all quotas on resources from the given compartment. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListQuotas API.

    Parameters

    Returns Promise<ListQuotasResponse>

    ListQuotasResponse

listQuotasRecordIterator

  • Creates a new async iterator which will iterate over the models.QuotaSummary objects contained in responses from the listQuotas operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<QuotaSummary>

listQuotasResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listQuotas operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListQuotasResponse>

removeQuotaLock

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateQuota

  • Updates the quota corresponding to given OCID with the details supplied. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateQuota API.

    Parameters

    Returns Promise<UpdateQuotaResponse>

    UpdateQuotaResponse