Class DataFlowClient
Service client instance for DataFlow.
Implements
Inherited Members
Namespace: Oci.DataflowService
Assembly: OCI.DotNetSDK.Dataflow.dll
Syntax
public class DataFlowClient : RegionalClientBase, IDisposable
Constructors
DataFlowClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)
Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.
Declaration
public DataFlowClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)
Parameters
Type | Name | Description |
---|---|---|
IBasicAuthenticationDetailsProvider | authenticationDetailsProvider | The authentication details provider. Required. |
ClientConfiguration | clientConfiguration | The client configuration that contains settings to adjust REST client behaviors. Optional. |
string | endpoint | The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional. |
Properties
Paginators
Declaration
public DataFlowPaginators Paginators { get; }
Property Value
Type | Description |
---|---|
DataFlowPaginators |
Waiters
Declaration
public DataFlowWaiters Waiters { get; }
Property Value
Type | Description |
---|---|
DataFlowWaiters |
Methods
ChangeApplicationCompartment(ChangeApplicationCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ChangeApplicationCompartmentResponse> ChangeApplicationCompartment(ChangeApplicationCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeApplicationCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeApplicationCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeApplicationCompartment API.
ChangePoolCompartment(ChangePoolCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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
Declaration
public Task<ChangePoolCompartmentResponse> ChangePoolCompartment(ChangePoolCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangePoolCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangePoolCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangePoolCompartment API.
ChangePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<ChangePrivateEndpointCompartmentResponse> ChangePrivateEndpointCompartment(ChangePrivateEndpointCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangePrivateEndpointCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangePrivateEndpointCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangePrivateEndpointCompartment API.
ChangeRunCompartment(ChangeRunCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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
Declaration
public Task<ChangeRunCompartmentResponse> ChangeRunCompartment(ChangeRunCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeRunCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeRunCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeRunCompartment API.
ChangeSqlEndpointCompartment(ChangeSqlEndpointCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Moves an Sql Endpoint from one compartment to another. When provided, If-Match is checked against ETag values of the Sql Endpoint.
Declaration
public Task<ChangeSqlEndpointCompartmentResponse> ChangeSqlEndpointCompartment(ChangeSqlEndpointCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ChangeSqlEndpointCompartmentRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ChangeSqlEndpointCompartmentResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ChangeSqlEndpointCompartment API.
CreateApplication(CreateApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates an application.
Declaration
public Task<CreateApplicationResponse> CreateApplication(CreateApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateApplicationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateApplicationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateApplication API.
CreatePool(CreatePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create a pool to be used by dataflow runs or applications.
Declaration
public Task<CreatePoolResponse> CreatePool(CreatePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreatePoolRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreatePoolResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreatePool API.
CreatePrivateEndpoint(CreatePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a private endpoint to be used by applications.
Declaration
public Task<CreatePrivateEndpointResponse> CreatePrivateEndpoint(CreatePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreatePrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreatePrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreatePrivateEndpoint API.
CreateRun(CreateRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Creates a run for an application.
Declaration
public Task<CreateRunResponse> CreateRun(CreateRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateRunRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateRunResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateRun API.
CreateSqlEndpoint(CreateSqlEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Create a new Sql Endpoint.
Declaration
public Task<CreateSqlEndpointResponse> CreateSqlEndpoint(CreateSqlEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateSqlEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateSqlEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateSqlEndpoint API.
CreateStatement(CreateStatementRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Executes a statement for a Session run.
Declaration
public Task<CreateStatementResponse> CreateStatement(CreateStatementRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
CreateStatementRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<CreateStatementResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use CreateStatement API.
DeleteApplication(DeleteApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes an application using an applicationId
.
Declaration
public Task<DeleteApplicationResponse> DeleteApplication(DeleteApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteApplicationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteApplicationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteApplication API.
DeletePool(DeletePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a pool using a poolId
.
Declaration
public Task<DeletePoolResponse> DeletePool(DeletePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeletePoolRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeletePoolResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeletePool API.
DeletePrivateEndpoint(DeletePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Deletes a private endpoint using a privateEndpointId
.
Declaration
public Task<DeletePrivateEndpointResponse> DeletePrivateEndpoint(DeletePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeletePrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeletePrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeletePrivateEndpoint API.
DeleteRun(DeleteRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<DeleteRunResponse> DeleteRun(DeleteRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteRunRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteRunResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteRun API.
DeleteSqlEndpoint(DeleteSqlEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Delete a Sql Endpoint resource, identified by the SqlEndpoint id.
Declaration
public Task<DeleteSqlEndpointResponse> DeleteSqlEndpoint(DeleteSqlEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteSqlEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteSqlEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteSqlEndpoint API.
DeleteStatement(DeleteStatementRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Cancels the specified statement for a Session run.
Declaration
public Task<DeleteStatementResponse> DeleteStatement(DeleteStatementRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
DeleteStatementRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<DeleteStatementResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use DeleteStatement API.
GetApplication(GetApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves an application using an applicationId
.
Declaration
public Task<GetApplicationResponse> GetApplication(GetApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetApplicationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetApplicationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetApplication API.
GetPool(GetPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a pool using a poolId
.
Declaration
public Task<GetPoolResponse> GetPool(GetPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPoolRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPoolResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPool API.
GetPrivateEndpoint(GetPrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves an private endpoint using a privateEndpointId
.
Declaration
public Task<GetPrivateEndpointResponse> GetPrivateEndpoint(GetPrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetPrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetPrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetPrivateEndpoint API.
GetRun(GetRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves the run for the specified runId
.
Declaration
public Task<GetRunResponse> GetRun(GetRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRunRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetRunResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRun API.
GetRunLog(GetRunLogRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves the content of an run log.
Declaration
public Task<GetRunLogResponse> GetRunLog(GetRunLogRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetRunLogRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetRunLogResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetRunLog API.
GetSqlEndpoint(GetSqlEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves a SQL Endpoint using a sqlEndpointId.
Declaration
public Task<GetSqlEndpointResponse> GetSqlEndpoint(GetSqlEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetSqlEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetSqlEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetSqlEndpoint API.
GetStatement(GetStatementRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves the statement corresponding to the statementId
for a Session run specified by runId
.
Declaration
public Task<GetStatementResponse> GetStatement(GetStatementRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetStatementRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetStatementResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetStatement API.
GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Gets the status of the work request with the given OCID.
Declaration
public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
GetWorkRequestRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<GetWorkRequestResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use GetWorkRequest API.
ListApplications(ListApplicationsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListApplicationsResponse> ListApplications(ListApplicationsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListApplicationsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListApplicationsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListApplications API.
ListPools(ListPoolsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListPoolsResponse> ListPools(ListPoolsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPoolsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPoolsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPools API.
ListPrivateEndpoints(ListPrivateEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListPrivateEndpointsResponse> ListPrivateEndpoints(ListPrivateEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListPrivateEndpointsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListPrivateEndpointsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListPrivateEndpoints API.
ListRunLogs(ListRunLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Retrieves summaries of the run's logs.
Declaration
public Task<ListRunLogsResponse> ListRunLogs(ListRunLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRunLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListRunLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRunLogs API.
ListRuns(ListRunsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListRunsResponse> ListRuns(ListRunsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListRunsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListRunsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListRuns API.
ListSqlEndpoints(ListSqlEndpointsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<ListSqlEndpointsResponse> ListSqlEndpoints(ListSqlEndpointsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListSqlEndpointsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListSqlEndpointsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListSqlEndpoints API.
ListStatements(ListStatementsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists all statements for a Session run.
Declaration
public Task<ListStatementsResponse> ListStatements(ListStatementsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListStatementsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListStatementsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListStatements API.
ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a (paginated) list of errors for a given work request.
Declaration
public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestErrorsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestErrorsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestErrors API.
ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Return a paginated list of logs for a given work request.
Declaration
public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestLogsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestLogsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequestLogs API.
ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Lists the work requests in a compartment.
Declaration
public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
ListWorkRequestsRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<ListWorkRequestsResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use ListWorkRequests API.
StartPool(StartPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Starts the dataflow pool for a given poolId
. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<StartPoolResponse> StartPool(StartPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
StartPoolRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<StartPoolResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use StartPool API.
StopPool(StopPoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Stops the dataflow pool for a given poolId
. When provided, If-Match is checked against ETag values of the resource.
Declaration
public Task<StopPoolResponse> StopPool(StopPoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
StopPoolRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<StopPoolResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use StopPool API.
UpdateApplication(UpdateApplicationRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates an application using an applicationId
.
Declaration
public Task<UpdateApplicationResponse> UpdateApplication(UpdateApplicationRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateApplicationRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateApplicationResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateApplication API.
UpdatePool(UpdatePoolRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a pool using a poolId
.If changes to a pool doesn't match
a previously defined pool,then a 409 status code will be returned.This indicates
that a conflict has been detected.
Declaration
public Task<UpdatePoolResponse> UpdatePool(UpdatePoolRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePoolRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdatePoolResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePool API.
UpdatePrivateEndpoint(UpdatePrivateEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
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.
Declaration
public Task<UpdatePrivateEndpointResponse> UpdatePrivateEndpoint(UpdatePrivateEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdatePrivateEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdatePrivateEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdatePrivateEndpoint API.
UpdateRun(UpdateRunRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Updates a run using a runId
.
Declaration
public Task<UpdateRunResponse> UpdateRun(UpdateRunRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateRunRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateRunResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateRun API.
UpdateSqlEndpoint(UpdateSqlEndpointRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)
Update a Sql Endpoint resource, identified by the SqlEndpoint id.
Declaration
public Task<UpdateSqlEndpointResponse> UpdateSqlEndpoint(UpdateSqlEndpointRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)
Parameters
Type | Name | Description |
---|---|---|
UpdateSqlEndpointRequest | request | The request object containing the details to send. Required. |
RetryConfiguration | retryConfiguration | The retry configuration that will be used by to send this request. Optional. |
CancellationToken | cancellationToken | The cancellation token to cancel this operation. Optional. |
HttpCompletionOption | completionOption | The completion option for this operation. Optional. |
Returns
Type | Description |
---|---|
Task<UpdateSqlEndpointResponse> | A response object containing details about the completed operation |
Examples
Click here to see an example of how to use UpdateSqlEndpoint API.