com.oracle.bmc.dataflow

Interface DataFlow

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

DataFlowClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200129")
public interface DataFlow
extends AutoCloseable

Use the Data Flow APIs to run any Apache Spark application at any scale without deploying or managing any infrastructure.

Method Summary

Modifier and Type	Method and Description
ChangeApplicationCompartmentResponse	changeApplicationCompartment(ChangeApplicationCompartmentRequest request) Moves an application 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.
CreateApplicationResponse	createApplication(CreateApplicationRequest request) Creates an application.
CreatePrivateEndpointResponse	createPrivateEndpoint(CreatePrivateEndpointRequest request) Creates a private endpoint to be used by an application.
CreateRunResponse	createRun(CreateRunRequest request) Creates a run for an application.
DeleteApplicationResponse	deleteApplication(DeleteApplicationRequest request) Deletes an application using an applicationId.
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.
GetApplicationResponse	getApplication(GetApplicationRequest request) Retrieves an application using an applicationId.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
DataFlowPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
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.
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.
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.
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	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
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’).
UpdateApplicationResponse	updateApplication(UpdateApplicationRequest request) Updates an application using an applicationId.
UpdatePrivateEndpointResponse	updatePrivateEndpoint(UpdatePrivateEndpointRequest request) Updates a private endpoint using a privateEndpointId.
UpdateRunResponse	updateRun(UpdateRunRequest request) Updates a run using a runId.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

setRegion

void setRegion(Region region)

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.

Parameters:

region - The region of the service.

setRegion

void setRegion(String regionId)

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.

Parameters:

regionId - The public region ID.

changeApplicationCompartment

ChangeApplicationCompartmentResponse changeApplicationCompartment(ChangeApplicationCompartmentRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ChangeApplicationCompartment API.

changePrivateEndpointCompartment

ChangePrivateEndpointCompartmentResponse changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ChangePrivateEndpointCompartment API.

changeRunCompartment

ChangeRunCompartmentResponse changeRunCompartment(ChangeRunCompartmentRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ChangeRunCompartment API.

createApplication

CreateApplicationResponse createApplication(CreateApplicationRequest request)

Creates an application.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateApplication API.

createPrivateEndpoint

CreatePrivateEndpointResponse createPrivateEndpoint(CreatePrivateEndpointRequest request)

Creates a private endpoint to be used by an application.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreatePrivateEndpoint API.

createRun

CreateRunResponse createRun(CreateRunRequest request)

Creates a run for an application.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use CreateRun API.

deleteApplication

DeleteApplicationResponse deleteApplication(DeleteApplicationRequest request)

Deletes an application using an applicationId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteApplication API.

deletePrivateEndpoint

DeletePrivateEndpointResponse deletePrivateEndpoint(DeletePrivateEndpointRequest request)

Deletes a private endpoint using a privateEndpointId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeletePrivateEndpoint API.

deleteRun

DeleteRunResponse deleteRun(DeleteRunRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use DeleteRun API.

getApplication

GetApplicationResponse getApplication(GetApplicationRequest request)

Retrieves an application using an applicationId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetApplication API.

getPrivateEndpoint

GetPrivateEndpointResponse getPrivateEndpoint(GetPrivateEndpointRequest request)

Retrieves an private endpoint using a privateEndpointId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetPrivateEndpoint API.

getRun

GetRunResponse getRun(GetRunRequest request)

Retrieves the run for the specified runId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetRun API.

getRunLog

GetRunLogResponse getRunLog(GetRunLogRequest request)

Retrieves the content of an run log.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetRunLog API.

getWorkRequest

GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetWorkRequest API.

listApplications

ListApplicationsResponse listApplications(ListApplicationsRequest request)

Lists all applications in the specified compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListApplications API.

listPrivateEndpoints

ListPrivateEndpointsResponse listPrivateEndpoints(ListPrivateEndpointsRequest request)

Lists all private endpoints in the specified compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListPrivateEndpoints API.

listRunLogs

ListRunLogsResponse listRunLogs(ListRunLogsRequest request)

Retrieves summaries of the run’s logs.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListRunLogs API.

listRuns

ListRunsResponse listRuns(ListRunsRequest request)

Lists all runs of an application in the specified compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListRuns API.

listWorkRequestErrors

ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListWorkRequestErrors API.

listWorkRequestLogs

ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

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

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListWorkRequestLogs API.

listWorkRequests

ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Lists the work requests in a compartment.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use ListWorkRequests API.

updateApplication

UpdateApplicationResponse updateApplication(UpdateApplicationRequest request)

Updates an application using an applicationId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateApplication API.

updatePrivateEndpoint

UpdatePrivateEndpointResponse updatePrivateEndpoint(UpdatePrivateEndpointRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdatePrivateEndpoint API.

updateRun

UpdateRunResponse updateRun(UpdateRunRequest request)

Updates a run using a runId.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UpdateRun API.

getWaiters

DataFlowWaiters getWaiters()

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

Returns:

The service waiters.

getPaginators

DataFlowPaginators getPaginators()

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.

Returns:

The service paginators.