Class TransferPackageClient
Service client instance for TransferPackage.
Implements
Inherited Members
Namespace: Oci.DtsService
Assembly: OCI.DotNetSDK.Dts.dll
Syntax
public class TransferPackageClient : RegionalClientBase, IDisposable
Constructors
TransferPackageClient(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 TransferPackageClient(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 TransferPackageWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
TransferPackageWaiters |
Methods
AttachDevicesToTransferPackage(AttachDevicesToTransferPackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Attaches Devices to a Transfer Package
Declaration
public Task<AttachDevicesToTransferPackageResponse> AttachDevicesToTransferPackage(AttachDevicesToTransferPackageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
AttachDevicesToTransferPackageRequest | 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<AttachDevicesToTransferPackageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use AttachDevicesToTransferPackage API.
CreateTransferPackage(CreateTransferPackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create a new Transfer Package
Declaration
public Task<CreateTransferPackageResponse> CreateTransferPackage(CreateTransferPackageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateTransferPackageRequest | 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<CreateTransferPackageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateTransferPackage API.
DeleteTransferPackage(DeleteTransferPackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
deletes a transfer Package
Declaration
public Task<DeleteTransferPackageResponse> DeleteTransferPackage(DeleteTransferPackageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteTransferPackageRequest | 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<DeleteTransferPackageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteTransferPackage API.
DetachDevicesFromTransferPackage(DetachDevicesFromTransferPackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Detaches Devices from a Transfer Package
Declaration
public Task<DetachDevicesFromTransferPackageResponse> DetachDevicesFromTransferPackage(DetachDevicesFromTransferPackageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DetachDevicesFromTransferPackageRequest | 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<DetachDevicesFromTransferPackageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DetachDevicesFromTransferPackage API.
GetTransferPackage(GetTransferPackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Describes a transfer package in detail
Declaration
public Task<GetTransferPackageResponse> GetTransferPackage(GetTransferPackageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetTransferPackageRequest | 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<GetTransferPackageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetTransferPackage API.
ListTransferPackages(ListTransferPackagesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists Transfer Packages associated with a transferJob
Declaration
public Task<ListTransferPackagesResponse> ListTransferPackages(ListTransferPackagesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListTransferPackagesRequest | 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<ListTransferPackagesResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListTransferPackages API.
UpdateTransferPackage(UpdateTransferPackageRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a Transfer Package
Declaration
public Task<UpdateTransferPackageResponse> UpdateTransferPackage(UpdateTransferPackageRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateTransferPackageRequest | 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<UpdateTransferPackageResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateTransferPackage API.