Class CcdCommitmentsClient

Service client instance for CcdCommitments.

Inheritance

object

ClientBase

RegionalClientBase

CcdCommitmentsClient

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)

ClientBase.EnableDualStackEndpoints(bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.CcdoffersService

Assembly: OCI.DotNetSDK.Ccdoffers.dll

Syntax

public class CcdCommitmentsClient : RegionalClientBase, IDisposable

Constructors

CcdCommitmentsClient(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 CcdCommitmentsClient(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 CcdCommitmentsPaginators Paginators { get; }

Property Value

Type	Description
CcdCommitmentsPaginators

Waiters

Declaration

public CcdCommitmentsWaiters Waiters { get; }

Property Value

Type	Description
CcdCommitmentsWaiters

Methods

CreateCcdCommitment(CreateCcdCommitmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Request to create a new CCD commitment.

Declaration

public Task<CreateCcdCommitmentResponse> CreateCcdCommitment(CreateCcdCommitmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteCcdCommitment(DeleteCcdCommitmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Terminates the CCD commitment. You can't terminate an already canceled or ended commitment. If the CCD commitment has already started based on timeCcdCommitmentStarts, then you can only terminate within a week of its effective timeCcdCommitmentStarts time.

Declaration

public Task<DeleteCcdCommitmentResponse> DeleteCcdCommitment(DeleteCcdCommitmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetCcdCommitment(GetCcdCommitmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the CCD commitment using the CCD commitment ID.

Declaration

public Task<GetCcdCommitmentResponse> GetCcdCommitment(GetCcdCommitmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListCcdCommitments(ListCcdCommitmentsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the CCD commitments.

Declaration

public Task<ListCcdCommitmentsResponse> ListCcdCommitments(ListCcdCommitmentsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateCcdCommitment(UpdateCcdCommitmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the free-form tags, defined tags, or both on a CCD commitment. Commercial commitment attributes are immutable.

Declaration

public Task<UpdateCcdCommitmentResponse> UpdateCcdCommitment(UpdateCcdCommitmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable