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.This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CascadingDeleteApplicationResponse
cascadingDeleteApplication(CascadingDeleteApplicationRequest request)
Deletes an application using anapplicationId
and terminates related runs.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.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 anapplicationId
.DeletePoolResponse
deletePool(DeletePoolRequest request)
Deletes a pool using apoolId
.DeletePrivateEndpointResponse
deletePrivateEndpoint(DeletePrivateEndpointRequest request)
Deletes a private endpoint using aprivateEndpointId
.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 anapplicationId
.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.GetPoolResponse
getPool(GetPoolRequest request)
Retrieves a pool using apoolId
.GetPrivateEndpointResponse
getPrivateEndpoint(GetPrivateEndpointRequest request)
Retrieves an private endpoint using aprivateEndpointId
.GetRunResponse
getRun(GetRunRequest request)
Retrieves the run for the specifiedrunId
.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 thestatementId
for a Session run specified byrunId
.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
refreshClient()
Rebuilds the client from scratch.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’).StartPoolResponse
startPool(StartPoolRequest request)
Starts the dataflow pool for a givenpoolId
.StartSqlEndpointResponse
startSqlEndpoint(StartSqlEndpointRequest request)
Starts the SqlEndpoint for a givenSqlEndpointId
.StopPoolResponse
stopPool(StopPoolRequest request)
Stops the dataflow pool for a givenpoolId
.StopSqlEndpointResponse
stopSqlEndpoint(StopSqlEndpointRequest request)
Stops the SqlEndpoint for a givenSqlEndpointId
.UpdateApplicationResponse
updateApplication(UpdateApplicationRequest request)
Updates an application using anapplicationId
.UpdatePoolResponse
updatePool(UpdatePoolRequest request)
Updates a pool using apoolId
.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 aprivateEndpointId
.UpdateRunResponse
updateRun(UpdateRunRequest request)
Updates a run using arunId
.UpdateSqlEndpointResponse
updateSqlEndpoint(UpdateSqlEndpointRequest request)
Update a Sql Endpoint resource, identified by the SqlEndpoint id.void
useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not.-
Methods inherited from interface java.lang.AutoCloseable
close
-
-
-
-
Method Detail
-
refreshClient
void refreshClient()
Rebuilds the client from scratch.Useful to refresh certificates.
-
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 callsetEndpoint
.- Parameters:
regionId
- The public region ID.
-
useRealmSpecificEndpointTemplate
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
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
- flag to enable the use of realm specific endpoint template
-
cascadingDeleteApplication
CascadingDeleteApplicationResponse cascadingDeleteApplication(CascadingDeleteApplicationRequest request)
Deletes an application using anapplicationId
and terminates related runs.This operation will timeout in approximate 30 minutes if any related Runs are not terminated successfully.
- 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/CascadingDeleteApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CascadingDeleteApplication API.
-
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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ChangeApplicationCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeApplicationCompartment API.
-
changePoolCompartment
ChangePoolCompartmentResponse changePoolCompartment(ChangePoolCompartmentRequest request)
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
- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ChangePoolCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangePoolCompartment 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ChangePrivateEndpointCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ChangeRunCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeRunCompartment API.
-
changeSqlEndpointCompartment
ChangeSqlEndpointCompartmentResponse changeSqlEndpointCompartment(ChangeSqlEndpointCompartmentRequest request)
Moves an Sql Endpoint from one compartment to another.When provided, If-Match is checked against ETag values of the Sql Endpoint.
- 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ChangeSqlEndpointCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeSqlEndpointCompartment 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/CreateApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateApplication API.
-
createPool
CreatePoolResponse createPool(CreatePoolRequest request)
Create a pool to be used by dataflow runs or applications.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/CreatePoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreatePool API.
-
createPrivateEndpoint
CreatePrivateEndpointResponse createPrivateEndpoint(CreatePrivateEndpointRequest request)
Creates a private endpoint to be used by applications.- 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/CreatePrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/CreateRunExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateRun API.
-
createSqlEndpoint
CreateSqlEndpointResponse createSqlEndpoint(CreateSqlEndpointRequest request)
Create a new Sql Endpoint.- 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/CreateSqlEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateSqlEndpoint API.
-
createStatement
CreateStatementResponse createStatement(CreateStatementRequest request)
Executes a statement for a Session run.- 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/CreateStatementExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateStatement API.
-
deleteApplication
DeleteApplicationResponse deleteApplication(DeleteApplicationRequest request)
Deletes an application using anapplicationId
.- 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/DeleteApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteApplication API.
-
deletePool
DeletePoolResponse deletePool(DeletePoolRequest request)
Deletes a pool using apoolId
.- 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/DeletePoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeletePool API.
-
deletePrivateEndpoint
DeletePrivateEndpointResponse deletePrivateEndpoint(DeletePrivateEndpointRequest request)
Deletes a private endpoint using aprivateEndpointId
.- 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/DeletePrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/DeleteRunExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteRun API.
-
deleteSqlEndpoint
DeleteSqlEndpointResponse deleteSqlEndpoint(DeleteSqlEndpointRequest request)
Delete a Sql Endpoint resource, identified by the SqlEndpoint id.- 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/DeleteSqlEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteSqlEndpoint API.
-
deleteStatement
DeleteStatementResponse deleteStatement(DeleteStatementRequest request)
Cancels the specified statement for a Session run.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/DeleteStatementExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteStatement API.
-
getApplication
GetApplicationResponse getApplication(GetApplicationRequest request)
Retrieves an application using anapplicationId
.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/GetApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetApplication API.
-
getPool
GetPoolResponse getPool(GetPoolRequest request)
Retrieves a pool using apoolId
.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/GetPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPool API.
-
getPrivateEndpoint
GetPrivateEndpointResponse getPrivateEndpoint(GetPrivateEndpointRequest request)
Retrieves an private endpoint using aprivateEndpointId
.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/GetPrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetPrivateEndpoint API.
-
getRun
GetRunResponse getRun(GetRunRequest request)
Retrieves the run for the specifiedrunId
.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/GetRunExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/GetRunLogExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetRunLog API.
-
getSqlEndpoint
GetSqlEndpointResponse getSqlEndpoint(GetSqlEndpointRequest request)
Retrieves a SQL Endpoint using a sqlEndpointId.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/GetSqlEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetSqlEndpoint API.
-
getStatement
GetStatementResponse getStatement(GetStatementRequest request)
Retrieves the statement corresponding to thestatementId
for a Session run specified byrunId
.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/GetStatementExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetStatement 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.
-
listApplications
ListApplicationsResponse listApplications(ListApplicationsRequest request)
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.
- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ListApplicationsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListApplications API.
-
listPools
ListPoolsResponse listPools(ListPoolsRequest request)
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.
- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ListPoolsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListPools API.
-
listPrivateEndpoints
ListPrivateEndpointsResponse listPrivateEndpoints(ListPrivateEndpointsRequest request)
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.
- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ListPrivateEndpointsExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ListRunLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRunLogs API.
-
listRuns
ListRunsResponse listRuns(ListRunsRequest request)
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.
- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ListRunsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListRuns API.
-
listSqlEndpoints
ListSqlEndpointsResponse listSqlEndpoints(ListSqlEndpointsRequest request)
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.
- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ListSqlEndpointsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSqlEndpoints API.
-
listStatements
ListStatementsResponse listStatements(ListStatementsRequest request)
Lists all statements for a Session run.- 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ListStatementsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListStatements 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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.
-
startPool
StartPoolResponse startPool(StartPoolRequest request)
Starts the dataflow pool for a givenpoolId
.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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/StartPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StartPool API.
-
startSqlEndpoint
StartSqlEndpointResponse startSqlEndpoint(StartSqlEndpointRequest request)
Starts the SqlEndpoint for a givenSqlEndpointId
.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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/StartSqlEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StartSqlEndpoint API.
-
stopPool
StopPoolResponse stopPool(StopPoolRequest request)
Stops the dataflow pool for a givenpoolId
.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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/StopPoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StopPool API.
-
stopSqlEndpoint
StopSqlEndpointResponse stopSqlEndpoint(StopSqlEndpointRequest request)
Stops the SqlEndpoint for a givenSqlEndpointId
.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. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/StopSqlEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use StopSqlEndpoint API.
-
updateApplication
UpdateApplicationResponse updateApplication(UpdateApplicationRequest request)
Updates an application using anapplicationId
.- 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/UpdateApplicationExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateApplication API.
-
updatePool
UpdatePoolResponse updatePool(UpdatePoolRequest request)
Updates a pool using apoolId
.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.- 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/UpdatePoolExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePool API.
-
updatePrivateEndpoint
UpdatePrivateEndpointResponse updatePrivateEndpoint(UpdatePrivateEndpointRequest request)
Updates a private endpoint using aprivateEndpointId
.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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/UpdatePrivateEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdatePrivateEndpoint API.
-
updateRun
UpdateRunResponse updateRun(UpdateRunRequest request)
Updates a run using arunId
.- 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/UpdateRunExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateRun API.
-
updateSqlEndpoint
UpdateSqlEndpointResponse updateSqlEndpoint(UpdateSqlEndpointRequest request)
Update a Sql Endpoint resource, identified by the SqlEndpoint id.- 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. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_RetriesExample: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/dataflow/UpdateSqlEndpointExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateSqlEndpoint 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.
-
-