Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IntegrationInstanceClient

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

  • IntegrationInstanceClient

Constructors

constructor

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

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

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://integration.{region}.ocp.{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

changeIntegrationInstanceCompartment

changeIntegrationInstanceNetworkEndpoint

changePrivateEndpointOutboundConnection

close

  • close(): void

createIntegrationInstance

createWaiters

deleteIntegrationInstance

enableProcessAutomation

getIntegrationInstance

getWaiters

getWorkRequest

listAllIntegrationInstances

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

    Parameters

    Returns AsyncIterableIterator<IntegrationInstanceSummary>

listAllIntegrationInstancesResponses

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

    Parameters

    Returns AsyncIterableIterator<ListIntegrationInstancesResponse>

listAllWorkRequestErrors

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listAllWorkRequestErrorsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestErrorsResponse>

listAllWorkRequestLogs

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listAllWorkRequestLogsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestLogsResponse>

listAllWorkRequests

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listAllWorkRequestsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestsResponse>

listIntegrationInstances

listIntegrationInstancesRecordIterator

listIntegrationInstancesResponseIterator

listWorkRequestErrors

listWorkRequestErrorsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listWorkRequestErrorsResponseIterator

listWorkRequestLogs

listWorkRequestLogsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listWorkRequestLogsResponseIterator

listWorkRequests

listWorkRequestsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listWorkRequestsResponseIterator

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

startIntegrationInstance

stopIntegrationInstance

updateIntegrationInstance