Class LimitsClient
Service client instance for Limits.
Implements
Inherited Members
Namespace: Oci.LimitsService
Assembly: OCI.DotNetSDK.Limits.dll
Syntax
public class LimitsClient : RegionalClientBase, IDisposable
Constructors
LimitsClient(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 LimitsClient(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 LimitsPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
LimitsPaginators |
Methods
GetResourceAvailability(GetResourceAvailabilityRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<GetResourceAvailabilityResponse> GetResourceAvailability(GetResourceAvailabilityRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetResourceAvailabilityRequest | 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<GetResourceAvailabilityResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetResourceAvailability API.
ListLimitDefinitions(ListLimitDefinitionsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListLimitDefinitionsResponse> ListLimitDefinitions(ListLimitDefinitionsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLimitDefinitionsRequest | 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<ListLimitDefinitionsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLimitDefinitions API.
ListLimitValues(ListLimitValuesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Includes a full list of resource limits belonging to a given service.
Declaration
public Task<ListLimitValuesResponse> ListLimitValues(ListLimitValuesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLimitValuesRequest | 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<ListLimitValuesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLimitValues API.
ListServices(ListServicesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns the list of supported services. This includes the programmatic service name, along with the friendly service name.
Declaration
public Task<ListServicesResponse> ListServices(ListServicesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListServicesRequest | 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<ListServicesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListServices API.