Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ServiceConnectorClient

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

  • ServiceConnectorClient

Constructors

constructor

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

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 = "ServiceConnector"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://service-connector-hub.{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

activateServiceConnector

  • Activates the specified connector.

    After you send your request, the connector's state is temporarily UPDATING. When the state changes to ACTIVE, data begins transferring from the source service to the target service. For more information, see [Activating a Connector](https://docs.cloud.oracle.com/iaas/Content/connector-hub/activate-service-connector.htm).

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ActivateServiceConnector API.

    Parameters

    Returns Promise<ActivateServiceConnectorResponse>

    ActivateServiceConnectorResponse

changeServiceConnectorCompartment

  • Moves a connector into a different compartment within the same tenancy. For more information, see Moving a Connector.

    When provided, If-Match is checked against ETag values of the resource.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangeServiceConnectorCompartment API.

    Parameters

    Returns Promise<ChangeServiceConnectorCompartmentResponse>

    ChangeServiceConnectorCompartmentResponse

close

  • close(): void

createServiceConnector

  • Creates a new connector in the specified compartment. A connector is a logically defined flow for moving data from a source service to a destination service in Oracle Cloud Infrastructure. For more information, see Creating a Connector. For general information about connectors, see Overview of Connector Hub.

    For purposes of access control, you must provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the connector to reside. Notice that the connector doesn't have to be in the same compartment as the source or target services. For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm).

    After you send your request, the new connector's state is temporarily CREATING. When the state changes to ACTIVE, data begins transferring from the source service to the target service. For instructions on deactivating and activating connectors, see [Activating a Connector](https://docs.cloud.oracle.com/iaas/Content/connector-hub/activate-service-connector.htm).

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateServiceConnector API.

    Parameters

    Returns Promise<CreateServiceConnectorResponse>

    CreateServiceConnectorResponse

createWaiters

  • Creates a new ServiceConnectorWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns ServiceConnectorWaiter

    The service waiters.

deactivateServiceConnector

  • Deactivates the specified connector.

    After you send your request, the connector's state is temporarily UPDATING and any data transfer stops. The state then changes to INACTIVE. For more information, see [Deactivating a Connector](https://docs.cloud.oracle.com/iaas/Content/connector-hub/deactivate-service-connector.htm).

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeactivateServiceConnector API.

    Parameters

    Returns Promise<DeactivateServiceConnectorResponse>

    DeactivateServiceConnectorResponse

deleteServiceConnector

  • Deletes the specified connector. For more information, see Deleting a Connector.

    After you send your request, the connector's state is temporarily DELETING and any data transfer stops. The state then changes to DELETED.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteServiceConnector API.

    Parameters

    Returns Promise<DeleteServiceConnectorResponse>

    DeleteServiceConnectorResponse

getServiceConnector

getWaiters

getWorkRequest

listServiceConnectors

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateServiceConnector

  • Updates the configuration information for the specified connector. For more information, see Updating a Connector.

    After you send your request, the connector's state is temporarily UPDATING and any data transfer pauses. The state then changes back to its original value: if ACTIVE, then data transfer resumes.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateServiceConnector API.

    Parameters

    Returns Promise<UpdateServiceConnectorResponse>

    UpdateServiceConnectorResponse