Class LinkClient
Service client instance for Link.
Implements
Inherited Members
Namespace: Oci.TenantmanagercontrolplaneService
Assembly: OCI.DotNetSDK.Tenantmanagercontrolplane.dll
Syntax
public class LinkClient : RegionalClientBase, IDisposable
Constructors
LinkClient(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 LinkClient(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 LinkPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
LinkPaginators |
Waiters
Declaration
public LinkWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
LinkWaiters |
Methods
DeleteLink(DeleteLinkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts the link termination workflow.
Declaration
public Task<DeleteLinkResponse> DeleteLink(DeleteLinkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteLinkRequest | 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<DeleteLinkResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteLink API.
GetLink(GetLinkRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets information about the link.
Declaration
public Task<GetLinkResponse> GetLink(GetLinkRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetLinkRequest | 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<GetLinkResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetLink API.
ListLinks(ListLinksRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a (paginated) list of links.
Declaration
public Task<ListLinksResponse> ListLinks(ListLinksRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListLinksRequest | 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<ListLinksResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListLinks API.