@Generated(value="OracleSDKGenerator", comments="API Version: 20200129") public class DataFlowClient extends Object implements DataFlow
Modifier and Type | Class and Description |
---|---|
static class |
DataFlowClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
static Service |
SERVICE
Service instance for DataFlow.
|
Modifier | Constructor and Description |
---|---|
|
DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DataFlowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
DataFlowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DataFlowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
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.
|
ChangePrivateEndpointCompartmentResponse |
changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request)
Moves a private endpoint into a different compartment.
|
ChangeRunCompartmentResponse |
changeRunCompartment(ChangeRunCompartmentRequest request)
Moves a run into a different compartment.
|
void |
close() |
CreateApplicationResponse |
createApplication(CreateApplicationRequest request)
Creates an application.
|
CreatePrivateEndpointResponse |
createPrivateEndpoint(CreatePrivateEndpointRequest request)
Creates a private endpoint to be used by applications.
|
CreateRunResponse |
createRun(CreateRunRequest request)
Creates a run for an application.
|
CreateStatementResponse |
createStatement(CreateStatementRequest request)
Executes a statement for a Session run.
|
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.
|
DeleteStatementResponse |
deleteStatement(DeleteStatementRequest request)
Cancels the specified statement for a Session run.
|
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.
|
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.
|
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.
|
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’).
|
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 . |
public static final Service SERVICE
Service instance for DataFlow.
public DataFlowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider
- The authentication details provider, required.public DataFlowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.public DataFlowClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.public DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.public DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.additionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)public DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected DataFlowClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
Use the DataFlowClient.Builder
to get access to all these parameters.
authenticationDetailsProvider
- The authentication details provider, required.configuration
- The client configuration, optional.clientConfigurator
- ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory
- The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories
- The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators
- Additional client configurators to be run after the primary configurator.endpoint
- Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider
)executorService
- ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder
- the builder for the RestClientFactory
public static DataFlowClient.Builder builder()
Create a builder for this client.
public void refreshClient()
DataFlow
Rebuilds the client from scratch. Useful to refresh certificates.
refreshClient
in interface DataFlow
public void setEndpoint(String endpoint)
DataFlow
Sets the endpoint to call (ex, https://www.example.com).
setEndpoint
in interface DataFlow
endpoint
- The endpoint of the service.public String getEndpoint()
DataFlow
Gets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint
in interface DataFlow
public void setRegion(Region region)
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.
public void setRegion(String regionId)
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
.
public void close()
close
in interface AutoCloseable
public ChangeApplicationCompartmentResponse changeApplicationCompartment(ChangeApplicationCompartmentRequest request)
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.
changeApplicationCompartment
in interface DataFlow
request
- The request object containing the details to sendpublic ChangePrivateEndpointCompartmentResponse changePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request)
DataFlow
Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.
changePrivateEndpointCompartment
in interface DataFlow
request
- The request object containing the details to sendpublic ChangeRunCompartmentResponse changeRunCompartment(ChangeRunCompartmentRequest request)
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
changeRunCompartment
in interface DataFlow
request
- The request object containing the details to sendpublic CreateApplicationResponse createApplication(CreateApplicationRequest request)
DataFlow
Creates an application.
createApplication
in interface DataFlow
request
- The request object containing the details to sendpublic CreatePrivateEndpointResponse createPrivateEndpoint(CreatePrivateEndpointRequest request)
DataFlow
Creates a private endpoint to be used by applications.
createPrivateEndpoint
in interface DataFlow
request
- The request object containing the details to sendpublic CreateRunResponse createRun(CreateRunRequest request)
DataFlow
Creates a run for an application.
public CreateStatementResponse createStatement(CreateStatementRequest request)
DataFlow
Executes a statement for a Session run.
createStatement
in interface DataFlow
request
- The request object containing the details to sendpublic DeleteApplicationResponse deleteApplication(DeleteApplicationRequest request)
DataFlow
Deletes an application using an applicationId
.
deleteApplication
in interface DataFlow
request
- The request object containing the details to sendpublic DeletePrivateEndpointResponse deletePrivateEndpoint(DeletePrivateEndpointRequest request)
DataFlow
Deletes a private endpoint using a privateEndpointId
.
deletePrivateEndpoint
in interface DataFlow
request
- The request object containing the details to sendpublic DeleteRunResponse deleteRun(DeleteRunRequest request)
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.
public DeleteStatementResponse deleteStatement(DeleteStatementRequest request)
DataFlow
Cancels the specified statement for a Session run.
deleteStatement
in interface DataFlow
request
- The request object containing the details to sendpublic GetApplicationResponse getApplication(GetApplicationRequest request)
DataFlow
Retrieves an application using an applicationId
.
getApplication
in interface DataFlow
request
- The request object containing the details to sendpublic GetPrivateEndpointResponse getPrivateEndpoint(GetPrivateEndpointRequest request)
DataFlow
Retrieves an private endpoint using a privateEndpointId
.
getPrivateEndpoint
in interface DataFlow
request
- The request object containing the details to sendpublic GetRunResponse getRun(GetRunRequest request)
DataFlow
Retrieves the run for the specified runId
.
public GetRunLogResponse getRunLog(GetRunLogRequest request)
DataFlow
Retrieves the content of an run log.
public GetStatementResponse getStatement(GetStatementRequest request)
DataFlow
Retrieves the statement corresponding to the statementId
for a Session run specified by runId
.
getStatement
in interface DataFlow
request
- The request object containing the details to sendpublic GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
DataFlow
Gets the status of the work request with the given OCID.
getWorkRequest
in interface DataFlow
request
- The request object containing the details to sendpublic ListApplicationsResponse listApplications(ListApplicationsRequest request)
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.
listApplications
in interface DataFlow
request
- The request object containing the details to sendpublic ListPrivateEndpointsResponse listPrivateEndpoints(ListPrivateEndpointsRequest request)
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.
listPrivateEndpoints
in interface DataFlow
request
- The request object containing the details to sendpublic ListRunLogsResponse listRunLogs(ListRunLogsRequest request)
DataFlow
Retrieves summaries of the run’s logs.
listRunLogs
in interface DataFlow
request
- The request object containing the details to sendpublic ListRunsResponse listRuns(ListRunsRequest request)
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.
public ListStatementsResponse listStatements(ListStatementsRequest request)
DataFlow
Lists all statements for a Session run.
listStatements
in interface DataFlow
request
- The request object containing the details to sendpublic ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
DataFlow
Return a (paginated) list of errors for a given work request.
listWorkRequestErrors
in interface DataFlow
request
- The request object containing the details to sendpublic ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
DataFlow
Return a paginated list of logs for a given work request.
listWorkRequestLogs
in interface DataFlow
request
- The request object containing the details to sendpublic ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
DataFlow
Lists the work requests in a compartment.
listWorkRequests
in interface DataFlow
request
- The request object containing the details to sendpublic UpdateApplicationResponse updateApplication(UpdateApplicationRequest request)
DataFlow
Updates an application using an applicationId
.
updateApplication
in interface DataFlow
request
- The request object containing the details to sendpublic UpdatePrivateEndpointResponse updatePrivateEndpoint(UpdatePrivateEndpointRequest request)
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.
updatePrivateEndpoint
in interface DataFlow
request
- The request object containing the details to sendpublic UpdateRunResponse updateRun(UpdateRunRequest request)
DataFlow
Updates a run using a runId
.
public DataFlowWaiters getWaiters()
DataFlow
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface DataFlow
public DataFlowPaginators getPaginators()
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.
getPaginators
in interface DataFlow
Copyright © 2016–2023. All rights reserved.