Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DataFlowClient

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

  • DataFlowClient

Constructors

constructor

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

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

_waiters: DataFlowWaiter

targetService

targetService: string = "DataFlow"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

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

changeApplicationCompartment

  • Moves an application into a different compartment. When provided, If-Match is checked against ETag values of the resource. Associated resources, like runs, will not be automatically moved.

    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 ChangeApplicationCompartment API.

    Parameters

    Returns Promise<ChangeApplicationCompartmentResponse>

    ChangeApplicationCompartmentResponse

changePoolCompartment

  • Moves a pool into a different compartment. When provided, If-Match is checked against ETag values of the resource. Associated resources, like historical metrics, will not be automatically moved. The pool must be in a terminal state (STOPPED, FAILED) in order for it to be moved to a different compartment

    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 ChangePoolCompartment API.

    Parameters

    Returns Promise<ChangePoolCompartmentResponse>

    ChangePoolCompartmentResponse

changePrivateEndpointCompartment

changeRunCompartment

  • Moves a run into a different compartment. When provided, If-Match is checked against ETag values of the resource. Associated resources, like historical metrics, will not be automatically moved. The run must be in a terminal state (CANCELED, FAILED, SUCCEEDED) in order for it to be moved to a different 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 ChangeRunCompartment API.

    Parameters

    Returns Promise<ChangeRunCompartmentResponse>

    ChangeRunCompartmentResponse

changeSqlEndpointCompartment

  • Moves an Sql Endpoint from one compartment to another. When provided, If-Match is checked against ETag values of the Sql Endpoint. 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 ChangeSqlEndpointCompartment API.

    Parameters

    Returns Promise<ChangeSqlEndpointCompartmentResponse>

    ChangeSqlEndpointCompartmentResponse

close

  • close(): void

createApplication

createPool

  • Create a pool to be used by dataflow runs or applications.

    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 CreatePool API.

    Parameters

    Returns Promise<CreatePoolResponse>

    CreatePoolResponse

createPrivateEndpoint

createRun

  • Creates a run for an application.

    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 CreateRun API.

    Parameters

    Returns Promise<CreateRunResponse>

    CreateRunResponse

createSqlEndpoint

createStatement

createWaiters

  • Creates a new DataFlowWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns DataFlowWaiter

    The service waiters.

deleteApplication

deletePool

  • Deletes a pool using a poolId.

    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 DeletePool API.

    Parameters

    Returns Promise<DeletePoolResponse>

    DeletePoolResponse

deletePrivateEndpoint

deleteRun

  • Cancels the specified run if it has not already completed or was previously cancelled. If a run is in progress, the executing job will be killed.

    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 DeleteRun API.

    Parameters

    Returns Promise<DeleteRunResponse>

    DeleteRunResponse

deleteSqlEndpoint

  • Delete a Sql Endpoint resource, identified by the SqlEndpoint id. 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 DeleteSqlEndpoint API.

    Parameters

    Returns Promise<DeleteSqlEndpointResponse>

    DeleteSqlEndpointResponse

deleteStatement

  • Cancels the specified statement for a Session run.

    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 DeleteStatement API.

    Parameters

    Returns Promise<DeleteStatementResponse>

    DeleteStatementResponse

getApplication

  • Retrieves an application using an applicationId.

    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 GetApplication API.

    Parameters

    Returns Promise<GetApplicationResponse>

    GetApplicationResponse

getPool

  • Retrieves a pool using a poolId.

    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 GetPool API.

    Parameters

    Returns Promise<GetPoolResponse>

    GetPoolResponse

getPrivateEndpoint

  • Retrieves an private endpoint using a privateEndpointId.

    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 GetPrivateEndpoint API.

    Parameters

    Returns Promise<GetPrivateEndpointResponse>

    GetPrivateEndpointResponse

getRun

  • Retrieves the run for the specified runId.

    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 GetRun API.

    Parameters

    Returns Promise<GetRunResponse>

    GetRunResponse

getRunLog

  • Retrieves the content of an run log.

    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 GetRunLog API.

    Parameters

    Returns Promise<GetRunLogResponse>

    GetRunLogResponse

getSqlEndpoint

  • Retrieves a SQL Endpoint using a sqlEndpointId. 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 GetSqlEndpoint API.

    Parameters

    Returns Promise<GetSqlEndpointResponse>

    GetSqlEndpointResponse

getStatement

  • Retrieves the statement corresponding to the statementId for a Session run specified by runId.

    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 GetStatement API.

    Parameters

    Returns Promise<GetStatementResponse>

    GetStatementResponse

getWaiters

getWorkRequest

  • Gets the status of the work request with the given OCID.

    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 GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listAllApplications

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

    Parameters

    Returns AsyncIterableIterator<ApplicationSummary>

listAllApplicationsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListApplicationsResponse>

listAllRunLogs

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

    Parameters

    Returns AsyncIterableIterator<RunLogSummary>

listAllRunLogsResponses

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

    Parameters

    Returns AsyncIterableIterator<ListRunLogsResponse>

listAllRuns

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

    Parameters

    • request: ListRunsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<RunSummary>

listAllRunsResponses

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

    Parameters

    • request: ListRunsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListRunsResponse>

listApplications

  • Lists all applications in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.

    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 ListApplications API.

    Parameters

    Returns Promise<ListApplicationsResponse>

    ListApplicationsResponse

listApplicationsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<ApplicationSummary>

listApplicationsResponseIterator

listPools

  • Lists all pools in the specified compartment. The query must include compartmentId. The query may also include one other parameter. If the query does not include compartmentId, or includes compartmentId, but with two or more other parameters, an error is returned.

    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 ListPools API.

    Parameters

    Returns Promise<ListPoolsResponse>

    ListPoolsResponse

listPrivateEndpoints

  • Lists all private endpoints in the specified compartment. The query must include compartmentId. The query may also include one other parameter. If the query does not include compartmentId, or includes compartmentId, but with two or more other parameters, an error is returned.

    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 ListPrivateEndpoints API.

    Parameters

    Returns Promise<ListPrivateEndpointsResponse>

    ListPrivateEndpointsResponse

listRunLogs

  • Retrieves summaries of the run's logs.

    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 ListRunLogs API.

    Parameters

    Returns Promise<ListRunLogsResponse>

    ListRunLogsResponse

listRunLogsRecordIterator

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

    Parameters

    Returns AsyncIterableIterator<RunLogSummary>

listRunLogsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listRunLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListRunLogsResponse>

listRuns

  • Lists all runs of an application in the specified compartment. Only one parameter other than compartmentId may also be included in a query. The query must include compartmentId. If the query does not include compartmentId, or includes compartmentId but two or more other parameters an error is returned.

    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 ListRuns API.

    Parameters

    Returns Promise<ListRunsResponse>

    ListRunsResponse

listRunsRecordIterator

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

    Parameters

    • request: ListRunsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<RunSummary>

listRunsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listRuns operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListRunsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListRunsResponse>

listSqlEndpoints

  • Lists all Sql Endpoints in the specified compartment. The query must include compartmentId or sqlEndpointId. If the query does not include either compartmentId or sqlEndpointId, an error is returned.

    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 ListSqlEndpoints API.

    Parameters

    Returns Promise<ListSqlEndpointsResponse>

    ListSqlEndpointsResponse

listStatements

  • Lists all statements for a Session run.

    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 ListStatements API.

    Parameters

    Returns Promise<ListStatementsResponse>

    ListStatementsResponse

listWorkRequestErrors

  • Return a (paginated) list of errors for a given work request.

    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 ListWorkRequestErrors API.

    Parameters

    Returns Promise<ListWorkRequestErrorsResponse>

    ListWorkRequestErrorsResponse

listWorkRequestLogs

  • Return a paginated list of logs for a given work request.

    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 ListWorkRequestLogs API.

    Parameters

    Returns Promise<ListWorkRequestLogsResponse>

    ListWorkRequestLogsResponse

listWorkRequests

  • Lists the work requests in a compartment.

    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 ListWorkRequests API.

    Parameters

    Returns Promise<ListWorkRequestsResponse>

    ListWorkRequestsResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

startPool

  • Starts the dataflow pool for a given poolId. 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 StartPool API.

    Parameters

    Returns Promise<StartPoolResponse>

    StartPoolResponse

stopPool

  • Stops the dataflow pool for a given poolId. 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 StopPool API.

    Parameters

    Returns Promise<StopPoolResponse>

    StopPoolResponse

updateApplication

updatePool

  • Updates a pool using a poolId.If changes to a pool doesn't match a previously defined pool,then a 409 status code will be returned.This indicates that a conflict has been detected.

    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 UpdatePool API.

    Parameters

    Returns Promise<UpdatePoolResponse>

    UpdatePoolResponse

updatePrivateEndpoint

  • Updates a private endpoint using a privateEndpointId. If changes to a private endpoint match a previously defined private endpoint, then a 409 status code will be returned. This indicates that a conflict has been detected.

    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 UpdatePrivateEndpoint API.

    Parameters

    Returns Promise<UpdatePrivateEndpointResponse>

    UpdatePrivateEndpointResponse

updateRun

  • Updates a run using a runId.

    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 UpdateRun API.

    Parameters

    Returns Promise<UpdateRunResponse>

    UpdateRunResponse

updateSqlEndpoint

  • Update a Sql Endpoint resource, identified by the SqlEndpoint id. 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 UpdateSqlEndpoint API.

    Parameters

    Returns Promise<UpdateSqlEndpointResponse>

    UpdateSqlEndpointResponse