Namespace Oci.DataflowService.Models

Classes

ApplicationLogConfig

Logging details of Application logs for Data Flow Run.

ApplicationSummary

A Data Flow application object used in bulk listings.

ChangeApplicationCompartmentDetails

The change application compartment details.

ChangePoolCompartmentDetails

The details required to change a pool compartment.

ChangePrivateEndpointCompartmentDetails

The details required to change a private endpoint compartment.

ChangeSqlEndpointCompartmentDetails

Details for changing the compartment of a SQL Endpoint.

CreatePrivateEndpointDetails

The details required to create a private endpoint.

CreateRunDetails

The create run details. The following properties are optional and override the default values set in the associated application:

applicationId
archiveUri
applicationLogConfig
arguments
configuration
definedTags
displayName
driverShape
execute
executorShape
freeformTags
logsBucketUri
metastoreId
numExecutors
parameters
sparkVersion
warehouseBucketUri It is expected that either the applicationId or the execute parameter is specified; but not both. If both or none are set, a Bad Request (HTTP 400) status will be sent as the response. If an appicationId is not specified, then a value for the execute parameter is expected. Using data parsed from the value, a new application will be created and assicated with the new run. See information on the execute parameter for details on the format of this parameter.
The optional parameter spark version can only be specified when using the execute parameter. If it is not specified when using the execute parameter, the latest version will be used as default. If the execute parameter is not used, the spark version will be taken from the associated application.
If displayName is not specified, it will be derived from the displayName of associated application or set by API using fileUri's application file name. Once a run is created, its properties (except for definedTags and freeformTags) cannot be changed. If the parent application's properties (including definedTags and freeformTags) are updated, the corresponding properties of the run will not update.

CreateSqlEndpointDetails

The information about a new SQL Endpoint.

CreateStatementDetails

The details required to create a statement.

ImagePngStatementOutputData

The statement output data in png format.

NodeCount

An object with a logical shape and count of the number of nodes with that shape.

PoolCollection

The results of a query for a list of pools. It contains PoolSummary items.

PoolConfig

An object containing the details about the compute shapes and number of compute instances to provison.

PoolMetrics

A collection of metrics related to a particular pool.

PoolSchedule

Definition of when pool auto start or stop for a given day of a week.

PrivateEndpointCollection

The results of a query for a list of private endpoints. It contains PrivateEndpointSummary items.

PrivateEndpointSummary

A Data Flow private endpoint object used in bulk listings.

RunLogSummary

A summary of a log associated with a particular run.

Scan

Single Client Access Name (SCAN) is the object with a fully-qualified domain name and a port number.

SecureAccessControlRule

The access control rule for SECURE_ACCESS network type selection.

ShapeConfig

This is used to configure the shape of the driver or executor if a flexible shape is used.

SqlEndpointCollection

The results of a Sql Endpoint search. It contains the objects in a SqlEndpointSummary.

SqlEndpointNetworkConfiguration

The network configuration of a SQL Endpoint.

SqlEndpointNetworkConfigurationModelConverter

SqlEndpointSecureAccessConfig

Access control rules for secure access selection.

SqlEndpointVcnConfig

The VCN configuration for VCN network type selection.

StatementCollection

The results of a query for a list of statements of a Session Run. It contains StatementSummary items.

StatementOutputData

An object representing execution output of a statement.

StatementOutputDataModelConverter

TextHtmlStatementOutputData

The statement output data in html format.

TextPlainStatementOutputData

The statement output data in text format.

UpdatePoolDetails

The details required to update a given pool with poolId.

UpdatePrivateEndpointDetails

The details required to update a private endpoint.

UpdateRunDetails

The update run details. Only a limited set of properties of a run can be updated.

UpdateSqlEndpointDetails

Currently only the tags of a SQL Endpoint can be updated.

WorkRequestCollection

Results of a query for a list of work requests. Contains WorkRequestSummary items.

WorkRequestErrorCollection

Results of a query for a list of work request errors. Contains WorkRequestError items.

WorkRequestLogCollection

Results of a query for a list of work request logs. Contains WorkRequestLog items.

WorkRequestResource

A resource related to a Data Flow work request.

WorkRequestSummary

A Data Flow work request summary object.

Enums

IpNotationType

The IP notation types for secure access.

PrivateEndpointLifecycleState

The lifecycle state of a private endpoint.

Common lifecycle states for resources in a Sql Endpoint: CREATING - The resource is being created and might not be usable until the entire metadata is defined. ACTIVE - The resource is valid and available for access. DELETING - The resource is being deleted, and might require a deep clean of any children. DELETED - The resource has been deleted, and isn't available. FAILED - The resource is in a failed state due to validation or other errors. UPDATING - The resource is being updated and might not be usable until all changes are commited. NEEDS_ATTENTION - The resource needs customer/operator intervention.