com.oracle.bmc.dataflow

Class DataFlowClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.dataflow.DataFlowClient

All Implemented Interfaces:

DataFlow, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200129")
public class DataFlowClient
extends BaseSyncClient
implements DataFlow

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataFlowClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for DataFlow.

Constructor Summary

Constructors

Constructor and Description
DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Deprecated. Use the builder instead.
DataFlowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
DataFlowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
DataFlowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static DataFlowClient.Builder	builder() Create a builder for this client.
ChangeApplicationCompartmentResponse	changeApplicationCompartment(ChangeApplicationCompartmentRequest request) Moves an application into a different compartment.
ChangePoolCompartmentResponse	changePoolCompartment(ChangePoolCompartmentRequest request) Moves a pool into a different compartment.
ChangePrivateEndpointCompartmentResponse	changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request) Moves a private endpoint into a different compartment.
ChangeRunCompartmentResponse	changeRunCompartment(ChangeRunCompartmentRequest request) Moves a run into a different compartment.
ChangeSqlEndpointCompartmentResponse	changeSqlEndpointCompartment(ChangeSqlEndpointCompartmentRequest request) Moves an Sql Endpoint from one compartment to another.
void	close()
CreateApplicationResponse	createApplication(CreateApplicationRequest request) Creates an application.
CreatePoolResponse	createPool(CreatePoolRequest request) Create a pool to be used by dataflow runs or applications.
CreatePrivateEndpointResponse	createPrivateEndpoint(CreatePrivateEndpointRequest request) Creates a private endpoint to be used by applications.
CreateRunResponse	createRun(CreateRunRequest request) Creates a run for an application.
CreateSqlEndpointResponse	createSqlEndpoint(CreateSqlEndpointRequest request) Create a new Sql Endpoint.
CreateStatementResponse	createStatement(CreateStatementRequest request) Executes a statement for a Session run.
DeleteApplicationResponse	deleteApplication(DeleteApplicationRequest request) Deletes an application using an applicationId.
DeletePoolResponse	deletePool(DeletePoolRequest request) Deletes a pool using a poolId.
DeletePrivateEndpointResponse	deletePrivateEndpoint(DeletePrivateEndpointRequest request) Deletes a private endpoint using a privateEndpointId.
DeleteRunResponse	deleteRun(DeleteRunRequest request) Cancels the specified run if it has not already completed or was previously cancelled.
DeleteSqlEndpointResponse	deleteSqlEndpoint(DeleteSqlEndpointRequest request) Delete a Sql Endpoint resource, identified by the SqlEndpoint id.
DeleteStatementResponse	deleteStatement(DeleteStatementRequest request) Cancels the specified statement for a Session run.
GetApplicationResponse	getApplication(GetApplicationRequest request) Retrieves an application using an applicationId.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
DataFlowPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetPoolResponse	getPool(GetPoolRequest request) Retrieves a pool using a poolId.
GetPrivateEndpointResponse	getPrivateEndpoint(GetPrivateEndpointRequest request) Retrieves an private endpoint using a privateEndpointId.
GetRunResponse	getRun(GetRunRequest request) Retrieves the run for the specified runId.
GetRunLogResponse	getRunLog(GetRunLogRequest request) Retrieves the content of an run log.
GetSqlEndpointResponse	getSqlEndpoint(GetSqlEndpointRequest request) Retrieves a SQL Endpoint using a sqlEndpointId.
GetStatementResponse	getStatement(GetStatementRequest request) Retrieves the statement corresponding to the statementId for a Session run specified by runId.
DataFlowWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Gets the status of the work request with the given OCID.
ListApplicationsResponse	listApplications(ListApplicationsRequest request) Lists all applications in the specified compartment.
ListPoolsResponse	listPools(ListPoolsRequest request) Lists all pools in the specified compartment.
ListPrivateEndpointsResponse	listPrivateEndpoints(ListPrivateEndpointsRequest request) Lists all private endpoints in the specified compartment.
ListRunLogsResponse	listRunLogs(ListRunLogsRequest request) Retrieves summaries of the run’s logs.
ListRunsResponse	listRuns(ListRunsRequest request) Lists all runs of an application in the specified compartment.
ListSqlEndpointsResponse	listSqlEndpoints(ListSqlEndpointsRequest request) Lists all Sql Endpoints in the specified compartment.
ListStatementsResponse	listStatements(ListStatementsRequest request) Lists all statements for a Session run.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Return a (paginated) list of errors for a given work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Return a paginated list of logs for a given work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) Lists the work requests in a compartment.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
void	setRegion(Region region) Sets the region to call (ex, Region.US_PHOENIX_1).
void	setRegion(String regionId) Sets the region to call (ex, ‘us-phoenix-1’).
StartPoolResponse	startPool(StartPoolRequest request) Starts the dataflow pool for a given poolId.
StopPoolResponse	stopPool(StopPoolRequest request) Stops the dataflow pool for a given poolId.
UpdateApplicationResponse	updateApplication(UpdateApplicationRequest request) Updates an application using an applicationId.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
UpdatePoolResponse	updatePool(UpdatePoolRequest request) 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.
UpdatePrivateEndpointResponse	updatePrivateEndpoint(UpdatePrivateEndpointRequest request) Updates a private endpoint using a privateEndpointId.
UpdateRunResponse	updateRun(UpdateRunRequest request) Updates a run using a runId.
UpdateSqlEndpointResponse	updateSqlEndpoint(UpdateSqlEndpointRequest request) Update a Sql Endpoint resource, identified by the SqlEndpoint id.
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.dataflow.DataFlow

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DataFlow.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

DataFlowClient

@Deprecated
public DataFlowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataFlowClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

DataFlowClient

@Deprecated
public DataFlowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataFlowClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

DataFlowClient

@Deprecated
public DataFlowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration,
                                  ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataFlowClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

DataFlowClient

@Deprecated
public DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration,
                                  ClientConfigurator clientConfigurator,
                                  RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataFlowClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DataFlowClient

@Deprecated
public DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration,
                                  ClientConfigurator clientConfigurator,
                                  RequestSignerFactory defaultRequestSignerFactory,
                                  List<ClientConfigurator> additionalClientConfigurators)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataFlowClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DataFlowClient

@Deprecated
public DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration,
                                  ClientConfigurator clientConfigurator,
                                  RequestSignerFactory defaultRequestSignerFactory,
                                  List<ClientConfigurator> additionalClientConfigurators,
                                  String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataFlowClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

DataFlowClient

@Deprecated
public DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration,
                                  ClientConfigurator clientConfigurator,
                                  RequestSignerFactory defaultRequestSignerFactory,
                                  Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                  List<ClientConfigurator> additionalClientConfigurators,
                                  String endpoint)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataFlowClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

DataFlowClient

@Deprecated
public DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                  ClientConfiguration configuration,
                                  ClientConfigurator clientConfigurator,
                                  RequestSignerFactory defaultRequestSignerFactory,
                                  Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                                  List<ClientConfigurator> additionalClientConfigurators,
                                  String endpoint,
                                  ExecutorService executorService)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DataFlowClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

executorService - DataFlowClient.Builder.executorService

Method Detail

builder

public static DataFlowClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DataFlow

Sets the region to call (ex, Region.US_PHOENIX_1).

Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

Specified by:

setRegion in interface DataFlow

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DataFlow

Sets the region to call (ex, ‘us-phoenix-1’).

Note, this will first try to map the region ID to a known Region and call setRegion.

If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

Specified by:

setRegion in interface DataFlow

Parameters:

regionId - The public region ID.

changeApplicationCompartment

public ChangeApplicationCompartmentResponse changeApplicationCompartment(ChangeApplicationCompartmentRequest request)

Description copied from interface: DataFlow

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.

Specified by:

changeApplicationCompartment in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changePoolCompartment

public ChangePoolCompartmentResponse changePoolCompartment(ChangePoolCompartmentRequest request)

Description copied from interface: DataFlow

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

Specified by:

changePoolCompartment in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changePrivateEndpointCompartment

public ChangePrivateEndpointCompartmentResponse changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request)

Description copied from interface: DataFlow

Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changePrivateEndpointCompartment in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeRunCompartment

public ChangeRunCompartmentResponse changeRunCompartment(ChangeRunCompartmentRequest request)

Description copied from interface: DataFlow

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

Specified by:

changeRunCompartment in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

changeSqlEndpointCompartment

public ChangeSqlEndpointCompartmentResponse changeSqlEndpointCompartment(ChangeSqlEndpointCompartmentRequest request)

Description copied from interface: DataFlow

Moves an Sql Endpoint from one compartment to another. When provided, If-Match is checked against ETag values of the Sql Endpoint.

Specified by:

changeSqlEndpointCompartment in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createApplication

public CreateApplicationResponse createApplication(CreateApplicationRequest request)

Description copied from interface: DataFlow

Creates an application.

Specified by:

createApplication in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createPool

public CreatePoolResponse createPool(CreatePoolRequest request)

Description copied from interface: DataFlow

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

Specified by:

createPool in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createPrivateEndpoint

public CreatePrivateEndpointResponse createPrivateEndpoint(CreatePrivateEndpointRequest request)

Description copied from interface: DataFlow

Creates a private endpoint to be used by applications.

Specified by:

createPrivateEndpoint in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createRun

public CreateRunResponse createRun(CreateRunRequest request)

Description copied from interface: DataFlow

Creates a run for an application.

Specified by:

createRun in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createSqlEndpoint

public CreateSqlEndpointResponse createSqlEndpoint(CreateSqlEndpointRequest request)

Description copied from interface: DataFlow

Create a new Sql Endpoint.

Specified by:

createSqlEndpoint in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createStatement

public CreateStatementResponse createStatement(CreateStatementRequest request)

Description copied from interface: DataFlow

Executes a statement for a Session run.

Specified by:

createStatement in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteApplication

public DeleteApplicationResponse deleteApplication(DeleteApplicationRequest request)

Description copied from interface: DataFlow

Deletes an application using an applicationId.

Specified by:

deleteApplication in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deletePool

public DeletePoolResponse deletePool(DeletePoolRequest request)

Description copied from interface: DataFlow

Deletes a pool using a poolId.

Specified by:

deletePool in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deletePrivateEndpoint

public DeletePrivateEndpointResponse deletePrivateEndpoint(DeletePrivateEndpointRequest request)

Description copied from interface: DataFlow

Deletes a private endpoint using a privateEndpointId.

Specified by:

deletePrivateEndpoint in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteRun

public DeleteRunResponse deleteRun(DeleteRunRequest request)

Description copied from interface: DataFlow

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.

Specified by:

deleteRun in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteSqlEndpoint

public DeleteSqlEndpointResponse deleteSqlEndpoint(DeleteSqlEndpointRequest request)

Description copied from interface: DataFlow

Delete a Sql Endpoint resource, identified by the SqlEndpoint id.

Specified by:

deleteSqlEndpoint in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteStatement

public DeleteStatementResponse deleteStatement(DeleteStatementRequest request)

Description copied from interface: DataFlow

Cancels the specified statement for a Session run.

Specified by:

deleteStatement in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getApplication

public GetApplicationResponse getApplication(GetApplicationRequest request)

Description copied from interface: DataFlow

Retrieves an application using an applicationId.

Specified by:

getApplication in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPool

public GetPoolResponse getPool(GetPoolRequest request)

Description copied from interface: DataFlow

Retrieves a pool using a poolId.

Specified by:

getPool in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPrivateEndpoint

public GetPrivateEndpointResponse getPrivateEndpoint(GetPrivateEndpointRequest request)

Description copied from interface: DataFlow

Retrieves an private endpoint using a privateEndpointId.

Specified by:

getPrivateEndpoint in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRun

public GetRunResponse getRun(GetRunRequest request)

Description copied from interface: DataFlow

Retrieves the run for the specified runId.

Specified by:

getRun in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRunLog

public GetRunLogResponse getRunLog(GetRunLogRequest request)

Description copied from interface: DataFlow

Retrieves the content of an run log.

Specified by:

getRunLog in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getSqlEndpoint

public GetSqlEndpointResponse getSqlEndpoint(GetSqlEndpointRequest request)

Description copied from interface: DataFlow

Retrieves a SQL Endpoint using a sqlEndpointId.

Specified by:

getSqlEndpoint in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getStatement

public GetStatementResponse getStatement(GetStatementRequest request)

Description copied from interface: DataFlow

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

Specified by:

getStatement in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: DataFlow

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

Specified by:

getWorkRequest in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listApplications

public ListApplicationsResponse listApplications(ListApplicationsRequest request)

Description copied from interface: DataFlow

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.

Specified by:

listApplications in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPools

public ListPoolsResponse listPools(ListPoolsRequest request)

Description copied from interface: DataFlow

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.

Specified by:

listPools in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listPrivateEndpoints

public ListPrivateEndpointsResponse listPrivateEndpoints(ListPrivateEndpointsRequest request)

Description copied from interface: DataFlow

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.

Specified by:

listPrivateEndpoints in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRunLogs

public ListRunLogsResponse listRunLogs(ListRunLogsRequest request)

Description copied from interface: DataFlow

Retrieves summaries of the run’s logs.

Specified by:

listRunLogs in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRuns

public ListRunsResponse listRuns(ListRunsRequest request)

Description copied from interface: DataFlow

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.

Specified by:

listRuns in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listSqlEndpoints

public ListSqlEndpointsResponse listSqlEndpoints(ListSqlEndpointsRequest request)

Description copied from interface: DataFlow

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.

Specified by:

listSqlEndpoints in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listStatements

public ListStatementsResponse listStatements(ListStatementsRequest request)

Description copied from interface: DataFlow

Lists all statements for a Session run.

Specified by:

listStatements in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: DataFlow

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

Specified by:

listWorkRequestErrors in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: DataFlow

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

Specified by:

listWorkRequestLogs in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: DataFlow

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

startPool

public StartPoolResponse startPool(StartPoolRequest request)

Description copied from interface: DataFlow

Starts the dataflow pool for a given poolId. When provided, If-Match is checked against ETag values of the resource.

Specified by:

startPool in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

stopPool

public StopPoolResponse stopPool(StopPoolRequest request)

Description copied from interface: DataFlow

Stops the dataflow pool for a given poolId. When provided, If-Match is checked against ETag values of the resource.

Specified by:

stopPool in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateApplication

public UpdateApplicationResponse updateApplication(UpdateApplicationRequest request)

Description copied from interface: DataFlow

Updates an application using an applicationId.

Specified by:

updateApplication in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updatePool

public UpdatePoolResponse updatePool(UpdatePoolRequest request)

Description copied from interface: DataFlow

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.

Specified by:

updatePool in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updatePrivateEndpoint

public UpdatePrivateEndpointResponse updatePrivateEndpoint(UpdatePrivateEndpointRequest request)

Description copied from interface: DataFlow

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.

Specified by:

updatePrivateEndpoint in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateRun

public UpdateRunResponse updateRun(UpdateRunRequest request)

Description copied from interface: DataFlow

Updates a run using a runId.

Specified by:

updateRun in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateSqlEndpoint

public UpdateSqlEndpointResponse updateSqlEndpoint(UpdateSqlEndpointRequest request)

Description copied from interface: DataFlow

Update a Sql Endpoint resource, identified by the SqlEndpoint id.

Specified by:

updateSqlEndpoint in interface DataFlow

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DataFlowWaiters getWaiters()

Description copied from interface: DataFlow

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface DataFlow

Returns:

The service waiters.

getPaginators

public DataFlowPaginators getPaginators()

Description copied from interface: DataFlow

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Specified by:

getPaginators in interface DataFlow

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()