openapi: 3.2.0 info: description: 'Use the Data Flow APIs to run any Apache Spark application at any scale without deploying or managing any infrastructure. ' license: name: Oracle Corporation title: Data Flow API version: '20200129' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/073c6ddbe388e3bb7984f9c13c7172166cb5a1063c9e2251c3c7dd3f7d49bd2e.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Data Flow API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/073c6ddbe388e3bb7984f9c13c7172166cb5a1063c9e2251c3c7dd3f7d49bd2e.yaml what: the harvested document for Data Flow API servers: - url: /20200129 tags: - name: DataFlow paths: /applications: get: description: '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. ' operationId: ListApplications parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/ApplicationSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/OwnerPrincipalIdQueryParam' - $ref: '#/components/parameters/DisplayNameStartsWithQueryParam' responses: 200: description: 'Returns a list of applications. ' headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ApplicationSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List the applications. tags: - DataFlow x-example: 'GET /applications?compartmentId=<compartmentId> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true post: description: 'Creates an application. ' operationId: CreateApplication parameters: - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 200: description: 'Returns the created application. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Application' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create an application. tags: - DataFlow x-example: "POST /applications HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: application/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"displayName\": \"test_wordcount_app\",\n \"compartmentId\": \"<compartmentId>\",\n \"type\": \"BATCH\",\n \"language\": \"JAVA\",\n \"file\": \"oci://.../wordcount-examples-jar-with-dependencies.jar\",\n \"className\": \"org.apache.spark.examples.JavaWordCount\",\n \"sparkVersion\": \"2.4\",\n \"driverShape\": \"VM.Standard2.1\",\n \"executorShape\": \"VM.Standard2.1\",\n \"numExecutors\": 1,\n \"arguments\": [ \"oci://.../WordCount.txt\" ],\n \"parameters\": [],\n \"configuration\": {}\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateApplicationDetails' description: 'Details to create an application. ' required: true /applications/{applicationId}: delete: description: 'Deletes an application using an `applicationId`. ' operationId: DeleteApplication parameters: - $ref: '#/components/parameters/ApplicationIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: 'The application was successfully deleted. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete the application. tags: - DataFlow x-example: 'DELETE /applications/<applicationId> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-related-resource: '#/definitions/Application' get: description: 'Retrieves an application using an `applicationId`. ' operationId: GetApplication parameters: - $ref: '#/components/parameters/ApplicationIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 200: description: 'Returns an application. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Application' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get the application. tags: - DataFlow x-example: 'GET /applications/<applicationId> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true put: description: 'Updates an application using an `applicationId`. ' operationId: UpdateApplication parameters: - $ref: '#/components/parameters/ApplicationIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: 'The application was successfully updated. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Application' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update the application. tags: - DataFlow x-example: "PUT /applications/<applicationId> HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: application/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"displayName\":\"test_wordcount_app_updated\",\n \"type\":\"BATCH\",\n \"language\":\"JAVA\",\n \"file\":\"oci://.../wordcount-example-jar-with-dependencies.jar\",\n \"className\":\"org.apache.spark.examples.JavaWordCount\",\n \"sparkVersion\":\"2.4\",\n \"driverShape\" : \"VM.Standard2.1\",\n \"executorShape\" : \"VM.Standard2.1\",\n \"numExecutors\" : 1,\n \"arguments\" : [ \"oci://.../WordCount2.txt\" ],\n \"parameters\" : [ ],\n \"configuration\": {}\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateApplicationDetails' description: 'Details for updating an application. ' required: true /applications/{applicationId}/actions/cascadingDeleteApplication: post: description: 'Deletes an application using an `applicationId` and terminates related runs. This operation will timeout in approximate 30 minutes if any related Runs are not terminated successfully. ' operationId: CascadingDeleteApplication parameters: - $ref: '#/components/parameters/ApplicationIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'Request accepted to cascade delete Application and Runs. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle assigned identifier for a work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete the application and terminate related Runs. tags: - DataFlow x-example: 'POST /applications/<applicationId>/actions/cascadingDeleteApplication HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-related-resource: '#/definitions/Application' /applications/{applicationId}/actions/changeCompartment: post: description: '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. ' operationId: ChangeApplicationCompartment parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/ApplicationIdPathParam' responses: 204: description: 'The application was successfully moved to the specified compartment. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 409: $ref: '#/components/responses/409' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves an application into a different compartment. tags: - DataFlow x-example: "POST /applications/<applicationId>/actions/changeCompartment HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: application/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n" x-related-resource: '#/definitions/Application' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeApplicationCompartmentDetails' description: 'Details for changing an application''s compartment. ' required: true /pools: get: description: '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. ' operationId: ListPools parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/PoolLifecycleStateQueryParam' - $ref: '#/components/parameters/PoolSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/OwnerPrincipalIdQueryParam' - $ref: '#/components/parameters/DisplayNameStartsWithQueryParam' responses: 200: description: 'Returns a list of pools. ' headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PoolCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List the pools. tags: - DataFlow x-example: 'GET /pools?compartmentId=<compartmentId> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Pool' post: description: 'Create a pool to be used by dataflow runs or applications. ' operationId: CreatePool parameters: - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 201: description: 'Returns the created pool metadata and a work request Id to track the progress of this operation. ' headers: Location: description: 'Provides information about the location of a newly created resource. ' schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle assigned identifier for a work request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Pool' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create a pool to be used by dataflow runs or applications. tags: - DataFlow x-example: "POST /pools HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: pool/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"compartmentId\" : \"<compartmentId>\",\n \"displayName\": \"myPool\",\n}\n" x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePoolDetails' description: 'The parameter required to create a pool. ' required: true /pools/{poolId}: delete: description: 'Deletes a pool using a `poolId`. ' operationId: DeletePool parameters: - $ref: '#/components/parameters/PoolIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: 'Returns the opc request Id. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Deletes a pool using a `poolId`. tags: - DataFlow x-example: 'DELETE /pools/<poolId> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-related-resource: '#/definitions/Pool' get: description: 'Retrieves a pool using a `poolId`. ' operationId: GetPool parameters: - $ref: '#/components/parameters/PoolIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 200: description: 'Returns a pool. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Pool' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get a pool. tags: - DataFlow x-example: 'GET /pools/<poolId> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true put: description: '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. ' operationId: UpdatePool parameters: - $ref: '#/components/parameters/PoolIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'Returns the pool metadata and a work request Id to track the progress of this operation. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle assigned identifier for a work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Updates a pool for provided `poolId`. tags: - DataFlow x-example: "PUT /pool/<poolId> HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: pool/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"displayName\":\"updatedPool\"\n}\n" x-related-resource: '#/definitions/Pool' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePoolDetails' description: 'Details for updating a pool. ' required: true /pools/{poolId}/actions/changeCompartment: post: description: '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 ' operationId: ChangePoolCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/PoolIdPathParam' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 204: description: 'Returns opc-request-id for this operation. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a pool into a different compartment. tags: - DataFlow x-example: "POST /pool/<poolId>/actions/changeCompartment HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: pool/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n" x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Pool' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePoolCompartmentDetails' description: 'Details for changing a pool''s compartment. ' required: true /pools/{poolId}/actions/start: post: description: 'Starts the dataflow pool for a given `poolId`. When provided, If-Match is checked against ETag values of the resource. ' operationId: StartPool parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/PoolIdPathParam' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 202: description: 'Returns the work request Id to track the progress of this operation. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle assigned identifier for a work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Starts a dataflow pool. tags: - DataFlow x-example: 'POST /pool/<poolId>/actions/start HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT x-content-sha256: <content-sha256> content-type: pool/json content-length: <content-length> Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: START x-related-resource: '#/definitions/Pool' /pools/{poolId}/actions/stop: post: description: 'Stops the dataflow pool for a given `poolId`. When provided, If-Match is checked against ETag values of the resource. ' operationId: StopPool parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/PoolIdPathParam' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 202: description: 'Returns the work request Id to track the progress of this operation. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle assigned identifier for a work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Stops a dataflow pool. tags: - DataFlow x-example: 'UPDATE /pool/<poolId>/actions/stop HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT x-content-sha256: <content-sha256> content-type: pool/json content-length: <content-length> Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: STOP x-related-resource: '#/definitions/Pool' /privateEndpoints: get: description: '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. ' operationId: ListPrivateEndpoints parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/PrivateEndpointLifecycleStateQueryParam' - $ref: '#/components/parameters/PrivateEndpointSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/OwnerPrincipalIdQueryParam' - $ref: '#/components/parameters/DisplayNameStartsWithQueryParam' responses: 200: description: 'Returns a list of private endpoints. ' headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PrivateEndpointCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List the private endpoints. tags: - DataFlow x-example: 'GET /privateEndpoints?compartmentId=<compartmentId> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/PrivateEndpoint' post: description: 'Creates a private endpoint to be used by applications. ' operationId: CreatePrivateEndpoint parameters: - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 201: description: 'Returns the created private endpoint metadata and a work request Id to track the progress of this operation. ' headers: Location: description: 'Provides information about the location of a newly created resource. ' schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle assigned identifier for a work request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PrivateEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create a private endpoint to be used by an application. tags: - DataFlow x-example: "POST /privateEndpoints HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: privateEndpoint/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"compartmentId\" : \"<compartmentId>\",\n \"displayName\": \"pe_1234\",\n \"dnsZones\" : [ \"app.examplecorp.com\", \"oracle.com\" ],\n \"maxHostCount\" : \"256\",\n \"nsgIds\" : [ \"<nsgId>\" ],\n \"subnetId\" : \"<subnetId>\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePrivateEndpointDetails' description: 'The parameters required to create a private endpoint. ' required: true /privateEndpoints/{privateEndpointId}: delete: description: 'Deletes a private endpoint using a `privateEndpointId`. ' operationId: DeletePrivateEndpoint parameters: - $ref: '#/components/parameters/PrivateEndpointIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'Returns the work reqest Id to track the progress of this operation. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle assigned identifier for a work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete a private endpoint. tags: - DataFlow x-example: 'DELETE /privateEndpoints/<privateEndpointId> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-related-resource: '#/definitions/PrivateEndpoint' get: description: 'Retrieves an private endpoint using a `privateEndpointId`. ' operationId: GetPrivateEndpoint parameters: - $ref: '#/components/parameters/PrivateEndpointIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 200: description: 'Returns a private endpoint. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PrivateEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get a private endpoint. tags: - DataFlow x-example: 'GET /privateEndpoints/<privateEndpointId> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true put: description: '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. ' operationId: UpdatePrivateEndpoint parameters: - $ref: '#/components/parameters/PrivateEndpointIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: 'Returns the private endpoint metadata and a work request Id to track the progress of this operation. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle assigned identifier for a work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update a private endpoint. tags: - DataFlow x-example: "PUT /privateEndpoints/<privateEndpointId> HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: privateEndpoint/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"displayName\":\"PE to DB32002\",\n \"dnsZones\" : [ \"app.examplecorp.com\", \"oracle.com\" ],\n \"nsgIds\" : [ \"<nsgId>\" ],\n \"subnetId\" : \"<subnetId>\"\n}\n" x-related-resource: '#/definitions/PrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePrivateEndpointDetails' description: 'Details for updating a private endpoint. ' required: true /privateEndpoints/{privateEndpointId}/actions/changeCompartment: post: description: 'Moves a private endpoint into a different compartment. When provided, If-Match is checked against ETag values of the resource. ' operationId: ChangePrivateEndpointCompartment parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/PrivateEndpointIdPathParam' responses: 202: description: 'Returns the work request Id to track the progress of this operation. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle assigned identifier for a work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a private endpoint into a different compartment. tags: - DataFlow x-example: "POST /privateEndpoints/<privateEndpointId>/actions/changeCompartment HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: privateEndpoint/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n" x-related-resource: '#/definitions/PrivateEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePrivateEndpointCompartmentDetails' description: 'Details for changing a private endpoint''s compartment. ' required: true /runs: get: description: '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. ' operationId: ListRuns parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/ApplicationIdQueryParam' - $ref: '#/components/parameters/PoolIdQueryParam' - $ref: '#/components/parameters/OwnerPrincipalIdQueryParam' - $ref: '#/components/parameters/DisplayNameStartsWithQueryParam' - $ref: '#/components/parameters/RunLifecycleStateQueryParam' - $ref: '#/components/parameters/TimeCreatedGreaterThanQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/RunSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' responses: 200: description: 'Returns a list of runs. ' headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/RunSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List the runs. tags: - DataFlow x-example: 'GET /runs?compartmentId=<compartmentId> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true post: description: 'Creates a run for an application. ' operationId: CreateRun parameters: - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 200: description: 'The run was successfully created. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Run' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Create a run. tags: - DataFlow x-example: "POST /runs HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: application/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"displayName\": \"test_wordcount_run\",\n \"applicationId\": \"<applicationId>\",\n \"compartmentId\": \"<compartmentId>\",\n \"driverShape\": \"VM.Standard2.1\",\n \"executorShape\": \"VM.Standard2.1\",\n \"numExecutors\": 1,\n \"arguments\": [ \"oci://.../WordCount.txt\" ],\n \"parameters\": [],\n \"configuration\": {}\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRunDetails' description: 'Details for creating a run of an application. ' required: true /runs/{runId}: delete: description: '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. ' operationId: DeleteRun parameters: - $ref: '#/components/parameters/RunIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: 'The run was successfully canceled. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Cancels the specified run. tags: - DataFlow x-example: 'DELETE /runs/<runId> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-related-resource: '#/definitions/Run' get: description: 'Retrieves the run for the specified `runId`. ' operationId: GetRun parameters: - $ref: '#/components/parameters/RunIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 200: description: 'Returns a run. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Run' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get the run. tags: - DataFlow x-example: 'GET /runs/<runId> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true put: description: 'Updates a run using a `runId`. ' operationId: UpdateRun parameters: - $ref: '#/components/parameters/RunIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: 'The run was successfully updated. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Run' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update the run. tags: - DataFlow x-example: "PUT /runs/<runId> HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: application/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"freeformTags\" : { \"Department\": \"Finance\" }\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRunDetails' description: 'Details for updating a run. ' required: true /runs/{runId}/actions/changeCompartment: post: description: '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 ' operationId: ChangeRunCompartment parameters: - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/RunIdPathParam' responses: 204: description: 'The run was successfully moved to the specified compartment. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a run into a different compartment. tags: - DataFlow x-example: "POST /runs/<runId>/actions/changeCompartment HTTP/1.1\nHost: dataflow.us-phoenix-1.oci.oraclecloud.com\nUser-Agent: curl/7.54.0\nAccept: */*\ndate: Mon, 07 Oct 2019 14:50:46 GMT\nx-content-sha256: <content-sha256>\ncontent-type: application/json\ncontent-length: <content-length>\nAuthorization: <authorization and other headers>\n{\n \"compartmentId\": \"<compartmentId>\"\n}\n" x-related-resource: '#/definitions/Run' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeRunCompartmentDetails' description: 'Details for changing a run''s compartment. ' required: true /runs/{runId}/logs: get: description: 'Retrieves summaries of the run''s logs. ' operationId: ListRunLogs parameters: - $ref: '#/components/parameters/RunIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/LogLimitQueryParam' - $ref: '#/components/parameters/PageQueryParam' responses: 200: description: 'Returns a list of run log summaries. ' headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/RunLogSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List the run log summaries. tags: - DataFlow x-example: 'GET /runs/<runId>/logs HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/RunLogSummary' /runs/{runId}/logs/{name}: get: description: 'Retrieves the content of an run log. ' operationId: GetRunLog parameters: - $ref: '#/components/parameters/RunIdPathParam' - $ref: '#/components/parameters/LogNamePathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 200: description: 'Returns the contents of the run log file. ' headers: content-encoding: description: 'Indicates the encoding of the data, as described in RFC 2616, section 14.11. ' schema: type: string content-length: description: 'Indicates the size of the data as described in RFC 2616, section 14.13. ' schema: type: integer format: int64 content-type: description: 'Specifies the media type of the underlying data as described in RFC 2616, section 14.17. ' schema: type: string etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-meta-*: description: 'The user-defined metadata for the log. ' x-obmcs-header-collection: true x-obmcs-prefix: opc-meta- schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/octet-stream: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get the gzipped content of the run log. tags: - DataFlow x-example: 'GET /runs/<runId>/logs/<name> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Run' /runs/{runId}/statements: get: description: 'Lists all statements for a Session run. ' operationId: ListStatements parameters: - $ref: '#/components/parameters/RunIdPathParam' - $ref: '#/components/parameters/StatementLifecycleStateQueryParam' - $ref: '#/components/parameters/StatementSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 200: description: 'Returns the list of statements for a Session run. ' headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StatementCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List the statements for a Session run. tags: - DataFlow x-obmcs-client-retries-enabled: true post: description: 'Executes a statement for a Session run. ' operationId: CreateStatement parameters: - $ref: '#/components/parameters/RunIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 200: description: 'The statement was successfully created. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Statement' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Execute a statement for a Session Run. tags: - DataFlow requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateStatementDetails' description: 'Details for creating a statement. ' required: true /runs/{runId}/statements/{statementId}: delete: description: 'Cancels the specified statement for a Session run. ' operationId: DeleteStatement parameters: - $ref: '#/components/parameters/RunIdPathParam' - $ref: '#/components/parameters/StatementIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: 'The statement was successfully canceled. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Cancels the specified statement for a Session run. tags: - DataFlow x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Statement' get: description: 'Retrieves the statement corresponding to the `statementId` for a Session run specified by `runId`. ' operationId: GetStatement parameters: - $ref: '#/components/parameters/RunIdPathParam' - $ref: '#/components/parameters/StatementIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 200: description: 'Returns a statement. ' headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Statement' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get the specific statement for a Session run. tags: - DataFlow x-obmcs-client-retries-enabled: true /sqlEndpoints: get: description: '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. ' operationId: ListSqlEndpoints parameters: - $ref: '#/components/parameters/OptionalCompartmentIdQueryParam' - $ref: '#/components/parameters/SqlEndpointIdQueryParam' - $ref: '#/components/parameters/SqlEndpointLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SqlEndpointSortByQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 200: description: Returns a list of sql endpoints. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlEndpointCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets a list of all Sql Endpoints in a compartment. tags: - DataFlow x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/SqlEndpointCollection' post: description: Create a new Sql Endpoint. operationId: CreateSqlEndpoint parameters: - $ref: '#/components/parameters/OpcRetryTokenHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 201: description: Returns the created sql endpoint. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle assigned identifier for a work request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Creates a new Sql Endpoint. tags: - DataFlow requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSqlEndpointDetails' description: Details of the new Sql Endpoint. required: true /sqlEndpoints/{sqlEndpointId}: delete: description: Delete a Sql Endpoint resource, identified by the SqlEndpoint id. operationId: DeleteSqlEndpoint parameters: - $ref: '#/components/parameters/SqlEndpointIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 202: description: Request accepted. The Sql Endpoint, identified by the SqlEndpoint id, will be deleted. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle assigned identifier for a work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Delete a provisioned Sql Endpoint. tags: - DataFlow x-related-resource: '#/definitions/SqlEndpoint' get: description: Retrieves a SQL Endpoint using a sqlEndpointId. operationId: GetSqlEndpoint parameters: - $ref: '#/components/parameters/SqlEndpointIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 200: description: Returns a SQL Endpoint. headers: etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SqlEndpoint' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Retrieves a SQL Endpoint using a sqlEndpointId. tags: - DataFlow x-obmcs-client-retries-enabled: true put: description: Update a Sql Endpoint resource, identified by the SqlEndpoint id. operationId: UpdateSqlEndpoint parameters: - $ref: '#/components/parameters/SqlEndpointIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 202: description: Request accepted. The Sql Endpoint, identified by the SqlEndpoint id, will be updated. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle assigned identifier for a work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Update a provisioned Sql Endpoint. tags: - DataFlow x-related-resource: '#/definitions/SqlEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSqlEndpointDetails' description: Details of the Sql Endpoint to be updated. required: true /sqlEndpoints/{sqlEndpointId}/actions/changeCompartment: post: description: Moves an Sql Endpoint from one compartment to another. When provided, If-Match is checked against ETag values of the Sql Endpoint. operationId: ChangeSqlEndpointCompartment parameters: - $ref: '#/components/parameters/SqlEndpointIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/OpcRetryTokenHeader' responses: 202: description: The Sql Endpoint was successfully moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle assigned identifier for a work request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Moves a resource into a different compartment. tags: - DataFlow x-related-resource: '#/definitions/SqlEndpoint' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSqlEndpointCompartmentDetails' description: The details to change the compartment of the Sql Endpoint. required: true /workRequests: get: description: 'Lists the work requests in a compartment. ' operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/PageQueryParam' responses: 200: description: 'A list of WorkRequest objects ' headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: List Work Requests tags: - DataFlow x-example: 'GET /workRequests?compartmentId=<compartmentId> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: get: description: 'Gets the status of the work request with the given OCID. ' operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/OpcRequestIdHeader' responses: 200: description: 'The detail of the work request. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get Work Request Status tags: - DataFlow x-example: 'GET /workRequests/<workRequestId> HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Return a (paginated) list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/WorkRequestIdPathParam' responses: 200: description: List of work request errors. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists work request errors tags: - DataFlow x-example: 'GET /workRequests/<workRequestId>/errors HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequestError' /workRequests/{workRequestId}/logs: get: description: 'Return a paginated list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/LimitQueryParam' - $ref: '#/components/parameters/OpcRequestIdHeader' - $ref: '#/components/parameters/PageQueryParam' - $ref: '#/components/parameters/WorkRequestIdPathParam' responses: 200: description: List of work request logs. headers: opc-next-page: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-prev-page: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Lists work request logs tags: - DataFlow x-example: 'GET /workRequests/<workRequestId>/logs HTTP/1.1 Host: dataflow.us-phoenix-1.oci.oraclecloud.com User-Agent: curl/7.54.0 Accept: */* date: Mon, 07 Oct 2019 14:50:46 GMT Authorization: <authorization and other headers> ' x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/WorkRequestLog' components: schemas: PoolCollection: description: 'The results of a query for a list of pools. It contains PoolSummary items. ' properties: items: description: 'A list of pools. ' items: $ref: '#/components/schemas/PoolSummary' type: array required: - items type: object Statement: description: 'A statement object. ' properties: code: description: 'The statement code to execute. Example: `println(sc.version)` ' maxLength: 1048576 type: string id: description: 'The statement ID. ' format: int64 type: integer lifecycleState: description: 'The current state of this statement. ' enum: - ACCEPTED - CANCELLING - CANCELLED - FAILED - IN_PROGRESS - SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/StatementLifecycleState' output: $ref: '#/components/schemas/StatementOutput' progress: description: 'The execution progress. ' format: double type: number runId: description: 'The ID of a run. ' type: string timeCompleted: description: 'The date and time a statement execution was completed, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2022-05-31T21:10:29.600Z` ' format: date-time type: string timeCreated: description: 'The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string required: - id - code - lifecycleState - timeCreated type: object RunLogSummary: description: 'A summary of a log associated with a particular run. ' properties: name: description: 'The name of the log. Example: spark_driver_stderr_20190917T114000Z.log.gz ' type: string runId: description: 'The runId associated with the log. ' type: string sizeInBytes: description: 'The size of the object in bytes. ' format: int64 type: integer source: description: 'The source of the log such as driver and executor. ' enum: - APPLICATION - DRIVER - EXECUTOR type: string timeCreated: description: 'The date and time the object was created, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.29. ' format: date-time type: string type: description: 'The type of log such as stdout and stderr. ' enum: - STDERR - STDOUT type: string required: - name - runId - source - type RunSummary: description: 'A summary of the run. ' properties: applicationId: description: 'The application ID. ' type: string compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string dataReadInBytes: description: 'The data read by the run in bytes. ' format: int64 type: integer dataWrittenInBytes: description: 'The data written by the run in bytes. ' format: int64 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. This name is not necessarily unique. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The ID of a run. ' type: string language: description: 'The Spark language. ' enum: - SCALA - JAVA - PYTHON - SQL type: string x-obmcs-top-level-enum: '#/definitions/ApplicationLanguage' lifecycleDetails: description: 'The detailed messages about the lifecycle state. ' type: string lifecycleState: description: 'The current state of this run. ' enum: - ACCEPTED - IN_PROGRESS - CANCELING - CANCELED - FAILED - SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/RunLifecycleState' opcRequestId: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string ownerPrincipalId: description: 'The OCID of the user who created the resource. ' type: string ownerUserName: description: 'The username of the user who created the resource. If the username of the owner does not exist, `null` will be returned and the caller should refer to the ownerPrincipalId value instead. ' type: string poolId: description: 'The OCID of a pool. Unique Id to indentify a dataflow pool resource. ' maxLength: 255 minLength: 1 type: string runDurationInMilliseconds: description: 'The duration of the run in milliseconds. ' format: int64 type: integer timeCreated: description: 'The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string totalOCpu: description: 'The total number of oCPU requested by the run. ' format: int32 type: integer required: - applicationId - compartmentId - definedTags - freeformTags - id - language - lifecycleState - timeCreated - timeUpdated type: object Error: description: 'The error object. ' properties: code: description: 'The unique code of an error. ' type: string message: description: 'The description of an error. ' type: string required: - code - message ApplicationSummary: description: 'A Data Flow application object used in bulk listings. ' properties: compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. This name is not necessarily unique. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The application ID. ' type: string language: description: 'The Spark language. ' enum: - SCALA - JAVA - PYTHON - SQL type: string x-obmcs-top-level-enum: '#/definitions/ApplicationLanguage' lifecycleState: description: 'The current state of this application. ' enum: - ACTIVE - DELETING - DELETED - INACTIVE type: string x-obmcs-top-level-enum: '#/definitions/ApplicationLifecycleState' ownerPrincipalId: description: 'The OCID of the user who created the resource. ' type: string ownerUserName: description: 'The username of the user who created the resource. If the username of the owner does not exist, `null` will be returned and the caller should refer to the ownerPrincipalId value instead. ' type: string poolId: description: 'The OCID of a pool. Unique Id to indentify a dataflow pool resource. ' maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string required: - compartmentId - definedTags - displayName - freeformTags - id - language - lifecycleState - ownerPrincipalId - timeCreated - timeUpdated type: object PoolSchedule: description: Definition of when pool auto start or stop for a given day of a week. properties: dayOfWeek: description: 'Day of the week SUN-SAT ' enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY type: string x-obmcs-top-level-enum: '#/definitions/DayOfWeek' startTime: description: Hour of the day to start or stop pool. format: int32 maximum: 23 minimum: 0 type: integer stopTime: description: Hour of the day to stop the pool. format: int32 maximum: 23 minimum: 0 type: integer type: object Application: description: 'A Data Flow application object. ' properties: archiveUri: description: 'A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, ``oci://path/to/a.zip,oci://path/to/b.zip``. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^((?:oci):\/\/([^:\/]+)@([^:\/]+))(,(?:oci):\/\/([^:\/]+)@([^:\/]+))* type: string arguments: description: 'The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as `${name}`, where `name` is the name of the parameter. Example: `[ "--input", "${input_file}", "--name", "John Doe" ]` If "input_file" has a value of "mydata.xml", then the value above will be translated to `--input mydata.xml --name "John Doe"` ' items: type: string type: array className: description: 'The class for the application. ' type: string compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string configuration: additionalProperties: type: string description: 'The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned. ' type: object definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user-friendly description. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. This name is not necessarily unique. ' maxLength: 255 type: string driverShape: description: 'The VM shape for the driver. Sets the driver cores and memory. ' type: string driverShapeConfig: $ref: '#/components/schemas/ShapeConfig' execute: description: 'The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments. Example: ``--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10`` Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only. ' maxLength: 4000 minLength: 1 type: string executorShape: description: 'The VM shape for the executors. Sets the executor cores and memory. ' type: string executorShapeConfig: $ref: '#/components/schemas/ShapeConfig' fileUri: description: 'An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The application ID. ' type: string idleTimeoutInMinutes: default: 2880 description: 'The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days) ' format: int64 type: integer language: description: 'The Spark language. ' enum: - SCALA - JAVA - PYTHON - SQL type: string x-obmcs-top-level-enum: '#/definitions/ApplicationLanguage' lifecycleState: description: 'The current state of this application. ' enum: - ACTIVE - DELETING - DELETED - INACTIVE type: string x-obmcs-top-level-enum: '#/definitions/ApplicationLifecycleState' logsBucketUri: description: 'An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string maxDurationInMinutes: description: 'The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to `IN_PROGRESS` state. ' format: int64 type: integer metastoreId: description: 'The OCID of OCI Hive Metastore. ' maxLength: 255 minLength: 1 type: string numExecutors: description: 'The number of executor VMs requested. ' format: int32 minimum: 1 type: integer ownerPrincipalId: description: 'The OCID of the user who created the resource. ' type: string ownerUserName: description: 'The username of the user who created the resource. If the username of the owner does not exist, `null` will be returned and the caller should refer to the ownerPrincipalId value instead. ' type: string parameters: description: 'An array of name/value pairs used to fill placeholders found in properties like `Application.arguments`. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ] ' items: $ref: '#/components/schemas/ApplicationParameter' type: array poolId: description: 'The OCID of a pool. Unique Id to indentify a dataflow pool resource. ' maxLength: 255 minLength: 1 type: string privateEndpointId: description: 'The OCID of a private endpoint. ' maxLength: 255 minLength: 1 type: string sparkVersion: description: 'The Spark version utilized to run the application. ' type: string timeCreated: description: 'The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string warehouseBucketUri: description: 'An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string required: - compartmentId - displayName - driverShape - executorShape - fileUri - id - language - lifecycleState - numExecutors - ownerPrincipalId - sparkVersion - timeCreated - timeUpdated type: object ShapeConfig: description: 'This is used to configure the shape of the driver or executor if a flexible shape is used. ' properties: gpus: description: 'The total number of GPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. ' format: int32 minimum: 0 type: integer memoryInGBs: description: 'The amount of memory used for the driver or executors. ' format: integer minimum: 16 type: number ocpus: description: 'The total number of OCPUs used for the driver or executors. See [here](https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/20160918/Shape/) for details. ' format: integer minimum: 1 type: number x-default-description: 'null' ChangePoolCompartmentDetails: description: 'The details required to change a pool compartment. ' properties: compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object CreatePoolDetails: description: 'The details required to create a pool. ' properties: compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string configurations: description: 'List of PoolConfig items. ' items: $ref: '#/components/schemas/PoolConfig' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user-friendly description. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. It does not have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object idleTimeoutInMinutes: description: 'Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto. ' format: int32 maximum: 59940 minimum: 5 type: integer schedules: description: 'A list of schedules for pool to auto start and stop. ' items: $ref: '#/components/schemas/PoolSchedule' maxItems: 7 type: array required: - compartmentId - configurations - displayName type: object PrivateEndpointCollection: description: 'The results of a query for a list of private endpoints. It contains PrivateEndpointSummary items. ' properties: items: description: 'A list of private endpoints. ' items: $ref: '#/components/schemas/PrivateEndpointSummary' type: array required: - items type: object UpdatePrivateEndpointDetails: description: 'The details required to update a private endpoint. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user-friendly description. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. It does not have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string dnsZones: description: 'An array of DNS zone names. Example: `[ "app.examplecorp.com", "app.examplecorp2.com" ]` ' items: type: string maxLength: 255 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object maxHostCount: description: 'The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512. ' format: int32 minimum: 1 type: integer nsgIds: description: 'An array of network security group OCIDs. ' items: type: string maxLength: 255 type: array type: object WorkRequestSummary: description: 'A Data Flow work request summary object. ' properties: compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string id: description: 'The OCID of a work request. ' maxLength: 255 minLength: 1 type: string operation: description: 'The operation related to this work request. ' enum: - CREATE_PRIVATE_ENDPOINT - UPDATE_PRIVATE_ENDPOINT - DELETE_PRIVATE_ENDPOINT - MOVE_PRIVATE_ENDPOINT type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestOperation' percentComplete: description: 'Percentage of the request completed. ' format: float type: number resources: description: 'The resources affected by this work request. ' items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: 'The status of the work request. ' enum: - ACCEPTED - CANCELLED - CANCELLING - FAILED - INPROGRESS - SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - compartmentId - id - percentComplete - operation - status type: object PoolSummary: description: 'A pool object used in bulk listings. ' properties: compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. It does not have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The OCID of a pool. Unique Id to indentify a dataflow pool resource. ' maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The current state of this pool. ' enum: - ACCEPTED - SCHEDULED - CREATING - ACTIVE - STOPPING - STOPPED - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/PoolLifecycleState' ownerPrincipalId: description: 'The OCID of the user who created the resource. ' type: string ownerUserName: description: 'The username of the user who created the resource. If the username of the owner does not exist, `null` will be returned and the caller should refer to the ownerPrincipalId value instead. ' type: string timeCreated: description: 'The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - displayName - ownerPrincipalId - ownerUserName - lifecycleState - timeCreated - timeUpdated - freeformTags - definedTags type: object UpdateApplicationDetails: description: 'The update application details. ' properties: archiveUri: description: 'A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, ``oci://path/to/a.zip,oci://path/to/b.zip``. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^((?:oci):\/\/([^:\/]+)@([^:\/]+))(,(?:oci):\/\/([^:\/]+)@([^:\/]+))* type: string arguments: description: 'The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as `${name}`, where `name` is the name of the parameter. Example: `[ "--input", "${input_file}", "--name", "John Doe" ]` If "input_file" has a value of "mydata.xml", then the value above will be translated to `--input mydata.xml --name "John Doe"` ' items: type: string type: array className: description: 'The class for the application. ' type: string configuration: additionalProperties: type: string description: 'The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned. ' type: object definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user-friendly description. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. It does not have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string driverShape: description: 'The VM shape for the driver. Sets the driver cores and memory. ' type: string driverShapeConfig: $ref: '#/components/schemas/ShapeConfig' execute: description: 'The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments. Example: ``--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10`` Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only. ' maxLength: 4000 minLength: 1 type: string executorShape: description: 'The VM shape for the executors. Sets the executor cores and memory. ' type: string executorShapeConfig: $ref: '#/components/schemas/ShapeConfig' fileUri: description: 'An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object idleTimeoutInMinutes: default: 2880 description: 'The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days) ' format: int64 type: integer language: description: 'The Spark language. ' enum: - SCALA - JAVA - PYTHON - SQL type: string x-obmcs-top-level-enum: '#/definitions/ApplicationLanguage' logsBucketUri: description: 'An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string maxDurationInMinutes: description: 'The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to `IN_PROGRESS` state. ' format: int64 type: integer metastoreId: description: 'The OCID of OCI Hive Metastore. ' maxLength: 255 minLength: 1 type: string numExecutors: description: 'The number of executor VMs requested. ' format: int32 minimum: 1 type: integer parameters: description: 'An array of name/value pairs used to fill placeholders found in properties like `Application.arguments`. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ] ' items: $ref: '#/components/schemas/ApplicationParameter' type: array poolId: description: 'The OCID of a pool. Unique Id to indentify a dataflow pool resource. ' maxLength: 255 minLength: 1 type: string privateEndpointId: description: 'The OCID of a private endpoint. ' maxLength: 255 minLength: 1 type: string sparkVersion: description: 'The Spark version utilized to run the application. ' type: string warehouseBucketUri: description: 'An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string type: object CreateApplicationDetails: description: 'The create application details. ' properties: archiveUri: description: 'A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, ``oci://path/to/a.zip,oci://path/to/b.zip``. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^((?:oci):\/\/([^:\/]+)@([^:\/]+))(,(?:oci):\/\/([^:\/]+)@([^:\/]+))* type: string arguments: description: 'The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as `${name}`, where `name` is the name of the parameter. Example: `[ "--input", "${input_file}", "--name", "John Doe" ]` If "input_file" has a value of "mydata.xml", then the value above will be translated to `--input mydata.xml --name "John Doe"` ' items: type: string type: array className: description: 'The class for the application. ' type: string compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string configuration: additionalProperties: type: string description: 'The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned. ' type: object definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user-friendly description. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. It does not have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string driverShape: description: 'The VM shape for the driver. Sets the driver cores and memory. ' type: string driverShapeConfig: $ref: '#/components/schemas/ShapeConfig' execute: description: 'The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments. Example: ``--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10`` Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only. ' maxLength: 4000 minLength: 1 type: string executorShape: description: 'The VM shape for the executors. Sets the executor cores and memory. ' type: string executorShapeConfig: $ref: '#/components/schemas/ShapeConfig' fileUri: description: 'An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object idleTimeoutInMinutes: default: 2880 description: 'The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days) ' format: int64 type: integer language: description: 'The Spark language. ' enum: - SCALA - JAVA - PYTHON - SQL type: string x-obmcs-top-level-enum: '#/definitions/ApplicationLanguage' logsBucketUri: description: 'An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string maxDurationInMinutes: description: 'The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to `IN_PROGRESS` state. ' format: int64 type: integer metastoreId: description: 'The OCID of OCI Hive Metastore. ' maxLength: 255 minLength: 1 type: string numExecutors: description: 'The number of executor VMs requested. ' format: int32 minimum: 1 type: integer parameters: description: 'An array of name/value pairs used to fill placeholders found in properties like `Application.arguments`. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ] ' items: $ref: '#/components/schemas/ApplicationParameter' type: array poolId: description: 'The OCID of a pool. Unique Id to indentify a dataflow pool resource. ' maxLength: 255 minLength: 1 type: string privateEndpointId: description: 'The OCID of a private endpoint. ' maxLength: 255 minLength: 1 type: string sparkVersion: description: 'The Spark version utilized to run the application. ' type: string warehouseBucketUri: description: 'An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string required: - compartmentId - displayName - driverShape - executorShape - language - numExecutors - sparkVersion type: object WorkRequestLogCollection: description: 'Results of a query for a list of work request logs. Contains WorkRequestLog items. ' properties: items: description: 'A list of work request logs. ' items: $ref: '#/components/schemas/WorkRequestLog' type: array required: - items type: object ChangeSqlEndpointCompartmentDetails: description: Details for changing the compartment of a SQL Endpoint. properties: compartmentId: description: The OCID of the compartment into which the resource should be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object SqlEndpoint: description: The description of a SQL Endpoint. properties: bannerMessage: description: The SQL Endpoint message displayed as a banner to provide user with any action items required on the resource. maxLength: 255 minLength: 1 type: string compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the SQL Endpoint. maxLength: 400 minLength: 1 type: string displayName: description: The SQL Endpoint name, which can be changed. maxLength: 255 minLength: 1 type: string driverShape: description: The shape of the SQL Endpoint driver instance. maxLength: 255 minLength: 1 type: string driverShapeConfig: $ref: '#/components/schemas/ShapeConfig' executorShape: description: The shape of the SQL Endpoint executor instance. maxLength: 255 minLength: 1 type: string executorShapeConfig: $ref: '#/components/schemas/ShapeConfig' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The provision identifier that is immutable on creation. maxLength: 255 minLength: 1 type: string jdbcEndpointUrl: description: The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI format: uri pattern: ^(?:jdbc:spark):\/\/([^:\/]+)\/default;SparkServerType=DFI;httpPath=cliservice type: string lakeId: description: The OCID of OCI Lake. maxLength: 255 minLength: 1 type: string lastAcceptedRequestToken: description: This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed. minLength: 0 type: string lifecycleState: description: The current state of the Sql Endpoint. enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED - UPDATING - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/SqlEndpointLifecycleState' maxExecutorCount: description: The maximum number of executors. type: integer metastoreId: description: 'The OCID of OCI Hive Metastore. ' maxLength: 255 minLength: 1 type: string minExecutorCount: default: 1 description: The minimum number of executors. minimum: 1 type: integer networkConfiguration: $ref: '#/components/schemas/SqlEndpointNetworkConfiguration' sparkAdvancedConfigurations: additionalProperties: type: string description: 'The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned. ' type: object sqlEndpointVersion: description: The version of SQL Endpoint. maxLength: 64 minLength: 1 type: string stateMessage: description: A message describing the reason why the resource is in it's current state. Helps bubble up errors in state changes. For example, it can be used to provide actionable information for a resource in the Failed state. minLength: 0 type: string systemTags: additionalProperties: additionalProperties: type: object type: object description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` ' type: object timeCreated: description: The time the Sql Endpoint was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the Sql Endpoint was updated. An RFC3339 formatted datetime string. format: date-time type: string warehouseBucketUri: description: The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string required: - id - displayName - compartmentId - sqlEndpointVersion - driverShape - executorShape - minExecutorCount - maxExecutorCount - metastoreId - lakeId - warehouseBucketUri - description type: object StatementOutputData: description: 'An object representing execution output of a statement. ' discriminator: propertyName: type properties: type: description: 'The type of the `StatementOutputData` like `TEXT_PLAIN`, `TEXT_HTML` or `IMAGE_PNG`. ' enum: - TEXT_PLAIN - TEXT_HTML - IMAGE_PNG type: string required: - type type: object UpdateRunDetails: description: 'The update run details. Only a limited set of properties of a run can be updated. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object idleTimeoutInMinutes: default: 2880 description: 'The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days) ' format: int64 type: integer maxDurationInMinutes: description: 'The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to `IN_PROGRESS` state. ' format: int64 type: integer type: object CreateSqlEndpointDetails: description: The information about a new SQL Endpoint. properties: compartmentId: description: The identifier of the compartment used with the SQL Endpoint. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of CreateSQLEndpointDetails. maxLength: 400 minLength: 1 type: string displayName: description: The SQL Endpoint name, which can be changed. maxLength: 255 minLength: 1 type: string driverShape: description: The shape of the SQL Endpoint driver instance. maxLength: 255 minLength: 1 type: string driverShapeConfig: $ref: '#/components/schemas/ShapeConfig' executorShape: description: The shape of the SQL Endpoint worker instance. maxLength: 255 minLength: 1 type: string executorShapeConfig: $ref: '#/components/schemas/ShapeConfig' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object lakeId: description: OCI lake OCID maxLength: 255 minLength: 1 type: string maxExecutorCount: description: The maximum number of executors. type: integer metastoreId: description: Metastore OCID maxLength: 255 minLength: 1 type: string minExecutorCount: description: The minimum number of executors. type: integer networkConfiguration: $ref: '#/components/schemas/SqlEndpointNetworkConfiguration' sparkAdvancedConfigurations: additionalProperties: type: string description: 'The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned. ' type: object sqlEndpointVersion: description: The version of the SQL Endpoint. maxLength: 64 minLength: 1 type: string warehouseBucketUri: description: The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string required: - compartmentId - displayName - sqlEndpointVersion - driverShape - executorShape - minExecutorCount - maxExecutorCount - metastoreId - lakeId - warehouseBucketUri - networkConfiguration type: object WorkRequest: description: 'A Data Flow work request object. ' properties: compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string id: description: 'The OCID of a work request. ' maxLength: 255 minLength: 1 type: string operation: description: 'The operation related to this work request. ' enum: - CREATE_PRIVATE_ENDPOINT - UPDATE_PRIVATE_ENDPOINT - DELETE_PRIVATE_ENDPOINT - MOVE_PRIVATE_ENDPOINT type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestOperation' percentComplete: description: 'Percentage of the request completed. ' format: float type: number resources: description: 'The resources affected by this work request. ' items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: 'The status of the work request. ' enum: - ACCEPTED - CANCELLED - CANCELLING - FAILED - INPROGRESS - SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus' timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - compartmentId - id - percentComplete - operation - resources - status type: object ApplicationParameter: description: 'The parameter of an application. ' properties: name: description: 'The name of the parameter. It must be a string of one or more word characters (a-z, A-Z, 0-9, _). Examples: "iterations", "input_file" ' minLength: 1 pattern: ^\w+$ type: string value: description: 'The value of the parameter. It must be a string of 0 or more characters of any kind. Examples: "" (empty string), "10", "mydata.xml", "${x}" ' minLength: 0 type: string required: - name - value type: object WorkRequestCollection: description: 'Results of a query for a list of work requests. Contains WorkRequestSummary items. ' properties: items: description: 'A list of work requests ' items: $ref: '#/components/schemas/WorkRequestSummary' type: array required: - items type: object StatementSummary: description: 'Summary of the statement. ' properties: id: description: 'The statement ID. ' format: int64 type: integer lifecycleState: description: 'The current state of this statement. ' enum: - ACCEPTED - CANCELLING - CANCELLED - FAILED - IN_PROGRESS - SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/StatementLifecycleState' runId: description: 'The ID of a run. ' type: string timeCompleted: description: 'The date and time a statement execution was completed, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2022-05-31T21:10:29.600Z` ' format: date-time type: string timeCreated: description: 'The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string required: - id - lifecycleState - timeCreated type: object WorkRequestResource: description: 'A resource related to a Data Flow work request. ' properties: actionType: description: 'The way in which this resource is affected by the work tracked in the work request. ' enum: - CREATED - UPDATED - DELETED - INPROGRESS - RELATED type: string id: description: 'The id of a work request resource object. ' format: int64 type: integer resourceId: description: 'The id of the releated resource. See resourceType to identity the specific type of resource. ' type: string resourceType: description: 'The type of resource. See resourceId for the id of the specific resource. ' type: string resourceUri: description: 'The URI path that the user can use to get access to the resource metadata ' type: string workRequestid: description: 'The OCID of a work request. ' maxLength: 255 minLength: 1 type: string required: - actionType - resourceId - resourceType type: object StatementCollection: description: 'The results of a query for a list of statements of a Session Run. It contains StatementSummary items. ' properties: items: description: 'A list of statements for a Session Run. ' items: $ref: '#/components/schemas/StatementSummary' type: array required: - items type: object UpdatePoolDetails: description: 'The details required to update a given pool with ```poolId```. ' properties: configurations: description: 'List of PoolConfig items. ' items: $ref: '#/components/schemas/PoolConfig' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user-friendly description. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. It does not have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object idleTimeoutInMinutes: description: 'Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto. ' format: int32 maximum: 59940 minimum: 5 type: integer schedules: description: 'A list of schedules for pool to auto start and stop. ' items: $ref: '#/components/schemas/PoolSchedule' maxItems: 7 type: array type: object WorkRequestLog: description: 'A Data Flow work request log object. ' properties: id: description: 'The id of a work request log. ' format: int64 type: integer message: description: A human readable log message. type: string timestamp: description: The time the log message was written. An RFC3339 formatted datetime string. format: date-time type: string workRequestid: description: 'The OCID of a work request. ' maxLength: 255 minLength: 1 type: string required: - message - timestamp type: object ChangeRunCompartmentDetails: description: 'The change run compartment details. ' properties: compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object WorkRequestError: description: 'A Data Flow work request error object. ' properties: code: description: 'A Machine-usable code for the error that occured. ' type: string id: description: 'The id of a work request error. ' format: int64 type: integer message: description: A human readable description of the issue encountered. type: string timestamp: description: The time the error occured. An RFC3339 formatted datetime string. format: date-time type: string workRequestid: description: 'The OCID of a work request. ' maxLength: 255 minLength: 1 type: string required: - code - message - timestamp type: object SqlEndpointSummary: description: A summary of the Sql Endpoint. properties: compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description of the SQL Endpoint. maxLength: 400 minLength: 1 type: string displayName: description: The SQL Endpoint name, which can be changed. maxLength: 255 minLength: 1 type: string driverShape: description: The shape of the SQL Endpoint driver instance. maxLength: 255 minLength: 1 type: string driverShapeConfig: $ref: '#/components/schemas/ShapeConfig' executorShape: description: The shape of the SQL Endpoint executor instance. maxLength: 255 minLength: 1 type: string executorShapeConfig: $ref: '#/components/schemas/ShapeConfig' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The provision identifier that is immutable on creation. maxLength: 255 minLength: 1 type: string jdbcEndpointUrl: description: The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI format: uri pattern: ^(?:jdbc:spark):\/\/([^:\/]+)\/default;SparkServerType=DFI;httpPath=cliservice type: string lakeId: description: The OCID of OCI Lake. maxLength: 255 minLength: 1 type: string lastAcceptedRequestToken: description: This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed. minLength: 0 type: string lifecycleState: description: The current state of the Sql Endpoint. enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED - UPDATING - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/SqlEndpointLifecycleState' maxExecutorCount: description: The maximum number of executors. type: integer metastoreId: description: 'The OCID of OCI Hive Metastore. ' maxLength: 255 minLength: 1 type: string minExecutorCount: default: 1 description: The minimum number of executors. minimum: 1 type: integer networkConfiguration: $ref: '#/components/schemas/SqlEndpointNetworkConfiguration' ownerPrincipalId: description: 'The OCID of the user who created the resource. ' type: string sparkAdvancedConfigurations: additionalProperties: type: string description: 'The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned. ' type: object sqlEndpointVersion: description: The version of SQL Endpoint. maxLength: 64 minLength: 1 type: string stateMessage: description: A message describing the reason why the resource is in it's current state. Helps bubble up errors in state changes. For example, it can be used to provide actionable information for a resource in the Failed state. minLength: 0 type: string systemTags: additionalProperties: additionalProperties: type: object type: object description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` ' type: object timeCreated: description: The time the Sql Endpoint was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time the Sql Endpoint was updated. An RFC3339 formatted datetime string. format: date-time type: string warehouseBucketUri: description: The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string required: - id - displayName - compartmentId - sqlEndpointVersion - driverShape - executorShape - minExecutorCount - maxExecutorCount - metastoreId - lakeId - warehouseBucketUri - description type: object ChangePrivateEndpointCompartmentDetails: description: 'The details required to change a private endpoint compartment. ' properties: compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object PrivateEndpointSummary: description: 'A Data Flow private endpoint object used in bulk listings. ' properties: compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. It does not have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string dnsZones: description: 'An array of DNS zone names. Example: `[ "app.examplecorp.com", "app.examplecorp2.com" ]` ' items: type: string maxLength: 255 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The OCID of a private endpoint. ' maxLength: 255 minLength: 1 type: string lifecycleState: description: 'The current state of this private endpoint. ' enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/PrivateEndpointLifecycleState' maxHostCount: description: 'The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512. ' format: int32 minimum: 1 type: integer nsgIds: description: 'An array of network security group OCIDs. ' items: type: string maxLength: 255 type: array ownerPrincipalId: description: 'The OCID of the user who created the resource. ' type: string ownerUserName: description: 'The username of the user who created the resource. If the username of the owner does not exist, `null` will be returned and the caller should refer to the ownerPrincipalId value instead. ' type: string subnetId: description: 'The OCID of a subnet. ' maxLength: 255 type: string timeCreated: description: 'The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string required: - compartmentId - definedTags - dnsZones - displayName - freeformTags - id - lifecycleState - ownerPrincipalId - subnetId - timeCreated - timeUpdated type: object PoolConfig: description: 'An object containing the details about the compute shapes and number of compute instances to provison. ' properties: max: description: 'Maximum number of compute instances in the pool for a given compute shape. ' format: int32 maximum: 1000 minimum: 1 type: integer min: description: 'Minimum number of compute instances in the pool for a given compute shape. ' format: int32 maximum: 1000 minimum: 1 type: integer shape: description: 'The compute shape of the resources you would like to provision. ' type: string shapeConfig: $ref: '#/components/schemas/ShapeConfig' CreateRunDetails: description: "The create run details. The following properties are optional and override the default values\nset in the associated application:\n - applicationId\n - archiveUri\n - arguments\n - configuration\n - definedTags\n - displayName\n - driverShape\n - execute\n - executorShape\n - freeformTags\n - logsBucketUri\n - metastoreId\n - numExecutors\n - parameters\n - sparkVersion\n - warehouseBucketUri\nIt is expected that either the applicationId or the execute parameter is specified; but not both.\nIf both or none are set, a Bad Request (HTTP 400) status will be sent as the response.\nIf an appicationId is not specified, then a value for the execute parameter is expected.\nUsing data parsed from the value, a new application will be created and assicated with the new run.\nSee information on the execute parameter for details on the format of this parameter.\n\nThe optional parameter spark version can only be specified when using the execute parameter. If it\nis not specified when using the execute parameter, the latest version will be used as default.\nIf the execute parameter is not used, the spark version will be taken from the associated application.\n\nIf displayName is not specified, it will be derived from the displayName of associated application or\nset by API using fileUri's application file name.\nOnce a run is created, its properties (except for definedTags and freeformTags) cannot be changed.\nIf the parent application's properties (including definedTags and freeformTags) are updated,\nthe corresponding properties of the run will not update.\n" properties: applicationId: description: 'The OCID of the associated application. If this value is set, then no value for the execute parameter is required. If this value is not set, then a value for the execute parameter is required, and a new application is created and associated with the new run. ' type: string archiveUri: description: 'A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, ``oci://path/to/a.zip,oci://path/to/b.zip``. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^((?:oci):\/\/([^:\/]+)@([^:\/]+))(,(?:oci):\/\/([^:\/]+)@([^:\/]+))* type: string arguments: description: 'The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as `${name}`, where `name` is the name of the parameter. Example: `[ "--input", "${input_file}", "--name", "John Doe" ]` If "input_file" has a value of "mydata.xml", then the value above will be translated to `--input mydata.xml --name "John Doe"` ' items: type: string type: array compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string configuration: additionalProperties: type: string description: 'The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned. ' type: object definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name that does not have to be unique. Avoid entering confidential information. If this value is not specified, it will be derived from the associated application''s displayName or set by API using fileUri''s application file name. ' type: string driverShape: description: 'The VM shape for the driver. Sets the driver cores and memory. ' type: string driverShapeConfig: $ref: '#/components/schemas/ShapeConfig' execute: description: 'The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments. Example: ``--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10`` Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only. ' maxLength: 4000 minLength: 1 type: string executorShape: description: 'The VM shape for the executors. Sets the executor cores and memory. ' type: string executorShapeConfig: $ref: '#/components/schemas/ShapeConfig' freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object idleTimeoutInMinutes: default: 2880 description: 'The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days) ' format: int64 type: integer logsBucketUri: description: 'An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string maxDurationInMinutes: description: 'The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to `IN_PROGRESS` state. ' format: int64 type: integer metastoreId: description: 'The OCID of OCI Hive Metastore. ' maxLength: 255 minLength: 1 type: string numExecutors: description: 'The number of executor VMs requested. ' format: int32 minimum: 1 type: integer parameters: description: 'An array of name/value pairs used to fill placeholders found in properties like `Application.arguments`. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ] ' items: $ref: '#/components/schemas/ApplicationParameter' type: array poolId: description: 'The OCID of a pool. Unique Id to indentify a dataflow pool resource. ' maxLength: 255 minLength: 1 type: string sparkVersion: description: 'The Spark version utilized to run the application. This value may be set if applicationId is not since the Spark version will be taken from the associated application. ' type: string warehouseBucketUri: description: 'An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string required: - compartmentId type: object SqlEndpointNetworkConfiguration: description: The network configuration of a SQL Endpoint. discriminator: propertyName: networkType properties: networkType: default: SECURE_ACCESS description: The type of network configuration. enum: - VCN - SECURE_ACCESS type: string x-obmcs-top-level-enum: '#/definitions/NetworkType' required: - networkType type: object CreatePrivateEndpointDetails: description: 'The details required to create a private endpoint. ' properties: compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user-friendly description. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. It does not have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string dnsZones: description: 'An array of DNS zone names. Example: `[ "app.examplecorp.com", "app.examplecorp2.com" ]` ' items: type: string maxLength: 255 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object maxHostCount: description: 'The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512. ' format: int32 minimum: 1 type: integer nsgIds: description: 'An array of network security group OCIDs. ' items: type: string maxLength: 255 type: array subnetId: description: 'The OCID of a subnet. ' maxLength: 255 type: string required: - compartmentId - dnsZones - subnetId type: object ChangeApplicationCompartmentDetails: description: 'The change application compartment details. ' properties: compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateSqlEndpointDetails: description: The information about all updatable parameters of a SQL Endpoint. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object PoolMetrics: description: 'A collection of metrics related to a particular pool. ' properties: activeRunsCount: description: 'The number of runs that are currently running that are using this pool. ' format: int64 type: integer activelyUsedNodeCount: description: 'A count of the nodes that are currently being used for each shape in this pool. ' items: $ref: '#/components/schemas/NodeCount' type: array timeLastMetricsUpdated: description: 'The last time the mertics were updated for this. ' format: date-time type: string timeLastStarted: description: 'The last time this pool was started. ' format: date-time type: string timeLastStopped: description: 'The last time this pool was stopped. ' format: date-time type: string timeLastUsed: description: 'The last time a run used this pool. ' format: date-time type: string NodeCount: description: 'An object with a logical shape and count of the number of nodes with that shape. ' properties: count: description: 'The node count of this compute shape. ' format: int32 type: integer logicalShape: description: 'The compute shape of the nodes that the count is for. ' type: string SqlEndpointCollection: description: The results of a Sql Endpoint search. It contains the objects in a SqlEndpointSummary. properties: items: description: The collection of SqlEndpointSummary objects. items: $ref: '#/components/schemas/SqlEndpointSummary' maxItems: 100 type: array required: - items type: object Pool: description: 'A Data Flow pool object. ' properties: compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string configurations: description: 'List of PoolConfig items. ' items: $ref: '#/components/schemas/PoolConfig' type: array definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user-friendly description. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. It does not have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The OCID of a pool. Unique Id to indentify a dataflow pool resource. ' maxLength: 255 minLength: 1 type: string idleTimeoutInMinutes: description: 'Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto. ' format: int32 maximum: 59940 minimum: 5 type: integer lifecycleDetails: description: 'The detailed messages about the lifecycle state. ' type: string lifecycleState: description: 'The current state of this pool. ' enum: - ACCEPTED - SCHEDULED - CREATING - ACTIVE - STOPPING - STOPPED - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/PoolLifecycleState' ownerPrincipalId: description: 'The OCID of the user who created the resource. ' type: string ownerUserName: description: 'The username of the user who created the resource. If the username of the owner does not exist, `null` will be returned and the caller should refer to the ownerPrincipalId value instead. ' type: string poolMetrics: $ref: '#/components/schemas/PoolMetrics' schedules: description: 'A list of schedules for pool to auto start and stop. ' items: $ref: '#/components/schemas/PoolSchedule' maxItems: 7 type: array timeCreated: description: 'The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string required: - compartmentId - configurations - definedTags - displayName - freeformTags - id - lifecycleState - ownerPrincipalId - timeCreated - timeUpdated type: object WorkRequestErrorCollection: description: 'Results of a query for a list of work request errors. Contains WorkRequestError items. ' properties: items: description: 'A list of work request errors. ' items: $ref: '#/components/schemas/WorkRequestError' type: array required: - items type: object PrivateEndpoint: description: 'A Data Flow private endpoint object. ' properties: compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user-friendly description. Avoid entering confidential information. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. It does not have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string dnsZones: description: 'An array of DNS zone names. Example: `[ "app.examplecorp.com", "app.examplecorp2.com" ]` ' items: type: string maxLength: 255 type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The OCID of a private endpoint. ' maxLength: 255 minLength: 1 type: string lifecycleDetails: description: 'The detailed messages about the lifecycle state. ' type: string lifecycleState: description: 'The current state of this private endpoint. ' enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/PrivateEndpointLifecycleState' maxHostCount: description: 'The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512. ' format: int32 minimum: 1 type: integer nsgIds: description: 'An array of network security group OCIDs. ' items: type: string maxLength: 255 type: array ownerPrincipalId: description: 'The OCID of the user who created the resource. ' type: string ownerUserName: description: 'The username of the user who created the resource. If the username of the owner does not exist, `null` will be returned and the caller should refer to the ownerPrincipalId value instead. ' type: string subnetId: description: 'The OCID of a subnet. ' maxLength: 255 type: string timeCreated: description: 'The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string required: - compartmentId - definedTags - displayName - dnsZones - freeformTags - id - lifecycleState - ownerPrincipalId - subnetId - timeCreated - timeUpdated type: object StatementOutput: description: 'The execution output of a statement. ' properties: data: $ref: '#/components/schemas/StatementOutputData' errorName: description: 'The name of the error in the statement output. ' type: string errorValue: description: 'The value of the error in the statement output. ' type: string status: description: 'Status of the statement output. ' enum: - OK - ERROR type: string traceback: description: 'The traceback of the statement output. ' items: type: string maxItems: 100 type: array type: object CreateStatementDetails: description: 'The details required to create a statement. ' properties: code: description: 'The statement code to execute. Example: `println(sc.version)` ' maxLength: 1048576 type: string required: - code type: object Run: description: 'A run object. ' properties: applicationId: description: 'The application ID. ' type: string archiveUri: description: 'A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, ``oci://path/to/a.zip,oci://path/to/b.zip``. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^((?:oci):\/\/([^:\/]+)@([^:\/]+))(,(?:oci):\/\/([^:\/]+)@([^:\/]+))* type: string arguments: description: 'The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as `${name}`, where `name` is the name of the parameter. Example: `[ "--input", "${input_file}", "--name", "John Doe" ]` If "input_file" has a value of "mydata.xml", then the value above will be translated to `--input mydata.xml --name "John Doe"` ' items: type: string type: array className: description: 'The class for the application. ' type: string compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string configuration: additionalProperties: type: string description: 'The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned. ' type: object dataReadInBytes: description: 'The data read by the run in bytes. ' format: int64 type: integer dataWrittenInBytes: description: 'The data written by the run in bytes. ' format: int64 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. This name is not necessarily unique. ' maxLength: 255 type: string driverShape: description: 'The VM shape for the driver. Sets the driver cores and memory. ' type: string driverShapeConfig: $ref: '#/components/schemas/ShapeConfig' execute: description: 'The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments. Example: ``--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10`` Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only. ' maxLength: 4000 minLength: 1 type: string executorShape: description: 'The VM shape for the executors. Sets the executor cores and memory. ' type: string executorShapeConfig: $ref: '#/components/schemas/ShapeConfig' fileUri: description: 'An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The ID of a run. ' type: string idleTimeoutInMinutes: default: 2880 description: 'The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days) ' format: int64 type: integer language: description: 'The Spark language. ' enum: - SCALA - JAVA - PYTHON - SQL type: string x-obmcs-top-level-enum: '#/definitions/ApplicationLanguage' lifecycleDetails: description: 'The detailed messages about the lifecycle state. ' type: string lifecycleState: description: 'The current state of this run. ' enum: - ACCEPTED - IN_PROGRESS - CANCELING - CANCELED - FAILED - SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/RunLifecycleState' logsBucketUri: description: 'An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string maxDurationInMinutes: description: 'The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to `IN_PROGRESS` state. ' format: int64 type: integer metastoreId: description: 'The OCID of OCI Hive Metastore. ' maxLength: 255 minLength: 1 type: string numExecutors: description: 'The number of executor VMs requested. ' format: int32 minimum: 1 type: integer opcRequestId: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string ownerPrincipalId: description: 'The OCID of the user who created the resource. ' type: string ownerUserName: description: 'The username of the user who created the resource. If the username of the owner does not exist, `null` will be returned and the caller should refer to the ownerPrincipalId value instead. ' type: string parameters: description: 'An array of name/value pairs used to fill placeholders found in properties like `Application.arguments`. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ] ' items: $ref: '#/components/schemas/ApplicationParameter' type: array poolId: description: 'The OCID of a pool. Unique Id to indentify a dataflow pool resource. ' maxLength: 255 minLength: 1 type: string privateEndpointDnsZones: description: 'An array of DNS zone names. Example: `[ "app.examplecorp.com", "app.examplecorp2.com" ]` ' items: type: string maxLength: 255 type: array privateEndpointId: description: 'The OCID of a private endpoint. ' maxLength: 255 minLength: 1 type: string privateEndpointMaxHostCount: description: 'The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512. ' format: int32 minimum: 1 type: integer privateEndpointNsgIds: description: 'An array of network security group OCIDs. ' items: type: string maxLength: 255 type: array privateEndpointSubnetId: description: 'The OCID of a subnet. ' maxLength: 255 type: string runDurationInMilliseconds: description: 'The duration of the run in milliseconds. ' format: int64 type: integer sparkVersion: description: 'The Spark version utilized to run the application. ' type: string timeCreated: description: 'The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string totalOCpu: description: 'The total number of oCPU requested by the run. ' format: int32 type: integer warehouseBucketUri: description: 'An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string required: - applicationId - compartmentId - driverShape - executorShape - fileUri - id - language - lifecycleState - numExecutors - sparkVersion - timeCreated - timeUpdated type: object parameters: LogNamePathParam: description: 'The name of the log. Avoid entering confidential information. ' in: path name: name required: true schema: type: string maxLength: 1024 minLength: 1 pattern: ^spark_(?:driver|executor|application)_(?:stdout|stderr)(?:_[0-9a-zA-Z]+)?\.log\.gz$ SqlEndpointIdPathParam: description: The unique id of the SQL Endpoint. in: path name: sqlEndpointId required: true schema: type: string maxLength: 255 minLength: 1 OwnerPrincipalIdQueryParam: description: 'The OCID of the user who created the resource. ' in: query name: ownerPrincipalId required: false x-default-description: 'null' schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match schema: type: string DisplayNameStartsWithQueryParam: description: 'The displayName prefix. ' in: query name: displayNameStartsWith required: false x-default-description: 'null' schema: type: string SortOrderQueryParam: description: 'The ordering of results in ascending or descending order. ' in: query name: sortOrder required: false x-default-description: Defaults to `ASC` when sortBy is equal to "displayName" and defaults to `DESC` for all other sortBy values. schema: type: string enum: - ASC - DESC SqlEndpointIdQueryParam: description: The unique id of the SQL Endpoint. in: query name: sqlEndpointId required: false schema: type: string maxLength: 255 minLength: 1 StatementIdPathParam: description: 'The unique ID for the statement. ' in: path name: statementId required: true schema: type: string ApplicationIdPathParam: description: 'The unique ID for an application. ' in: path name: applicationId required: true schema: type: string ApplicationSortByQueryParam: description: 'The field used to sort the results. Multiple fields are not supported. ' in: query name: sortBy required: false schema: type: string enum: - timeCreated - displayName - language default: timeCreated PoolIdPathParam: description: 'The unique ID for a pool. ' in: path name: poolId required: true schema: type: string OptionalCompartmentIdQueryParam: description: The OCID of the compartment in which to query resources. in: query name: compartmentId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RunSortByQueryParam: description: 'The field used to sort the results. Multiple fields are not supported. ' in: query name: sortBy required: false schema: type: string enum: - timeCreated - displayName - language - runDurationInMilliseconds - lifecycleState - totalOCpu - dataReadInBytes - dataWrittenInBytes default: timeCreated WorkRequestIdPathParam: description: 'The unique ID for a work request. ' in: path name: workRequestId required: true schema: type: string SqlEndpointLifecycleStateQueryParam: description: A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/SqlEndpointLifecycleState' schema: type: string enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED - UPDATING - NEEDS_ATTENTION DisplayNameQueryParam: description: 'The query parameter for the Spark application name. ' in: query name: displayName required: false x-default-description: 'null' schema: type: string PoolIdQueryParam: description: 'The ID of the pool. ' in: query name: poolId required: false x-default-description: 'null' schema: type: string PaginationTokenQueryParam: description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. in: query name: page schema: type: string minLength: 1 PrivateEndpointIdPathParam: description: 'The unique ID for a private endpoint. ' in: path name: privateEndpointId required: true schema: type: string SqlEndpointSortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. The default order for displayName is ascending. If no value is specified timeCreated is used by default. ' in: query name: sortBy schema: type: string enum: - id - timeCreated - displayName default: timeCreated LimitQueryParam: description: 'The maximum number of results to return in a paginated `List` call. ' in: query name: limit schema: type: integer format: int32 default: 100 PoolLifecycleStateQueryParam: description: 'The LifecycleState of the pool. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/PoolLifecycleState' schema: type: string enum: - ACCEPTED - SCHEDULED - CREATING - ACTIVE - STOPPING - STOPPED - UPDATING - DELETING - DELETED - FAILED OpcRequestIdHeader: description: 'Unique identifier for the request. If provided, the returned request ID will include this value. Otherwise, a random request ID will be generated by the service. ' in: header name: opc-request-id required: false schema: type: string TimeCreatedGreaterThanQueryParam: description: 'The epoch time that the resource was created. ' in: query name: timeCreatedGreaterThan required: false x-default-description: 'null' schema: type: string format: date-time LogLimitQueryParam: description: 'The maximum number of results to return in a paginated "List" call. ' in: query name: limit schema: type: integer format: int32 default: 10 ApplicationIdQueryParam: description: 'The ID of the application. ' in: query name: applicationId required: false x-default-description: 'null' schema: type: string PoolSortByQueryParam: description: 'The field used to sort the results. Multiple fields are not supported. ' in: query name: sortBy required: false schema: type: string enum: - timeCreated default: timeCreated StatementSortByQueryParam: description: 'The field used to sort the results. Multiple fields are not supported. ' in: query name: sortBy required: false schema: type: string enum: - timeCreated default: timeCreated PrivateEndpointLifecycleStateQueryParam: description: 'The LifecycleState of the private endpoint. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/PrivateEndpointLifecycleState' schema: type: string enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED PageQueryParam: description: 'The value of the `opc-next-page` or `opc-prev-page` response header from the last `List` call to sent back to server for getting the next page of results. ' in: query name: page x-default-description: 'null' schema: type: string OpcRetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected. ' in: header name: opc-retry-token required: false schema: type: string CompartmentIdQueryParam: description: 'The OCID of the compartment. ' in: query name: compartmentId required: true schema: type: string PaginationLimitQueryParam: description: The maximum number of items that can be returned. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 RunIdPathParam: description: 'The unique ID for the run ' in: path name: runId required: true schema: type: string PrivateEndpointSortByQueryParam: description: 'The field used to sort the results. Multiple fields are not supported. ' in: query name: sortBy required: false schema: type: string enum: - timeCreated default: timeCreated StatementLifecycleStateQueryParam: description: 'The LifecycleState of the statement. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/StatementLifecycleState' schema: type: string enum: - ACCEPTED - CANCELLING - CANCELLED - FAILED - IN_PROGRESS - SUCCEEDED RunLifecycleStateQueryParam: description: 'The LifecycleState of the run. ' in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-top-level-enum: '#/definitions/RunLifecycleState' schema: type: string enum: - ACCEPTED - IN_PROGRESS - CANCELING - CANCELED - FAILED - SUCCEEDED responses: DefaultError: description: 'An error has occurred. ' headers: opc-request-id: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-definitions: applicationClassName: description: 'The class for the application. ' type: string applicationFileUri: description: 'An Oracle Cloud Infrastructure URI of the file containing the application to execute. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri type: string applicationId: description: 'The application ID. ' type: string applicationLanguage: description: 'The Spark language. ' enum: - SCALA - JAVA - PYTHON - SQL type: string x-obmcs-top-level-enum: '#/definitions/ApplicationLanguage' applicationLanguageEnum: - SCALA - JAVA - PYTHON - SQL applicationLifecycleState: description: 'The current state of this application. ' enum: - ACTIVE - DELETING - DELETED - INACTIVE type: string x-obmcs-top-level-enum: '#/definitions/ApplicationLifecycleState' applicationLifecycleStateEnum: - ACTIVE - DELETING - DELETED - INACTIVE applicationType: default: BATCH description: 'The Spark application processing type. ' enum: - BATCH - STREAMING - SESSION type: string x-obmcs-top-level-enum: '#/definitions/ApplicationType' applicationTypeEnum: - BATCH - STREAMING - SESSION archiveUri: description: 'A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, ``oci://path/to/a.zip,oci://path/to/b.zip``. An Oracle Cloud Infrastructure URI of an archive.zip file containing custom dependencies that may be used to support the execution of a Python, Java, or Scala application. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^((?:oci):\/\/([^:\/]+)@([^:\/]+))(,(?:oci):\/\/([^:\/]+)@([^:\/]+))* type: string arguments: description: 'The arguments passed to the running application as command line arguments. An argument is either a plain text or a placeholder. Placeholders are replaced using values from the parameters map. Each placeholder specified must be represented in the parameters map else the request (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as `${name}`, where `name` is the name of the parameter. Example: `[ "--input", "${input_file}", "--name", "John Doe" ]` If "input_file" has a value of "mydata.xml", then the value above will be translated to `--input mydata.xml --name "John Doe"` ' items: type: string type: array compartmentId: description: 'The OCID of a compartment. ' maxLength: 255 minLength: 1 type: string configuration: additionalProperties: type: string description: 'The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned. ' type: object content-disposition: description: 'Specifies whether the the content is expected to be displayed in a web browser or downloaded as a file that is saved locally. ' type: string content-encoding: description: 'Indicates the encoding of the data, as described in RFC 2616, section 14.11. ' type: string content-length: description: 'Indicates the size of the data as described in RFC 2616, section 14.13. ' format: int64 type: integer content-type: description: 'Specifies the media type of the underlying data as described in RFC 2616, section 14.17. ' type: string dataReadInBytes: description: 'The data read by the run in bytes. ' format: int64 type: integer dataWrittenInBytes: description: 'The data written by the run in bytes. ' format: int64 type: integer dayOfWeek: description: 'Day of the week SUN-SAT ' enum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY type: string x-obmcs-top-level-enum: '#/definitions/DayOfWeek' dayOfWeekEnum: - SUNDAY - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: 'A user-friendly description. Avoid entering confidential information. ' maxLength: 400 type: string descriptionReadOnly: description: 'A user-friendly description. ' maxLength: 400 type: string displayName: description: 'A user-friendly name. It does not have to be unique. Avoid entering confidential information. ' maxLength: 255 type: string displayNameReadOnly: description: 'A user-friendly name. This name is not necessarily unique. ' maxLength: 255 type: string dnsZones: description: 'An array of DNS zone names. Example: `[ "app.examplecorp.com", "app.examplecorp2.com" ]` ' items: type: string maxLength: 255 type: array driverShape: description: 'The VM shape for the driver. Sets the driver cores and memory. ' type: string envVariables: additionalProperties: type: string description: 'The environment variables passed to the running process. These variables are set inside driver and executor pods for the user application to consume. Example: { "key1" : "value1", "key2" : "value2" } ' type: object etag: description: 'For optimistic concurrency control. See [ETags for Optimistic Concurrency Control](/iaas/Content/API/Concepts/usingapi.htm#eleven). ' type: string execute: description: 'The input used for spark-submit command. For more details see https://spark.apache.org/docs/latest/submitting-applications.html#launching-applications-with-spark-submit. Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments. Example: ``--jars oci://path/to/a.jar,oci://path/to/b.jar --files oci://path/to/a.json,oci://path/to/b.csv --py-files oci://path/to/a.py,oci://path/to/b.py --conf spark.sql.crossJoin.enabled=true --class org.apache.spark.examples.SparkPi oci://path/to/main.jar 10`` Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit, Data Flow service will use derived information from execute input only. ' maxLength: 4000 minLength: 1 type: string executorShape: description: 'The VM shape for the executors. Sets the executor cores and memory. ' type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object idlePoolTimeoutInMinutes: description: 'Optional timeout value in minutes used to auto stop Pools. A Pool will be auto stopped after inactivity for this amount of time period. If value not set, pool will not be auto stopped auto. ' format: int32 maximum: 59940 minimum: 5 type: integer idleTimeoutInMinutes: default: 2880 description: 'The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period. Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days) ' format: int64 type: integer location: description: 'Provides information about the location of a newly created resource. ' type: string logsBucketUri: description: 'An Oracle Cloud Infrastructure URI of the bucket where the Spark job logs are to be uploaded. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string maxDurationInMinutes: description: 'The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated once it reaches this duration from the time it transitions to `IN_PROGRESS` state. ' format: int64 type: integer maxHostCount: description: 'The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512. ' format: int32 minimum: 1 type: integer metastoreId: description: 'The OCID of OCI Hive Metastore. ' maxLength: 255 minLength: 1 type: string nsgIds: description: 'An array of network security group OCIDs. ' items: type: string maxLength: 255 type: array numExecutors: description: 'The number of executor VMs requested. ' format: int32 minimum: 1 type: integer opcNextPage: description: 'Retrieves the next page of results. When this header appears in the response, additional pages of results remain. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opcPrevPage: description: 'Retrieves the previous page of results. When this header appears in the response, previous pages of results exist. See [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opcRequestId: description: 'Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opcWorkRequestId: description: 'Unique Oracle assigned identifier for a work request. ' type: string ownerPrincipalId: description: 'The OCID of the user who created the resource. ' type: string ownerUserName: description: 'The username of the user who created the resource. If the username of the owner does not exist, `null` will be returned and the caller should refer to the ownerPrincipalId value instead. ' type: string parameters: description: 'An array of name/value pairs used to fill placeholders found in properties like `Application.arguments`. The name must be a string of one or more word characters (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind. Example: [ { name: "iterations", value: "10"}, { name: "input_file", value: "mydata.xml" }, { name: "variable_x", value: "${x}"} ] ' items: $ref: '#/components/schemas/ApplicationParameter' type: array poolConfigs: description: 'List of PoolConfig items. ' items: $ref: '#/components/schemas/PoolConfig' type: array poolId: description: 'The OCID of a pool. Unique Id to indentify a dataflow pool resource. ' maxLength: 255 minLength: 1 type: string poolLifecycleState: description: 'The current state of this pool. ' enum: - ACCEPTED - SCHEDULED - CREATING - ACTIVE - STOPPING - STOPPED - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/PoolLifecycleState' poolLifecycleStateEnum: - ACCEPTED - SCHEDULED - CREATING - ACTIVE - STOPPING - STOPPED - UPDATING - DELETING - DELETED - FAILED privateEndpointId: description: 'The OCID of a private endpoint. ' maxLength: 255 minLength: 1 type: string privateEndpointLifecycleState: description: 'The current state of this private endpoint. ' enum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED type: string x-obmcs-top-level-enum: '#/definitions/PrivateEndpointLifecycleState' privateEndpointLifecycleStateEnum: - CREATING - ACTIVE - INACTIVE - UPDATING - DELETING - DELETED - FAILED runDurationInMilliseconds: description: 'The duration of the run in milliseconds. ' format: int64 type: integer runId: description: 'The ID of a run. ' type: string runLifecycleDetails: description: 'The detailed messages about the lifecycle state. ' type: string runLifecycleState: description: 'The current state of this run. ' enum: - ACCEPTED - IN_PROGRESS - CANCELING - CANCELED - FAILED - SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/RunLifecycleState' runLifecycleStateEnum: - ACCEPTED - IN_PROGRESS - CANCELING - CANCELED - FAILED - SUCCEEDED schedules: description: 'A list of schedules for pool to auto start and stop. ' items: $ref: '#/components/schemas/PoolSchedule' maxItems: 7 type: array sparkVersion: description: 'The Spark version utilized to run the application. ' type: string sqlEndpointBannerMessage: description: The SQL Endpoint message displayed as a banner to provide user with any action items required on the resource. maxLength: 255 minLength: 1 type: string sqlEndpointDescription: description: The description of the SQL Endpoint. maxLength: 400 minLength: 1 type: string sqlEndpointDisplayName: description: The SQL Endpoint name, which can be changed. maxLength: 255 minLength: 1 type: string sqlEndpointDriverShape: description: The shape of the SQL Endpoint driver instance. maxLength: 255 minLength: 1 type: string sqlEndpointExecutorShape: description: The shape of the SQL Endpoint executor instance. maxLength: 255 minLength: 1 type: string sqlEndpointId: description: The provision identifier that is immutable on creation. maxLength: 255 minLength: 1 type: string sqlEndpointJdbcEndpointUrl: description: The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI format: uri pattern: ^(?:jdbc:spark):\/\/([^:\/]+)\/default;SparkServerType=DFI;httpPath=cliservice type: string sqlEndpointLakeId: description: The OCID of OCI Lake. maxLength: 255 minLength: 1 type: string sqlEndpointLastAcceptedRequestToken: description: This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed. minLength: 0 type: string sqlEndpointLifecycleState: description: The current state of the Sql Endpoint. enum: - CREATING - ACTIVE - DELETING - DELETED - FAILED - UPDATING - NEEDS_ATTENTION type: string x-obmcs-top-level-enum: '#/definitions/SqlEndpointLifecycleState' sqlEndpointLifecycleStateEnum: - CREATING - ACTIVE - DELETING - DELETED - FAILED - UPDATING - NEEDS_ATTENTION sqlEndpointMaxExecutorCount: description: The maximum number of executors. type: integer sqlEndpointMinExecutorCount: default: 1 description: The minimum number of executors. minimum: 1 type: integer sqlEndpointStateMessage: description: A message describing the reason why the resource is in it's current state. Helps bubble up errors in state changes. For example, it can be used to provide actionable information for a resource in the Failed state. minLength: 0 type: string sqlEndpointTimeCreated: description: The time the Sql Endpoint was created. An RFC3339 formatted datetime string. format: date-time type: string sqlEndpointTimeUpdated: description: The time the Sql Endpoint was updated. An RFC3339 formatted datetime string. format: date-time type: string sqlEndpointVersion: description: The version of SQL Endpoint. maxLength: 64 minLength: 1 type: string sqlEndpointWarehouseBucketUri: description: The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string statementCode: description: 'The statement code to execute. Example: `println(sc.version)` ' maxLength: 1048576 type: string statementId: description: 'The statement ID. ' format: int64 type: integer statementLifecycleState: description: 'The current state of this statement. ' enum: - ACCEPTED - CANCELLING - CANCELLED - FAILED - IN_PROGRESS - SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/StatementLifecycleState' statementLifecycleStateEnum: - ACCEPTED - CANCELLING - CANCELLED - FAILED - IN_PROGRESS - SUCCEEDED statementOutput: $ref: '#/components/schemas/StatementOutput' statementOutputData: $ref: '#/components/schemas/StatementOutputData' subnetId: description: 'The OCID of a subnet. ' maxLength: 255 type: string systemTags: additionalProperties: additionalProperties: type: object type: object description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` ' type: object timeCompleted: description: 'The date and time a statement execution was completed, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2022-05-31T21:10:29.600Z` ' format: date-time type: string timeCreated: description: 'The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. Example: `2018-04-03T21:10:29.600Z` ' format: date-time type: string totalOCpu: description: 'The total number of oCPU requested by the run. ' format: int32 type: integer warehouseBucketUri: description: 'An Oracle Cloud Infrastructure URI of the bucket to be used as default warehouse directory for BATCH SQL runs. See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat. ' format: uri pattern: ^(?:oci):\/\/([^:\/]+)@([^:\/]+) type: string workRequestId: description: 'The OCID of a work request. ' maxLength: 255 minLength: 1 type: string workRequestOperation: description: 'The operation related to this work request. ' enum: - CREATE_PRIVATE_ENDPOINT - UPDATE_PRIVATE_ENDPOINT - DELETE_PRIVATE_ENDPOINT - MOVE_PRIVATE_ENDPOINT type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestOperation' workRequestPercentComplete: description: 'Percentage of the request completed. ' format: float type: number workRequestResources: description: 'The resources affected by this work request. ' items: $ref: '#/components/schemas/WorkRequestResource' type: array workRequestStatus: description: 'The status of the work request. ' enum: - ACCEPTED - CANCELLED - CANCELLING - FAILED - INPROGRESS - SUCCEEDED type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus' workRequestTimeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string workRequestTimeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string workRequestTimeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string