Class ClusterPlacementGroupsCPClient
Service client instance for ClusterPlacementGroupsCP.
Implements
Inherited Members
Namespace: Oci.ClusterplacementgroupsService
Assembly: OCI.DotNetSDK.Clusterplacementgroups.dll
Syntax
public class ClusterPlacementGroupsCPClient : RegionalClientBase, IDisposable
Constructors
ClusterPlacementGroupsCPClient(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 ClusterPlacementGroupsCPClient(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 ClusterPlacementGroupsCPPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
ClusterPlacementGroupsCPPaginators |
Waiters
Declaration
public ClusterPlacementGroupsCPWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
ClusterPlacementGroupsCPWaiters |
Methods
ActivateClusterPlacementGroup(ActivateClusterPlacementGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Activates the specified, previously deactivated cluster placement group to let resources be created in it.
Declaration
public Task<ActivateClusterPlacementGroupResponse> ActivateClusterPlacementGroup(ActivateClusterPlacementGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ActivateClusterPlacementGroupRequest | 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<ActivateClusterPlacementGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ActivateClusterPlacementGroup API.
CancelWorkRequest(CancelWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cancels the work request with the specified ID.
Declaration
public Task<CancelWorkRequestResponse> CancelWorkRequest(CancelWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CancelWorkRequestRequest | 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<CancelWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CancelWorkRequest API.
ChangeClusterPlacementGroupCompartment(ChangeClusterPlacementGroupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a cluster placement group resource from one compartment to another in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment. <br/> When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangeClusterPlacementGroupCompartmentResponse> ChangeClusterPlacementGroupCompartment(ChangeClusterPlacementGroupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeClusterPlacementGroupCompartmentRequest | 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<ChangeClusterPlacementGroupCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeClusterPlacementGroupCompartment API.
CreateClusterPlacementGroup(CreateClusterPlacementGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a new cluster placement group in the specified compartment.
Declaration
public Task<CreateClusterPlacementGroupResponse> CreateClusterPlacementGroup(CreateClusterPlacementGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateClusterPlacementGroupRequest | 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<CreateClusterPlacementGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateClusterPlacementGroup API.
DeactivateClusterPlacementGroup(DeactivateClusterPlacementGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deactivates the specified cluster placement group to prevent new resources from being created in it.
Declaration
public Task<DeactivateClusterPlacementGroupResponse> DeactivateClusterPlacementGroup(DeactivateClusterPlacementGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeactivateClusterPlacementGroupRequest | 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<DeactivateClusterPlacementGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeactivateClusterPlacementGroup API.
DeleteClusterPlacementGroup(DeleteClusterPlacementGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes the specified cluster placement group.
Declaration
public Task<DeleteClusterPlacementGroupResponse> DeleteClusterPlacementGroup(DeleteClusterPlacementGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteClusterPlacementGroupRequest | 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<DeleteClusterPlacementGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteClusterPlacementGroup API.
GetClusterPlacementGroup(GetClusterPlacementGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the specified cluster placement group.
Declaration
public Task<GetClusterPlacementGroupResponse> GetClusterPlacementGroup(GetClusterPlacementGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetClusterPlacementGroupRequest | 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<GetClusterPlacementGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetClusterPlacementGroup API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets details of the work request with the specified ID.
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWorkRequestRequest | 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<GetWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWorkRequest API.
ListClusterPlacementGroups(ListClusterPlacementGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets a list of all cluster placement groups in the specified compartment.
Declaration
public Task<ListClusterPlacementGroupsResponse> ListClusterPlacementGroups(ListClusterPlacementGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListClusterPlacementGroupsRequest | 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<ListClusterPlacementGroupsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListClusterPlacementGroups API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a (paginated) list of errors for the work request with the specified ID.
Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestErrorsRequest | 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<ListWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestErrors API.
ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Returns a (paginated) list of logs for the work request with the specified ID.
Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestLogsRequest | 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<ListWorkRequestLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestLogs API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists all work requests in the specified compartment.
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestsRequest | 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<ListWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequests API.
UpdateClusterPlacementGroup(UpdateClusterPlacementGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates the specified cluster placement group.
Declaration
public Task<UpdateClusterPlacementGroupResponse> UpdateClusterPlacementGroup(UpdateClusterPlacementGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateClusterPlacementGroupRequest | 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<UpdateClusterPlacementGroupResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateClusterPlacementGroup API.