Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LimitsClient

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

  • LimitsClient

Constructors

constructor

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

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 = ""

targetService

targetService: string = "Limits"

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

close

  • close(): void

getResourceAvailability

  • For a given compartmentId, resource limit name, and scope, returns the following:

    • The number of available resources associated with the given limit.
    • The usage in the selected compartment for the given limit. Note that not all resource limits support this API. If the value is not available, the API returns a 404 response.

    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 GetResourceAvailability API.

    Parameters

    Returns Promise<GetResourceAvailabilityResponse>

    GetResourceAvailabilityResponse

listAllLimitDefinitions

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

    Parameters

    Returns AsyncIterableIterator<LimitDefinitionSummary>

listAllLimitDefinitionsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListLimitDefinitionsResponse>

listAllLimitValues

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

    Parameters

    Returns AsyncIterableIterator<LimitValueSummary>

listAllLimitValuesResponses

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

    Parameters

    Returns AsyncIterableIterator<ListLimitValuesResponse>

listAllServices

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

    Parameters

    Returns AsyncIterableIterator<ServiceSummary>

listAllServicesResponses

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

    Parameters

    Returns AsyncIterableIterator<ListServicesResponse>

listLimitDefinitions

  • Includes a list of resource limits that are currently supported. If the 'areQuotasSupported' property is true, you can create quota policies on top of this limit at the compartment level.

    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 ListLimitDefinitions API.

    Parameters

    Returns Promise<ListLimitDefinitionsResponse>

    ListLimitDefinitionsResponse

listLimitDefinitionsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<LimitDefinitionSummary>

listLimitDefinitionsResponseIterator

listLimitValues

  • Includes a full list of resource limits belonging to a given service.

    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 ListLimitValues API.

    Parameters

    Returns Promise<ListLimitValuesResponse>

    ListLimitValuesResponse

listLimitValuesRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<LimitValueSummary>

listLimitValuesResponseIterator

listServices

  • Returns the list of supported services. This includes the programmatic service name, along with the friendly service name.

    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 ListServices API.

    Parameters

    Returns Promise<ListServicesResponse>

    ListServicesResponse

listServicesRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<ServiceSummary>

listServicesResponseIterator

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

    Parameters

    Returns AsyncIterableIterator<ListServicesResponse>

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void