Class TransferJobClient

Service client instance for TransferJob.

Inheritance

object

ClientBase

RegionalClientBase

TransferJobClient

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

Constructors

TransferJobClient(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 TransferJobClient(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 TransferJobPaginators Paginators { get; }

Property Value

Type	Description
TransferJobPaginators

Waiters

Declaration

public TransferJobWaiters Waiters { get; }

Property Value

Type	Description
TransferJobWaiters

Methods

ChangeTransferJobCompartment(ChangeTransferJobCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Moves a TransferJob into a different compartment.

Declaration

public Task<ChangeTransferJobCompartmentResponse> ChangeTransferJobCompartment(ChangeTransferJobCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

CreateTransferJob(CreateTransferJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Create a new Transfer Job that corresponds with customer's logical dataset e.g. a DB or a filesystem.

Declaration

public Task<CreateTransferJobResponse> CreateTransferJob(CreateTransferJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

DeleteTransferJob(DeleteTransferJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

deletes a transfer job

Declaration

public Task<DeleteTransferJobResponse> DeleteTransferJob(DeleteTransferJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

GetTransferJob(GetTransferJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Describes a transfer job in detail

Declaration

public Task<GetTransferJobResponse> GetTransferJob(GetTransferJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

ListTransferJobs(ListTransferJobsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists Transfer Jobs in a given compartment

Declaration

public Task<ListTransferJobsResponse> ListTransferJobs(ListTransferJobsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

UpdateTransferJob(UpdateTransferJobRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates a Transfer Job that corresponds with customer's logical dataset e.g. a DB or a filesystem.

Declaration

public Task<UpdateTransferJobResponse> UpdateTransferJob(UpdateTransferJobRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

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

Examples

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

Implements

IDisposable