oci-dataflow 2.76.1 → 2.77.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (69) hide show
  1. package/lib/client.d.ts +49 -43
  2. package/lib/client.js +51 -42
  3. package/lib/client.js.map +1 -1
  4. package/lib/model/application-summary.d.ts +5 -5
  5. package/lib/model/application.d.ts +14 -14
  6. package/lib/model/create-application-details.d.ts +11 -11
  7. package/lib/model/create-pool-details.d.ts +2 -2
  8. package/lib/model/create-private-endpoint-details.d.ts +3 -3
  9. package/lib/model/create-run-details.d.ts +11 -11
  10. package/lib/model/create-sql-endpoint-details.d.ts +2 -2
  11. package/lib/model/create-statement-details.d.ts +1 -1
  12. package/lib/model/pool-summary.d.ts +5 -5
  13. package/lib/model/pool.d.ts +5 -5
  14. package/lib/model/private-endpoint-summary.d.ts +6 -6
  15. package/lib/model/private-endpoint.d.ts +6 -6
  16. package/lib/model/run-summary.d.ts +5 -5
  17. package/lib/model/run.d.ts +15 -15
  18. package/lib/model/sql-endpoint-summary.d.ts +3 -3
  19. package/lib/model/sql-endpoint.d.ts +3 -3
  20. package/lib/model/statement-summary.d.ts +2 -2
  21. package/lib/model/statement.d.ts +3 -3
  22. package/lib/model/update-application-details.d.ts +11 -11
  23. package/lib/model/update-pool-details.d.ts +3 -3
  24. package/lib/model/update-private-endpoint-details.d.ts +3 -3
  25. package/lib/model/update-run-details.d.ts +4 -4
  26. package/lib/model/update-sql-endpoint-details.d.ts +2 -2
  27. package/lib/request/change-application-compartment-request.d.ts +2 -2
  28. package/lib/request/change-pool-compartment-request.d.ts +2 -2
  29. package/lib/request/change-private-endpoint-compartment-request.d.ts +2 -2
  30. package/lib/request/change-run-compartment-request.d.ts +2 -2
  31. package/lib/request/change-sql-endpoint-compartment-request.d.ts +2 -2
  32. package/lib/request/create-application-request.d.ts +1 -1
  33. package/lib/request/create-pool-request.d.ts +1 -1
  34. package/lib/request/create-private-endpoint-request.d.ts +1 -1
  35. package/lib/request/create-run-request.d.ts +1 -1
  36. package/lib/request/create-sql-endpoint-request.d.ts +1 -1
  37. package/lib/request/create-statement-request.d.ts +1 -1
  38. package/lib/request/delete-application-request.d.ts +2 -2
  39. package/lib/request/delete-pool-request.d.ts +2 -2
  40. package/lib/request/delete-private-endpoint-request.d.ts +2 -2
  41. package/lib/request/delete-run-request.d.ts +2 -2
  42. package/lib/request/delete-sql-endpoint-request.d.ts +2 -2
  43. package/lib/request/delete-statement-request.d.ts +2 -2
  44. package/lib/request/get-application-request.d.ts +1 -1
  45. package/lib/request/get-pool-request.d.ts +1 -1
  46. package/lib/request/get-private-endpoint-request.d.ts +1 -1
  47. package/lib/request/get-run-log-request.d.ts +1 -1
  48. package/lib/request/get-run-request.d.ts +1 -1
  49. package/lib/request/get-sql-endpoint-request.d.ts +1 -1
  50. package/lib/request/get-statement-request.d.ts +1 -1
  51. package/lib/request/get-work-request-request.d.ts +1 -1
  52. package/lib/request/list-applications-request.d.ts +3 -3
  53. package/lib/request/list-pools-request.d.ts +3 -3
  54. package/lib/request/list-private-endpoints-request.d.ts +3 -3
  55. package/lib/request/list-run-logs-request.d.ts +2 -2
  56. package/lib/request/list-runs-request.d.ts +3 -3
  57. package/lib/request/list-sql-endpoints-request.d.ts +1 -1
  58. package/lib/request/list-statements-request.d.ts +3 -3
  59. package/lib/request/list-work-request-errors-request.d.ts +3 -3
  60. package/lib/request/list-work-request-logs-request.d.ts +3 -3
  61. package/lib/request/list-work-requests-request.d.ts +3 -3
  62. package/lib/request/start-pool-request.d.ts +2 -2
  63. package/lib/request/stop-pool-request.d.ts +2 -2
  64. package/lib/request/update-application-request.d.ts +2 -2
  65. package/lib/request/update-pool-request.d.ts +2 -2
  66. package/lib/request/update-private-endpoint-request.d.ts +2 -2
  67. package/lib/request/update-run-request.d.ts +2 -2
  68. package/lib/request/update-sql-endpoint-request.d.ts +2 -2
  69. package/package.json +3 -3
@@ -24,7 +24,7 @@ export interface CreatePrivateEndpointDetails {
24
24
  "compartmentId": string;
25
25
  /**
26
26
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
27
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
27
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
28
28
  *
29
29
  */
30
30
  "definedTags"?: {
@@ -44,14 +44,14 @@ export interface CreatePrivateEndpointDetails {
44
44
  "displayName"?: string;
45
45
  /**
46
46
  * An array of DNS zone names.
47
- * Example: `[ \"app.examplecorp.com\", \"app.examplecorp2.com\" ]`
47
+ * Example: {@code [ \"app.examplecorp.com\", \"app.examplecorp2.com\" ]}
48
48
  *
49
49
  */
50
50
  "dnsZones": Array<string>;
51
51
  /**
52
52
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
53
53
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
54
- * Example: `{\"Department\": \"Finance\"}`
54
+ * Example: {@code {\"Department\": \"Finance\"}}
55
55
  *
56
56
  */
57
57
  "freeformTags"?: {
@@ -57,7 +57,7 @@ export interface CreateRunDetails {
57
57
  */
58
58
  "applicationId"?: string;
59
59
  /**
60
- * 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.
60
+ * A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, {@code 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.
61
61
  * See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
62
62
  *
63
63
  */
@@ -67,10 +67,10 @@ export interface CreateRunDetails {
67
67
  * either a plain text or a placeholder. Placeholders are replaced using values from the parameters
68
68
  * map. Each placeholder specified must be represented in the parameters map else the request
69
69
  * (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as
70
- * `Service Api Spec`, where `name` is the name of the parameter.
71
- * Example: `[ \"--input\", \"${input_file}\", \"--name\", \"John Doe\" ]`
70
+ * {@code Service Api Spec}, where {@code name} is the name of the parameter.
71
+ * Example: {@code [ \"--input\", \"${input_file}\", \"--name\", \"John Doe\" ]}
72
72
  * If \"input_file\" has a value of \"mydata.xml\", then the value above will be translated to
73
- * `--input mydata.xml --name \"John Doe\"`
73
+ * {@code --input mydata.xml --name \"John Doe\"}
74
74
  *
75
75
  */
76
76
  "arguments"?: Array<string>;
@@ -92,7 +92,7 @@ export interface CreateRunDetails {
92
92
  };
93
93
  /**
94
94
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
95
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
95
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
96
96
  *
97
97
  */
98
98
  "definedTags"?: {
@@ -113,8 +113,8 @@ export interface CreateRunDetails {
113
113
  "driverShapeConfig"?: model.ShapeConfig;
114
114
  /**
115
115
  * 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.
116
- * Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments.
117
- * 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``
116
+ * Supported options include {@code --class}{@code , }{@code --file}{@code , }{@code --jars}{@code , }{@code --conf}{@code , }{@code --py-files}{@code , and main application file with arguments.
117
+ * Example: }{@code --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}
118
118
  * Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit,
119
119
  * Data Flow service will use derived information from execute input only.
120
120
  *
@@ -129,7 +129,7 @@ export interface CreateRunDetails {
129
129
  /**
130
130
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
131
131
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
132
- * Example: `{\"Department\": \"Finance\"}`
132
+ * Example: {@code {\"Department\": \"Finance\"}}
133
133
  *
134
134
  */
135
135
  "freeformTags"?: {
@@ -153,7 +153,7 @@ export interface CreateRunDetails {
153
153
  "numExecutors"?: number;
154
154
  /**
155
155
  * An array of name/value pairs used to fill placeholders found in properties like
156
- * `Application.arguments`. The name must be a string of one or more word characters
156
+ * {@code Application.arguments}. The name must be a string of one or more word characters
157
157
  * (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind.
158
158
  * Example: [ { name: \"iterations\", value: \"10\"}, { name: \"input_file\", value: \"mydata.xml\" }, { name: \"variable_x\", value: \"${x}\"} ]
159
159
  *
@@ -183,13 +183,13 @@ export interface CreateRunDetails {
183
183
  "warehouseBucketUri"?: string;
184
184
  /**
185
185
  * The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated
186
- * once it reaches this duration from the time it transitions to `IN_PROGRESS` state.
186
+ * once it reaches this duration from the time it transitions to {@code IN_PROGRESS} state.
187
187
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
188
188
  */
189
189
  "maxDurationInMinutes"?: number;
190
190
  /**
191
191
  * The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period.
192
- * Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days)
192
+ * Note: This parameter is currently only applicable for Runs of type {@code SESSION}. Default value is 2880 minutes (2 days)
193
193
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
194
194
  */
195
195
  "idleTimeoutInMinutes"?: number;
@@ -65,7 +65,7 @@ export interface CreateSqlEndpointDetails {
65
65
  /**
66
66
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
67
67
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
68
- * Example: `{\"Department\": \"Finance\"}`
68
+ * Example: {@code {\"Department\": \"Finance\"}}
69
69
  *
70
70
  */
71
71
  "freeformTags"?: {
@@ -73,7 +73,7 @@ export interface CreateSqlEndpointDetails {
73
73
  };
74
74
  /**
75
75
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
76
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
76
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
77
77
  *
78
78
  */
79
79
  "definedTags"?: {
@@ -18,7 +18,7 @@
18
18
  export interface CreateStatementDetails {
19
19
  /**
20
20
  * The statement code to execute.
21
- * Example: `println(sc.version)`
21
+ * Example: {@code println(sc.version)}
22
22
  *
23
23
  */
24
24
  "code": string;
@@ -24,7 +24,7 @@ export interface PoolSummary {
24
24
  "compartmentId": string;
25
25
  /**
26
26
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
27
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
27
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
28
28
  *
29
29
  */
30
30
  "definedTags": {
@@ -40,7 +40,7 @@ export interface PoolSummary {
40
40
  /**
41
41
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
42
42
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
43
- * Example: `{\"Department\": \"Finance\"}`
43
+ * Example: {@code {\"Department\": \"Finance\"}}
44
44
  *
45
45
  */
46
46
  "freeformTags": {
@@ -63,19 +63,19 @@ export interface PoolSummary {
63
63
  "ownerPrincipalId": string;
64
64
  /**
65
65
  * The username of the user who created the resource. If the username of the owner does not exist,
66
- * `null` will be returned and the caller should refer to the ownerPrincipalId value instead.
66
+ * {@code null} will be returned and the caller should refer to the ownerPrincipalId value instead.
67
67
  *
68
68
  */
69
69
  "ownerUserName": string;
70
70
  /**
71
71
  * The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
72
- * Example: `2018-04-03T21:10:29.600Z`
72
+ * Example: {@code 2018-04-03T21:10:29.600Z}
73
73
  *
74
74
  */
75
75
  "timeCreated": Date;
76
76
  /**
77
77
  * The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
78
- * Example: `2018-04-03T21:10:29.600Z`
78
+ * Example: {@code 2018-04-03T21:10:29.600Z}
79
79
  *
80
80
  */
81
81
  "timeUpdated": Date;
@@ -24,7 +24,7 @@ export interface Pool {
24
24
  "compartmentId": string;
25
25
  /**
26
26
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
27
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
27
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
28
28
  *
29
29
  */
30
30
  "definedTags": {
@@ -45,7 +45,7 @@ export interface Pool {
45
45
  /**
46
46
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
47
47
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
48
- * Example: `{\"Department\": \"Finance\"}`
48
+ * Example: {@code {\"Department\": \"Finance\"}}
49
49
  *
50
50
  */
51
51
  "freeformTags": {
@@ -73,7 +73,7 @@ export interface Pool {
73
73
  "ownerPrincipalId": string;
74
74
  /**
75
75
  * The username of the user who created the resource. If the username of the owner does not exist,
76
- * `null` will be returned and the caller should refer to the ownerPrincipalId value instead.
76
+ * {@code null} will be returned and the caller should refer to the ownerPrincipalId value instead.
77
77
  *
78
78
  */
79
79
  "ownerUserName"?: string;
@@ -96,13 +96,13 @@ export interface Pool {
96
96
  "idleTimeoutInMinutes"?: number;
97
97
  /**
98
98
  * The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
99
- * Example: `2018-04-03T21:10:29.600Z`
99
+ * Example: {@code 2018-04-03T21:10:29.600Z}
100
100
  *
101
101
  */
102
102
  "timeCreated": Date;
103
103
  /**
104
104
  * The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
105
- * Example: `2018-04-03T21:10:29.600Z`
105
+ * Example: {@code 2018-04-03T21:10:29.600Z}
106
106
  *
107
107
  */
108
108
  "timeUpdated": Date;
@@ -24,7 +24,7 @@ export interface PrivateEndpointSummary {
24
24
  "compartmentId": string;
25
25
  /**
26
26
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
27
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
27
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
28
28
  *
29
29
  */
30
30
  "definedTags": {
@@ -39,14 +39,14 @@ export interface PrivateEndpointSummary {
39
39
  "displayName": string;
40
40
  /**
41
41
  * An array of DNS zone names.
42
- * Example: `[ \"app.examplecorp.com\", \"app.examplecorp2.com\" ]`
42
+ * Example: {@code [ \"app.examplecorp.com\", \"app.examplecorp2.com\" ]}
43
43
  *
44
44
  */
45
45
  "dnsZones": Array<string>;
46
46
  /**
47
47
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
48
48
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
49
- * Example: `{\"Department\": \"Finance\"}`
49
+ * Example: {@code {\"Department\": \"Finance\"}}
50
50
  *
51
51
  */
52
52
  "freeformTags": {
@@ -82,7 +82,7 @@ export interface PrivateEndpointSummary {
82
82
  "ownerPrincipalId": string;
83
83
  /**
84
84
  * The username of the user who created the resource. If the username of the owner does not exist,
85
- * `null` will be returned and the caller should refer to the ownerPrincipalId value instead.
85
+ * {@code null} will be returned and the caller should refer to the ownerPrincipalId value instead.
86
86
  *
87
87
  */
88
88
  "ownerUserName"?: string;
@@ -99,13 +99,13 @@ export interface PrivateEndpointSummary {
99
99
  "subnetId": string;
100
100
  /**
101
101
  * The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
102
- * Example: `2018-04-03T21:10:29.600Z`
102
+ * Example: {@code 2018-04-03T21:10:29.600Z}
103
103
  *
104
104
  */
105
105
  "timeCreated": Date;
106
106
  /**
107
107
  * The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
108
- * Example: `2018-04-03T21:10:29.600Z`
108
+ * Example: {@code 2018-04-03T21:10:29.600Z}
109
109
  *
110
110
  */
111
111
  "timeUpdated": Date;
@@ -24,7 +24,7 @@ export interface PrivateEndpoint {
24
24
  "compartmentId": string;
25
25
  /**
26
26
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
27
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
27
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
28
28
  *
29
29
  */
30
30
  "definedTags": {
@@ -44,14 +44,14 @@ export interface PrivateEndpoint {
44
44
  "displayName": string;
45
45
  /**
46
46
  * An array of DNS zone names.
47
- * Example: `[ \"app.examplecorp.com\", \"app.examplecorp2.com\" ]`
47
+ * Example: {@code [ \"app.examplecorp.com\", \"app.examplecorp2.com\" ]}
48
48
  *
49
49
  */
50
50
  "dnsZones": Array<string>;
51
51
  /**
52
52
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
53
53
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
54
- * Example: `{\"Department\": \"Finance\"}`
54
+ * Example: {@code {\"Department\": \"Finance\"}}
55
55
  *
56
56
  */
57
57
  "freeformTags": {
@@ -92,7 +92,7 @@ export interface PrivateEndpoint {
92
92
  "ownerPrincipalId": string;
93
93
  /**
94
94
  * The username of the user who created the resource. If the username of the owner does not exist,
95
- * `null` will be returned and the caller should refer to the ownerPrincipalId value instead.
95
+ * {@code null} will be returned and the caller should refer to the ownerPrincipalId value instead.
96
96
  *
97
97
  */
98
98
  "ownerUserName"?: string;
@@ -109,13 +109,13 @@ export interface PrivateEndpoint {
109
109
  "subnetId": string;
110
110
  /**
111
111
  * The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
112
- * Example: `2018-04-03T21:10:29.600Z`
112
+ * Example: {@code 2018-04-03T21:10:29.600Z}
113
113
  *
114
114
  */
115
115
  "timeCreated": Date;
116
116
  /**
117
117
  * The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
118
- * Example: `2018-04-03T21:10:29.600Z`
118
+ * Example: {@code 2018-04-03T21:10:29.600Z}
119
119
  *
120
120
  */
121
121
  "timeUpdated": Date;
@@ -39,7 +39,7 @@ export interface RunSummary {
39
39
  "dataWrittenInBytes"?: number;
40
40
  /**
41
41
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
42
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
42
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
43
43
  *
44
44
  */
45
45
  "definedTags": {
@@ -55,7 +55,7 @@ export interface RunSummary {
55
55
  /**
56
56
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
57
57
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
58
- * Example: `{\"Department\": \"Finance\"}`
58
+ * Example: {@code {\"Department\": \"Finance\"}}
59
59
  *
60
60
  */
61
61
  "freeformTags": {
@@ -94,7 +94,7 @@ export interface RunSummary {
94
94
  "ownerPrincipalId"?: string;
95
95
  /**
96
96
  * The username of the user who created the resource. If the username of the owner does not exist,
97
- * `null` will be returned and the caller should refer to the ownerPrincipalId value instead.
97
+ * {@code null} will be returned and the caller should refer to the ownerPrincipalId value instead.
98
98
  *
99
99
  */
100
100
  "ownerUserName"?: string;
@@ -115,13 +115,13 @@ export interface RunSummary {
115
115
  "totalOCpu"?: number;
116
116
  /**
117
117
  * The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
118
- * Example: `2018-04-03T21:10:29.600Z`
118
+ * Example: {@code 2018-04-03T21:10:29.600Z}
119
119
  *
120
120
  */
121
121
  "timeCreated": Date;
122
122
  /**
123
123
  * The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
124
- * Example: `2018-04-03T21:10:29.600Z`
124
+ * Example: {@code 2018-04-03T21:10:29.600Z}
125
125
  *
126
126
  */
127
127
  "timeUpdated": Date;
@@ -18,7 +18,7 @@ import * as model from "../model";
18
18
  */
19
19
  export interface Run {
20
20
  /**
21
- * 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.
21
+ * A comma separated list of one or more archive files as Oracle Cloud Infrastructure URIs. For example, {@code 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.
22
22
  * See https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/hdfsconnector.htm#uriformat.
23
23
  *
24
24
  */
@@ -28,10 +28,10 @@ export interface Run {
28
28
  * either a plain text or a placeholder. Placeholders are replaced using values from the parameters
29
29
  * map. Each placeholder specified must be represented in the parameters map else the request
30
30
  * (POST or PUT) will fail with a HTTP 400 status code. Placeholders are specified as
31
- * `Service Api Spec`, where `name` is the name of the parameter.
32
- * Example: `[ \"--input\", \"${input_file}\", \"--name\", \"John Doe\" ]`
31
+ * {@code Service Api Spec}, where {@code name} is the name of the parameter.
32
+ * Example: {@code [ \"--input\", \"${input_file}\", \"--name\", \"John Doe\" ]}
33
33
  * If \"input_file\" has a value of \"mydata.xml\", then the value above will be translated to
34
- * `--input mydata.xml --name \"John Doe\"`
34
+ * {@code --input mydata.xml --name \"John Doe\"}
35
35
  *
36
36
  */
37
37
  "arguments"?: Array<string>;
@@ -74,7 +74,7 @@ export interface Run {
74
74
  "dataWrittenInBytes"?: number;
75
75
  /**
76
76
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
77
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
77
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
78
78
  *
79
79
  */
80
80
  "definedTags"?: {
@@ -95,8 +95,8 @@ export interface Run {
95
95
  "driverShapeConfig"?: model.ShapeConfig;
96
96
  /**
97
97
  * 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.
98
- * Supported options include ``--class``, ``--file``, ``--jars``, ``--conf``, ``--py-files``, and main application file with arguments.
99
- * 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``
98
+ * Supported options include {@code --class}{@code , }{@code --file}{@code , }{@code --jars}{@code , }{@code --conf}{@code , }{@code --py-files}{@code , and main application file with arguments.
99
+ * Example: }{@code --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}
100
100
  * Note: If execute is specified together with applicationId, className, configuration, fileUri, language, arguments, parameters during application create/update, or run create/submit,
101
101
  * Data Flow service will use derived information from execute input only.
102
102
  *
@@ -117,7 +117,7 @@ export interface Run {
117
117
  /**
118
118
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
119
119
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
120
- * Example: `{\"Department\": \"Finance\"}`
120
+ * Example: {@code {\"Department\": \"Finance\"}}
121
121
  *
122
122
  */
123
123
  "freeformTags"?: {
@@ -172,13 +172,13 @@ export interface Run {
172
172
  "ownerPrincipalId"?: string;
173
173
  /**
174
174
  * The username of the user who created the resource. If the username of the owner does not exist,
175
- * `null` will be returned and the caller should refer to the ownerPrincipalId value instead.
175
+ * {@code null} will be returned and the caller should refer to the ownerPrincipalId value instead.
176
176
  *
177
177
  */
178
178
  "ownerUserName"?: string;
179
179
  /**
180
180
  * An array of name/value pairs used to fill placeholders found in properties like
181
- * `Application.arguments`. The name must be a string of one or more word characters
181
+ * {@code Application.arguments}. The name must be a string of one or more word characters
182
182
  * (a-z, A-Z, 0-9, _). The value can be a string of 0 or more characters of any kind.
183
183
  * Example: [ { name: \"iterations\", value: \"10\"}, { name: \"input_file\", value: \"mydata.xml\" }, { name: \"variable_x\", value: \"${x}\"} ]
184
184
  *
@@ -191,7 +191,7 @@ export interface Run {
191
191
  "poolId"?: string;
192
192
  /**
193
193
  * An array of DNS zone names.
194
- * Example: `[ \"app.examplecorp.com\", \"app.examplecorp2.com\" ]`
194
+ * Example: {@code [ \"app.examplecorp.com\", \"app.examplecorp2.com\" ]}
195
195
  *
196
196
  */
197
197
  "privateEndpointDnsZones"?: Array<string>;
@@ -230,13 +230,13 @@ export interface Run {
230
230
  "sparkVersion": string;
231
231
  /**
232
232
  * The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
233
- * Example: `2018-04-03T21:10:29.600Z`
233
+ * Example: {@code 2018-04-03T21:10:29.600Z}
234
234
  *
235
235
  */
236
236
  "timeCreated": Date;
237
237
  /**
238
238
  * The date and time the resource was updated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
239
- * Example: `2018-04-03T21:10:29.600Z`
239
+ * Example: {@code 2018-04-03T21:10:29.600Z}
240
240
  *
241
241
  */
242
242
  "timeUpdated": Date;
@@ -259,13 +259,13 @@ export interface Run {
259
259
  "warehouseBucketUri"?: string;
260
260
  /**
261
261
  * The maximum duration in minutes for which an Application should run. Data Flow Run would be terminated
262
- * once it reaches this duration from the time it transitions to `IN_PROGRESS` state.
262
+ * once it reaches this duration from the time it transitions to {@code IN_PROGRESS} state.
263
263
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
264
264
  */
265
265
  "maxDurationInMinutes"?: number;
266
266
  /**
267
267
  * The timeout value in minutes used to manage Runs. A Run would be stopped after inactivity for this amount of time period.
268
- * Note: This parameter is currently only applicable for Runs of type `SESSION`. Default value is 2880 minutes (2 days)
268
+ * Note: This parameter is currently only applicable for Runs of type {@code SESSION}. Default value is 2880 minutes (2 days)
269
269
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
270
270
  */
271
271
  "idleTimeoutInMinutes"?: number;
@@ -100,7 +100,7 @@ export interface SqlEndpointSummary {
100
100
  /**
101
101
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
102
102
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
103
- * Example: `{\"Department\": \"Finance\"}`
103
+ * Example: {@code {\"Department\": \"Finance\"}}
104
104
  *
105
105
  */
106
106
  "freeformTags"?: {
@@ -108,7 +108,7 @@ export interface SqlEndpointSummary {
108
108
  };
109
109
  /**
110
110
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
111
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
111
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
112
112
  *
113
113
  */
114
114
  "definedTags"?: {
@@ -119,7 +119,7 @@ export interface SqlEndpointSummary {
119
119
  /**
120
120
  * 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.
121
121
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
122
- * Example: `{orcl-cloud: {free-tier-retain: true}}`
122
+ * Example: {@code {orcl-cloud: {free-tier-retain: true}}}
123
123
  *
124
124
  */
125
125
  "systemTags"?: {
@@ -95,7 +95,7 @@ export interface SqlEndpoint {
95
95
  /**
96
96
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.
97
97
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
98
- * Example: `{\"Department\": \"Finance\"}`
98
+ * Example: {@code {\"Department\": \"Finance\"}}
99
99
  *
100
100
  */
101
101
  "freeformTags"?: {
@@ -103,7 +103,7 @@ export interface SqlEndpoint {
103
103
  };
104
104
  /**
105
105
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
106
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
106
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
107
107
  *
108
108
  */
109
109
  "definedTags"?: {
@@ -114,7 +114,7 @@ export interface SqlEndpoint {
114
114
  /**
115
115
  * 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.
116
116
  * For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
117
- * Example: `{orcl-cloud: {free-tier-retain: true}}`
117
+ * Example: {@code {orcl-cloud: {free-tier-retain: true}}}
118
118
  *
119
119
  */
120
120
  "systemTags"?: {
@@ -34,13 +34,13 @@ export interface StatementSummary {
34
34
  "runId"?: string;
35
35
  /**
36
36
  * The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
37
- * Example: `2018-04-03T21:10:29.600Z`
37
+ * Example: {@code 2018-04-03T21:10:29.600Z}
38
38
  *
39
39
  */
40
40
  "timeCreated": Date;
41
41
  /**
42
42
  * The date and time a statement execution was completed, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
43
- * Example: `2022-05-31T21:10:29.600Z`
43
+ * Example: {@code 2022-05-31T21:10:29.600Z}
44
44
  *
45
45
  */
46
46
  "timeCompleted"?: Date;
@@ -24,7 +24,7 @@ export interface Statement {
24
24
  "id": number;
25
25
  /**
26
26
  * The statement code to execute.
27
- * Example: `println(sc.version)`
27
+ * Example: {@code println(sc.version)}
28
28
  *
29
29
  */
30
30
  "code": string;
@@ -46,13 +46,13 @@ export interface Statement {
46
46
  "runId"?: string;
47
47
  /**
48
48
  * The date and time the resource was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
49
- * Example: `2018-04-03T21:10:29.600Z`
49
+ * Example: {@code 2018-04-03T21:10:29.600Z}
50
50
  *
51
51
  */
52
52
  "timeCreated": Date;
53
53
  /**
54
54
  * The date and time a statement execution was completed, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.
55
- * Example: `2022-05-31T21:10:29.600Z`
55
+ * Example: {@code 2022-05-31T21:10:29.600Z}
56
56
  *
57
57
  */
58
58
  "timeCompleted"?: Date;