Class TransferDeviceClient

Service client instance for TransferDevice.

Inheritance

object

ClientBase

RegionalClientBase

TransferDeviceClient

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)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.DtsService

Assembly: OCI.DotNetSDK.Dts.dll

Syntax

public class TransferDeviceClient : RegionalClientBase, IDisposable

Constructors

TransferDeviceClient(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 TransferDeviceClient(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

Waiters

Declaration

public TransferDeviceWaiters Waiters { get; }

Property Value

Type	Description
TransferDeviceWaiters

Methods

CreateTransferDevice(CreateTransferDeviceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a new Transfer Device

Declaration

public Task<CreateTransferDeviceResponse> CreateTransferDevice(CreateTransferDeviceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteTransferDevice(DeleteTransferDeviceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

deletes a transfer Device

Declaration

public Task<DeleteTransferDeviceResponse> DeleteTransferDevice(DeleteTransferDeviceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetTransferDevice(GetTransferDeviceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Describes a transfer package in detail

Declaration

public Task<GetTransferDeviceResponse> GetTransferDevice(GetTransferDeviceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListTransferDevices(ListTransferDevicesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists Transfer Devices associated with a transferJob

Declaration

public Task<ListTransferDevicesResponse> ListTransferDevices(ListTransferDevicesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateTransferDevice(UpdateTransferDeviceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a Transfer Device

Declaration

public Task<UpdateTransferDeviceResponse> UpdateTransferDevice(UpdateTransferDeviceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable