Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TransferJobClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • TransferJobClient

Constructors

constructor

  • new TransferJobClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): TransferJobClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "TransferJob"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://datatransfer.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeTransferJobCompartment

close

  • close(): void

createTransferJob

  • Create a new Transfer Job that corresponds with customer's logical dataset e.g. a DB or a filesystem. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateTransferJob API.

    Parameters

    Returns Promise<CreateTransferJobResponse>

    CreateTransferJobResponse

createWaiters

  • Creates a new TransferJobWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns TransferJobWaiter

    The service waiters.

deleteTransferJob

getTransferJob

  • Describes a transfer job in detail This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTransferJob API.

    Parameters

    Returns Promise<GetTransferJobResponse>

    GetTransferJobResponse

getWaiters

listAllTransferJobs

  • NOTE: This function is deprecated in favor of listTransferJobsRecordIterator function. Creates a new async iterator which will iterate over the models.TransferJobSummary objects contained in responses from the listTransferJobs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TransferJobSummary>

listAllTransferJobsResponses

  • NOTE: This function is deprecated in favor of listTransferJobsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listTransferJobs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListTransferJobsResponse>

listTransferJobs

  • Lists Transfer Jobs in a given compartment This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListTransferJobs API.

    Parameters

    Returns Promise<ListTransferJobsResponse>

    ListTransferJobsResponse

listTransferJobsRecordIterator

  • Creates a new async iterator which will iterate over the models.TransferJobSummary objects contained in responses from the listTransferJobs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TransferJobSummary>

listTransferJobsResponseIterator

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateTransferJob

  • Updates a Transfer Job that corresponds with customer's logical dataset e.g. a DB or a filesystem. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateTransferJob API.

    Parameters

    Returns Promise<UpdateTransferJobResponse>

    UpdateTransferJobResponse