Class TransferApplianceClient

Service client instance for TransferAppliance.

Inheritance

object

ClientBase

RegionalClientBase

TransferApplianceClient

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

Constructors

TransferApplianceClient(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 TransferApplianceClient(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 TransferApplianceWaiters Waiters { get; }

Property Value

Type	Description
TransferApplianceWaiters

Methods

CreateTransferAppliance(CreateTransferApplianceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a new Transfer Appliance

Declaration

public Task<CreateTransferApplianceResponse> CreateTransferAppliance(CreateTransferApplianceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateTransferApplianceAdminCredentials(CreateTransferApplianceAdminCredentialsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates an X.509 certificate from a public key

Declaration

public Task<CreateTransferApplianceAdminCredentialsResponse> CreateTransferApplianceAdminCredentials(CreateTransferApplianceAdminCredentialsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteTransferAppliance(DeleteTransferApplianceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

deletes a transfer Appliance

Declaration

public Task<DeleteTransferApplianceResponse> DeleteTransferAppliance(DeleteTransferApplianceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetTransferAppliance(GetTransferApplianceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Describes a transfer appliance in detail

Declaration

public Task<GetTransferApplianceResponse> GetTransferAppliance(GetTransferApplianceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetTransferApplianceCertificateAuthorityCertificate(GetTransferApplianceCertificateAuthorityCertificateRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Gets the x.509 certificate for the Transfer Appliance's dedicated Certificate Authority (CA)

Declaration

public Task<GetTransferApplianceCertificateAuthorityCertificateResponse> GetTransferApplianceCertificateAuthorityCertificate(GetTransferApplianceCertificateAuthorityCertificateRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetTransferApplianceEncryptionPassphrase(GetTransferApplianceEncryptionPassphraseRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Describes a transfer appliance encryptionPassphrase in detail

Declaration

public Task<GetTransferApplianceEncryptionPassphraseResponse> GetTransferApplianceEncryptionPassphrase(GetTransferApplianceEncryptionPassphraseRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListTransferAppliances(ListTransferAppliancesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists Transfer Appliances associated with a transferJob

Declaration

public Task<ListTransferAppliancesResponse> ListTransferAppliances(ListTransferAppliancesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateTransferAppliance(UpdateTransferApplianceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a Transfer Appliance

Declaration

public Task<UpdateTransferApplianceResponse> UpdateTransferAppliance(UpdateTransferApplianceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable