/** * Data Transfer Service API * Data Transfer Service API Specification * OpenAPI spec version: 1.0.017 * * * NOTE: This class is auto generated by OracleSDKGenerator. * Do not edit the class manually. * * Copyright (c) 2020, 2025, Oracle and/or its affiliates. All rights reserved. * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license. */ import common = require("oci-common"); import * as requests from "./request"; import * as model from "./model"; import * as responses from "./response"; import { ApplianceExportJobWaiter } from "./applianceexportjob-waiter"; import { TransferApplianceWaiter } from "./transferappliance-waiter"; import { TransferApplianceEntitlementWaiter } from "./transferapplianceentitlement-waiter"; import { TransferDeviceWaiter } from "./transferdevice-waiter"; import { TransferJobWaiter } from "./transferjob-waiter"; import { TransferPackageWaiter } from "./transferpackage-waiter"; declare const Breaker: any; export declare enum ApplianceExportJobApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class ApplianceExportJobClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": ApplianceExportJobWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); /** * Creates a new ApplianceExportJobWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): ApplianceExportJobWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): ApplianceExportJobWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Moves a ApplianceExportJob into a different compartment. * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeApplianceExportJobCompartmentRequest * @return ChangeApplianceExportJobCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/ChangeApplianceExportJobCompartment.ts.html |here} to see how to use ChangeApplianceExportJobCompartment API. */ changeApplianceExportJobCompartment(changeApplianceExportJobCompartmentRequest: requests.ChangeApplianceExportJobCompartmentRequest): Promise; /** * Creates a new Appliance Export Job that corresponds with customer's logical dataset * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateApplianceExportJobRequest * @return CreateApplianceExportJobResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/CreateApplianceExportJob.ts.html |here} to see how to use CreateApplianceExportJob API. */ createApplianceExportJob(createApplianceExportJobRequest: requests.CreateApplianceExportJobRequest): Promise; /** * deletes a Appliance Export Job * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteApplianceExportJobRequest * @return DeleteApplianceExportJobResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/DeleteApplianceExportJob.ts.html |here} to see how to use DeleteApplianceExportJob API. */ deleteApplianceExportJob(deleteApplianceExportJobRequest: requests.DeleteApplianceExportJobRequest): Promise; /** * Describes a Appliance Export Job in detail * This operation does not retry by default if the user has not defined a retry configuration. * @param GetApplianceExportJobRequest * @return GetApplianceExportJobResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/GetApplianceExportJob.ts.html |here} to see how to use GetApplianceExportJob API. */ getApplianceExportJob(getApplianceExportJobRequest: requests.GetApplianceExportJobRequest): Promise; /** * Lists Appliance Export Jobs in a given compartment * This operation does not retry by default if the user has not defined a retry configuration. * @param ListApplianceExportJobsRequest * @return ListApplianceExportJobsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/ListApplianceExportJobs.ts.html |here} to see how to use ListApplianceExportJobs API. */ listApplianceExportJobs(listApplianceExportJobsRequest: requests.ListApplianceExportJobsRequest): Promise; /** * NOTE: This function is deprecated in favor of listApplianceExportJobsRecordIterator function. * Creates a new async iterator which will iterate over the models.ApplianceExportJobSummary objects * contained in responses from the listApplianceExportJobs operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listAllApplianceExportJobs(request: requests.ListApplianceExportJobsRequest): AsyncIterableIterator; /** * NOTE: This function is deprecated in favor of listApplianceExportJobsResponseIterator function. * Creates a new async iterator which will iterate over the responses received from the listApplianceExportJobs operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listAllApplianceExportJobsResponses(request: requests.ListApplianceExportJobsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the models.ApplianceExportJobSummary objects * contained in responses from the listApplianceExportJobs operation. This iterator will fetch more data from the * server as needed. * * @param request a request which can be sent to the service operation */ listApplianceExportJobsRecordIterator(request: requests.ListApplianceExportJobsRequest): AsyncIterableIterator; /** * Creates a new async iterator which will iterate over the responses received from the listApplianceExportJobs operation. This iterator * will fetch more data from the server as needed. * * @param request a request which can be sent to the service operation */ listApplianceExportJobsResponseIterator(request: requests.ListApplianceExportJobsRequest): AsyncIterableIterator; /** * Updates a Appliance Export Job that corresponds with customer's logical dataset. * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateApplianceExportJobRequest * @return UpdateApplianceExportJobResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/UpdateApplianceExportJob.ts.html |here} to see how to use UpdateApplianceExportJob API. */ updateApplianceExportJob(updateApplianceExportJobRequest: requests.UpdateApplianceExportJobRequest): Promise; } export declare enum ShippingVendorsApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class ShippingVendorsClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Lists available shipping vendors for Transfer Package delivery * This operation does not retry by default if the user has not defined a retry configuration. * @param ListShippingVendorsRequest * @return ListShippingVendorsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/ListShippingVendors.ts.html |here} to see how to use ListShippingVendors API. */ listShippingVendors(listShippingVendorsRequest: requests.ListShippingVendorsRequest): Promise; } export declare enum TransferApplianceApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class TransferApplianceClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": TransferApplianceWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); /** * Creates a new TransferApplianceWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): TransferApplianceWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): TransferApplianceWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Create a new Transfer Appliance * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateTransferApplianceRequest * @return CreateTransferApplianceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/CreateTransferAppliance.ts.html |here} to see how to use CreateTransferAppliance API. */ createTransferAppliance(createTransferApplianceRequest: requests.CreateTransferApplianceRequest): Promise; /** * Creates an X.509 certificate from a public key * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateTransferApplianceAdminCredentialsRequest * @return CreateTransferApplianceAdminCredentialsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/CreateTransferApplianceAdminCredentials.ts.html |here} to see how to use CreateTransferApplianceAdminCredentials API. */ createTransferApplianceAdminCredentials(createTransferApplianceAdminCredentialsRequest: requests.CreateTransferApplianceAdminCredentialsRequest): Promise; /** * deletes a transfer Appliance * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteTransferApplianceRequest * @return DeleteTransferApplianceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/DeleteTransferAppliance.ts.html |here} to see how to use DeleteTransferAppliance API. */ deleteTransferAppliance(deleteTransferApplianceRequest: requests.DeleteTransferApplianceRequest): Promise; /** * Describes a transfer appliance in detail * This operation does not retry by default if the user has not defined a retry configuration. * @param GetTransferApplianceRequest * @return GetTransferApplianceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/GetTransferAppliance.ts.html |here} to see how to use GetTransferAppliance API. */ getTransferAppliance(getTransferApplianceRequest: requests.GetTransferApplianceRequest): Promise; /** * Gets the x.509 certificate for the Transfer Appliance's dedicated Certificate Authority (CA) * This operation does not retry by default if the user has not defined a retry configuration. * @param GetTransferApplianceCertificateAuthorityCertificateRequest * @return GetTransferApplianceCertificateAuthorityCertificateResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/GetTransferApplianceCertificateAuthorityCertificate.ts.html |here} to see how to use GetTransferApplianceCertificateAuthorityCertificate API. */ getTransferApplianceCertificateAuthorityCertificate(getTransferApplianceCertificateAuthorityCertificateRequest: requests.GetTransferApplianceCertificateAuthorityCertificateRequest): Promise; /** * Describes a transfer appliance encryptionPassphrase in detail * This operation does not retry by default if the user has not defined a retry configuration. * @param GetTransferApplianceEncryptionPassphraseRequest * @return GetTransferApplianceEncryptionPassphraseResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/GetTransferApplianceEncryptionPassphrase.ts.html |here} to see how to use GetTransferApplianceEncryptionPassphrase API. */ getTransferApplianceEncryptionPassphrase(getTransferApplianceEncryptionPassphraseRequest: requests.GetTransferApplianceEncryptionPassphraseRequest): Promise; /** * Lists Transfer Appliances associated with a transferJob * This operation does not retry by default if the user has not defined a retry configuration. * @param ListTransferAppliancesRequest * @return ListTransferAppliancesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/ListTransferAppliances.ts.html |here} to see how to use ListTransferAppliances API. */ listTransferAppliances(listTransferAppliancesRequest: requests.ListTransferAppliancesRequest): Promise; /** * Updates a Transfer Appliance * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateTransferApplianceRequest * @return UpdateTransferApplianceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/UpdateTransferAppliance.ts.html |here} to see how to use UpdateTransferAppliance API. */ updateTransferAppliance(updateTransferApplianceRequest: requests.UpdateTransferApplianceRequest): Promise; } export declare enum TransferApplianceEntitlementApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class TransferApplianceEntitlementClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": TransferApplianceEntitlementWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); /** * Creates a new TransferApplianceEntitlementWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): TransferApplianceEntitlementWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): TransferApplianceEntitlementWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Create the Entitlement to use a Transfer Appliance. It requires some offline process of review and signatures before request is granted. * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateTransferApplianceEntitlementRequest * @return CreateTransferApplianceEntitlementResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/CreateTransferApplianceEntitlement.ts.html |here} to see how to use CreateTransferApplianceEntitlement API. */ createTransferApplianceEntitlement(createTransferApplianceEntitlementRequest: requests.CreateTransferApplianceEntitlementRequest): Promise; /** * Describes the Transfer Appliance Entitlement in detail * This operation does not retry by default if the user has not defined a retry configuration. * @param GetTransferApplianceEntitlementRequest * @return GetTransferApplianceEntitlementResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/GetTransferApplianceEntitlement.ts.html |here} to see how to use GetTransferApplianceEntitlement API. */ getTransferApplianceEntitlement(getTransferApplianceEntitlementRequest: requests.GetTransferApplianceEntitlementRequest): Promise; /** * Lists Transfer Transfer Appliance Entitlement * This operation does not retry by default if the user has not defined a retry configuration. * @param ListTransferApplianceEntitlementRequest * @return ListTransferApplianceEntitlementResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/ListTransferApplianceEntitlement.ts.html |here} to see how to use ListTransferApplianceEntitlement API. */ listTransferApplianceEntitlement(listTransferApplianceEntitlementRequest: requests.ListTransferApplianceEntitlementRequest): Promise; } export declare enum TransferDeviceApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class TransferDeviceClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": TransferDeviceWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); /** * Creates a new TransferDeviceWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): TransferDeviceWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): TransferDeviceWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Create a new Transfer Device * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateTransferDeviceRequest * @return CreateTransferDeviceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/CreateTransferDevice.ts.html |here} to see how to use CreateTransferDevice API. */ createTransferDevice(createTransferDeviceRequest: requests.CreateTransferDeviceRequest): Promise; /** * deletes a transfer Device * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteTransferDeviceRequest * @return DeleteTransferDeviceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/DeleteTransferDevice.ts.html |here} to see how to use DeleteTransferDevice API. */ deleteTransferDevice(deleteTransferDeviceRequest: requests.DeleteTransferDeviceRequest): Promise; /** * Describes a transfer package in detail * This operation does not retry by default if the user has not defined a retry configuration. * @param GetTransferDeviceRequest * @return GetTransferDeviceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/GetTransferDevice.ts.html |here} to see how to use GetTransferDevice API. */ getTransferDevice(getTransferDeviceRequest: requests.GetTransferDeviceRequest): Promise; /** * Lists Transfer Devices associated with a transferJob * This operation does not retry by default if the user has not defined a retry configuration. * @param ListTransferDevicesRequest * @return ListTransferDevicesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/ListTransferDevices.ts.html |here} to see how to use ListTransferDevices API. */ listTransferDevices(listTransferDevicesRequest: requests.ListTransferDevicesRequest): Promise; /** * Updates a Transfer Device * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateTransferDeviceRequest * @return UpdateTransferDeviceResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/UpdateTransferDevice.ts.html |here} to see how to use UpdateTransferDevice API. */ updateTransferDevice(updateTransferDeviceRequest: requests.UpdateTransferDeviceRequest): Promise; } export declare enum TransferJobApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class TransferJobClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": TransferJobWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); /** * Creates a new TransferJobWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): TransferJobWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): TransferJobWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Moves a TransferJob into a different compartment. * This operation does not retry by default if the user has not defined a retry configuration. * @param ChangeTransferJobCompartmentRequest * @return ChangeTransferJobCompartmentResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/ChangeTransferJobCompartment.ts.html |here} to see how to use ChangeTransferJobCompartment API. */ changeTransferJobCompartment(changeTransferJobCompartmentRequest: requests.ChangeTransferJobCompartmentRequest): Promise; /** * 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. * @param CreateTransferJobRequest * @return CreateTransferJobResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/CreateTransferJob.ts.html |here} to see how to use CreateTransferJob API. */ createTransferJob(createTransferJobRequest: requests.CreateTransferJobRequest): Promise; /** * deletes a transfer job * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteTransferJobRequest * @return DeleteTransferJobResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/DeleteTransferJob.ts.html |here} to see how to use DeleteTransferJob API. */ deleteTransferJob(deleteTransferJobRequest: requests.DeleteTransferJobRequest): Promise; /** * Describes a transfer job in detail * This operation does not retry by default if the user has not defined a retry configuration. * @param GetTransferJobRequest * @return GetTransferJobResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/GetTransferJob.ts.html |here} to see how to use GetTransferJob API. */ getTransferJob(getTransferJobRequest: requests.GetTransferJobRequest): Promise; /** * Lists Transfer Jobs in a given compartment * This operation does not retry by default if the user has not defined a retry configuration. * @param ListTransferJobsRequest * @return ListTransferJobsResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/ListTransferJobs.ts.html |here} to see how to use ListTransferJobs API. */ listTransferJobs(listTransferJobsRequest: requests.ListTransferJobsRequest): Promise; /** * 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. * * @param request a request which can be sent to the service operation */ listAllTransferJobs(request: requests.ListTransferJobsRequest): AsyncIterableIterator; /** * 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. * * @param request a request which can be sent to the service operation */ listAllTransferJobsResponses(request: requests.ListTransferJobsRequest): AsyncIterableIterator; /** * 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. * * @param request a request which can be sent to the service operation */ listTransferJobsRecordIterator(request: requests.ListTransferJobsRequest): AsyncIterableIterator; /** * 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. * * @param request a request which can be sent to the service operation */ listTransferJobsResponseIterator(request: requests.ListTransferJobsRequest): AsyncIterableIterator; /** * 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. * @param UpdateTransferJobRequest * @return UpdateTransferJobResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/UpdateTransferJob.ts.html |here} to see how to use UpdateTransferJob API. */ updateTransferJob(updateTransferJobRequest: requests.UpdateTransferJobRequest): Promise; } export declare enum TransferPackageApiKeys { } /** * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user. */ export declare class TransferPackageClient { protected static serviceEndpointTemplate: string; protected static endpointServiceName: string; protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined; protected "_endpoint": string; protected "_defaultHeaders": any; protected "_waiters": TransferPackageWaiter; protected "_clientConfiguration": common.ClientConfiguration; protected _circuitBreaker: typeof Breaker | null; protected _httpOptions: any; protected _bodyDuplexMode: any; targetService: string; protected _regionId: string; protected "_region": common.Region; protected _lastSetRegionOrRegionId: string; protected _httpClient: common.HttpClient; protected _authProvider: common.AuthenticationDetailsProvider | undefined; constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration); /** * Get the endpoint that is being used to call (ex, https://www.example.com). */ get endpoint(): string; /** * Sets the endpoint to call (ex, https://www.example.com). * @param endpoint The endpoint of the service. */ set endpoint(endpoint: string); get logger(): import("oci-common/lib/log").Logger; /** * 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" * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template */ set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean); /** * Sets the region to call (ex, Region.US_PHOENIX_1). * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint. * @param region The region of the service. */ set region(region: common.Region); /** * 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}. * @param regionId The public region ID. */ set regionId(regionId: string); /** * Creates a new TransferPackageWaiter for resources for this service. * * @param config The waiter configuration for termination and delay strategy * @return The service waiters. */ createWaiters(config?: common.WaiterConfiguration): TransferPackageWaiter; /** * Gets the waiters available for resources for this service. * * @return The service waiters. */ getWaiters(): TransferPackageWaiter; /** * Shutdown the circuit breaker used by the client when it is no longer needed */ shutdownCircuitBreaker(): void; /** * Close the provider if possible which in turn shuts down any associated circuit breaker */ closeProvider(): void; /** * Close the client once it is no longer needed */ close(): void; /** * Attaches Devices to a Transfer Package * This operation does not retry by default if the user has not defined a retry configuration. * @param AttachDevicesToTransferPackageRequest * @return AttachDevicesToTransferPackageResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/AttachDevicesToTransferPackage.ts.html |here} to see how to use AttachDevicesToTransferPackage API. */ attachDevicesToTransferPackage(attachDevicesToTransferPackageRequest: requests.AttachDevicesToTransferPackageRequest): Promise; /** * Create a new Transfer Package * This operation does not retry by default if the user has not defined a retry configuration. * @param CreateTransferPackageRequest * @return CreateTransferPackageResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/CreateTransferPackage.ts.html |here} to see how to use CreateTransferPackage API. */ createTransferPackage(createTransferPackageRequest: requests.CreateTransferPackageRequest): Promise; /** * deletes a transfer Package * This operation does not retry by default if the user has not defined a retry configuration. * @param DeleteTransferPackageRequest * @return DeleteTransferPackageResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/DeleteTransferPackage.ts.html |here} to see how to use DeleteTransferPackage API. */ deleteTransferPackage(deleteTransferPackageRequest: requests.DeleteTransferPackageRequest): Promise; /** * Detaches Devices from a Transfer Package * This operation does not retry by default if the user has not defined a retry configuration. * @param DetachDevicesFromTransferPackageRequest * @return DetachDevicesFromTransferPackageResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/DetachDevicesFromTransferPackage.ts.html |here} to see how to use DetachDevicesFromTransferPackage API. */ detachDevicesFromTransferPackage(detachDevicesFromTransferPackageRequest: requests.DetachDevicesFromTransferPackageRequest): Promise; /** * Describes a transfer package in detail * This operation does not retry by default if the user has not defined a retry configuration. * @param GetTransferPackageRequest * @return GetTransferPackageResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/GetTransferPackage.ts.html |here} to see how to use GetTransferPackage API. */ getTransferPackage(getTransferPackageRequest: requests.GetTransferPackageRequest): Promise; /** * Lists Transfer Packages associated with a transferJob * This operation does not retry by default if the user has not defined a retry configuration. * @param ListTransferPackagesRequest * @return ListTransferPackagesResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/ListTransferPackages.ts.html |here} to see how to use ListTransferPackages API. */ listTransferPackages(listTransferPackagesRequest: requests.ListTransferPackagesRequest): Promise; /** * Updates a Transfer Package * This operation does not retry by default if the user has not defined a retry configuration. * @param UpdateTransferPackageRequest * @return UpdateTransferPackageResponse * @throws OciError when an error occurs * @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/dts/UpdateTransferPackage.ts.html |here} to see how to use UpdateTransferPackage API. */ updateTransferPackage(updateTransferPackageRequest: requests.UpdateTransferPackageRequest): Promise; } export {};