Class ByolClient

Service client instance for Byol.

Inheritance

object

ClientBase

RegionalClientBase

ByolClient

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 ByolClient : RegionalClientBase, IDisposable

Constructors

ByolClient(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 ByolClient(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 ByolPaginators Paginators { get; }

Property Value

Type	Description
ByolPaginators

Waiters

Declaration

public ByolWaiters Waiters { get; }

Property Value

Type	Description
ByolWaiters

Methods

ChangeByolCompartment(ChangeByolCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves an BYOL 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<ChangeByolCompartmentResponse> ChangeByolCompartment(ChangeByolCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateByol(CreateByolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an Oracle Cloud VMware Solution Bring-You-Own-License (BYOL). <br/> Use the {@link WorkRequest} operations to track the creation of the BYOL.

Declaration

public Task<CreateByolResponse> CreateByol(CreateByolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteByol(DeleteByolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the specified BYOL.

Declaration

public Task<DeleteByolResponse> DeleteByol(DeleteByolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetByol(GetByolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the specified BYOL's information.

Declaration

public Task<GetByolResponse> GetByol(GetByolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListByols(ListByolsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ListByolsResponse> ListByols(ListByolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

RetrieveByolRealmAllocations(RetrieveByolRealmAllocationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieve realm-wide allocation status for a specified BYOL.

Declaration

public Task<RetrieveByolRealmAllocationsResponse> RetrieveByolRealmAllocations(RetrieveByolRealmAllocationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateByol(UpdateByolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates the specified BYOL.

Declaration

public Task<UpdateByolResponse> UpdateByol(UpdateByolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable