Class UsagePlansClient

Service client instance for UsagePlans.

Inheritance

object

ClientBase

RegionalClientBase

UsagePlansClient

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

Assembly: OCI.DotNetSDK.Apigateway.dll

Syntax

public class UsagePlansClient : RegionalClientBase, IDisposable

Constructors

UsagePlansClient(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 UsagePlansClient(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 UsagePlansPaginators Paginators { get; }

Property Value

Type	Description
UsagePlansPaginators

Waiters

Declaration

public UsagePlansWaiters Waiters { get; }

Property Value

Type	Description
UsagePlansWaiters

Methods

ChangeUsagePlanCompartment(ChangeUsagePlanCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Changes the usage plan compartment.

Declaration

public Task<ChangeUsagePlanCompartmentResponse> ChangeUsagePlanCompartment(ChangeUsagePlanCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateUsagePlan(CreateUsagePlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new usage plan.

Declaration

public Task<CreateUsagePlanResponse> CreateUsagePlan(CreateUsagePlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteUsagePlan(DeleteUsagePlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the usage plan with the given identifier.

Declaration

public Task<DeleteUsagePlanResponse> DeleteUsagePlan(DeleteUsagePlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetUsagePlan(GetUsagePlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets a usage plan by identifier.

Declaration

public Task<GetUsagePlanResponse> GetUsagePlan(GetUsagePlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListUsagePlans(ListUsagePlansRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Returns a list of usage plans.

Declaration

public Task<ListUsagePlansResponse> ListUsagePlans(ListUsagePlansRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateUsagePlan(UpdateUsagePlanRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the usage plan with the given identifier.

Declaration

public Task<UpdateUsagePlanResponse> UpdateUsagePlan(UpdateUsagePlanRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable