Class CommitmentClient
Service client instance for Commitment.
Implements
Inherited Members
Namespace: Oci.OnesubscriptionService
Assembly: OCI.DotNetSDK.Onesubscription.dll
Syntax
public class CommitmentClient : RegionalClientBase, IDisposable
Constructors
CommitmentClient(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 CommitmentClient(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 CommitmentPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
CommitmentPaginators |
Methods
GetCommitment(GetCommitmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This API returns the commitment details corresponding to the id provided
Declaration
public Task<GetCommitmentResponse> GetCommitment(GetCommitmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetCommitmentRequest | 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<GetCommitmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetCommitment API.
ListCommitments(ListCommitmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
This list API returns all commitments for a particular Subscribed Service
Declaration
public Task<ListCommitmentsResponse> ListCommitments(ListCommitmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListCommitmentsRequest | 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<ListCommitmentsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListCommitments API.