Class ByolAllocationClient

Service client instance for ByolAllocation.

Inheritance

object

ClientBase

RegionalClientBase

ByolAllocationClient

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

Assembly: OCI.DotNetSDK.Ocvp.dll

Syntax

public class ByolAllocationClient : RegionalClientBase, IDisposable

Constructors

ByolAllocationClient(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 ByolAllocationClient(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 ByolAllocationPaginators Paginators { get; }

Property Value

Type	Description
ByolAllocationPaginators

Waiters

Declaration

public ByolAllocationWaiters Waiters { get; }

Property Value

Type	Description
ByolAllocationWaiters

Methods

ChangeByolAllocationCompartment(ChangeByolAllocationCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an BYOL Allocation into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Declaration

public Task<ChangeByolAllocationCompartmentResponse> ChangeByolAllocationCompartment(ChangeByolAllocationCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateByolAllocation(CreateByolAllocationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an Allocation on an specific Bring-You-Own-License (BYOL). <br/> Use the {@link WorkRequest} operations to track the creation of the BYOL.

Declaration

public Task<CreateByolAllocationResponse> CreateByolAllocation(CreateByolAllocationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteByolAllocation(DeleteByolAllocationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified BYOL Allocation.

Declaration

public Task<DeleteByolAllocationResponse> DeleteByolAllocation(DeleteByolAllocationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetByolAllocation(GetByolAllocationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified BYOL Allocation's information.

Declaration

public Task<GetByolAllocationResponse> GetByolAllocation(GetByolAllocationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListByolAllocations(ListByolAllocationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the BYOL Allocations in the specified compartment. The list can be filtered by display name or availability domain.

Declaration

public Task<ListByolAllocationsResponse> ListByolAllocations(ListByolAllocationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateByolAllocation(UpdateByolAllocationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified BYOL Allocation.

Declaration

public Task<UpdateByolAllocationResponse> UpdateByolAllocation(UpdateByolAllocationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable