oci-datascience 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 (147) hide show
  1. package/lib/client.d.ts +98 -92
  2. package/lib/client.js +100 -91
  3. package/lib/client.js.map +1 -1
  4. package/lib/model/create-data-science-private-endpoint-details.d.ts +2 -2
  5. package/lib/model/create-job-details.d.ts +2 -2
  6. package/lib/model/create-job-run-details.d.ts +2 -2
  7. package/lib/model/create-model-deployment-details.d.ts +3 -3
  8. package/lib/model/create-model-details.d.ts +3 -3
  9. package/lib/model/create-model-version-set-details.d.ts +3 -3
  10. package/lib/model/create-notebook-session-details.d.ts +3 -3
  11. package/lib/model/create-pipeline-details.d.ts +2 -2
  12. package/lib/model/create-pipeline-run-details.d.ts +3 -3
  13. package/lib/model/create-project-details.d.ts +2 -2
  14. package/lib/model/data-science-private-endpoint-summary.d.ts +4 -4
  15. package/lib/model/data-science-private-endpoint.d.ts +4 -4
  16. package/lib/model/default-model-deployment-environment-configuration-details.d.ts +1 -1
  17. package/lib/model/job-run-summary.d.ts +2 -2
  18. package/lib/model/job-run.d.ts +2 -2
  19. package/lib/model/job-summary.d.ts +2 -2
  20. package/lib/model/job.d.ts +2 -2
  21. package/lib/model/model-deployment-summary.d.ts +3 -3
  22. package/lib/model/model-deployment.d.ts +3 -3
  23. package/lib/model/model-summary.d.ts +2 -2
  24. package/lib/model/model-version-set-summary.d.ts +2 -2
  25. package/lib/model/model-version-set.d.ts +2 -2
  26. package/lib/model/model.d.ts +2 -2
  27. package/lib/model/notebook-session-config-details.d.ts +1 -1
  28. package/lib/model/notebook-session-configuration-details.d.ts +1 -1
  29. package/lib/model/notebook-session-summary.d.ts +3 -3
  30. package/lib/model/notebook-session.d.ts +3 -3
  31. package/lib/model/ocir-model-deployment-environment-configuration-details.d.ts +11 -11
  32. package/lib/model/pipeline-run-summary.d.ts +3 -3
  33. package/lib/model/pipeline-run.d.ts +3 -3
  34. package/lib/model/pipeline-summary.d.ts +3 -3
  35. package/lib/model/pipeline.d.ts +3 -3
  36. package/lib/model/project-summary.d.ts +2 -2
  37. package/lib/model/project.d.ts +2 -2
  38. package/lib/model/update-data-science-private-endpoint-details.d.ts +2 -2
  39. package/lib/model/update-default-model-deployment-environment-configuration-details.d.ts +1 -1
  40. package/lib/model/update-job-details.d.ts +2 -2
  41. package/lib/model/update-job-run-details.d.ts +2 -2
  42. package/lib/model/update-model-deployment-details.d.ts +6 -6
  43. package/lib/model/update-model-details.d.ts +3 -3
  44. package/lib/model/update-model-version-set-details.d.ts +2 -2
  45. package/lib/model/update-notebook-session-details.d.ts +5 -5
  46. package/lib/model/update-ocir-model-deployment-environment-configuration-details.d.ts +11 -11
  47. package/lib/model/update-pipeline-details.d.ts +2 -2
  48. package/lib/model/update-pipeline-run-details.d.ts +2 -2
  49. package/lib/model/update-project-details.d.ts +2 -2
  50. package/lib/request/activate-model-deployment-request.d.ts +4 -4
  51. package/lib/request/activate-model-request.d.ts +4 -4
  52. package/lib/request/activate-notebook-session-request.d.ts +4 -4
  53. package/lib/request/cancel-job-run-request.d.ts +4 -4
  54. package/lib/request/cancel-pipeline-run-request.d.ts +4 -4
  55. package/lib/request/cancel-work-request-request.d.ts +4 -4
  56. package/lib/request/change-data-science-private-endpoint-compartment-request.d.ts +4 -4
  57. package/lib/request/change-job-compartment-request.d.ts +4 -4
  58. package/lib/request/change-job-run-compartment-request.d.ts +4 -4
  59. package/lib/request/change-model-compartment-request.d.ts +4 -4
  60. package/lib/request/change-model-deployment-compartment-request.d.ts +4 -4
  61. package/lib/request/change-model-version-set-compartment-request.d.ts +4 -4
  62. package/lib/request/change-notebook-session-compartment-request.d.ts +4 -4
  63. package/lib/request/change-pipeline-compartment-request.d.ts +4 -4
  64. package/lib/request/change-pipeline-run-compartment-request.d.ts +4 -4
  65. package/lib/request/change-project-compartment-request.d.ts +4 -4
  66. package/lib/request/create-data-science-private-endpoint-request.d.ts +1 -1
  67. package/lib/request/create-job-artifact-request.d.ts +2 -2
  68. package/lib/request/create-job-request.d.ts +1 -1
  69. package/lib/request/create-job-run-request.d.ts +1 -1
  70. package/lib/request/create-model-artifact-request.d.ts +6 -6
  71. package/lib/request/create-model-deployment-request.d.ts +1 -1
  72. package/lib/request/create-model-provenance-request.d.ts +1 -1
  73. package/lib/request/create-model-request.d.ts +1 -1
  74. package/lib/request/create-model-version-set-request.d.ts +1 -1
  75. package/lib/request/create-notebook-session-request.d.ts +1 -1
  76. package/lib/request/create-pipeline-request.d.ts +1 -1
  77. package/lib/request/create-pipeline-run-request.d.ts +1 -1
  78. package/lib/request/create-project-request.d.ts +1 -1
  79. package/lib/request/create-step-artifact-request.d.ts +3 -3
  80. package/lib/request/deactivate-model-deployment-request.d.ts +4 -4
  81. package/lib/request/deactivate-model-request.d.ts +4 -4
  82. package/lib/request/deactivate-notebook-session-request.d.ts +4 -4
  83. package/lib/request/delete-data-science-private-endpoint-request.d.ts +4 -4
  84. package/lib/request/delete-job-request.d.ts +4 -4
  85. package/lib/request/delete-job-run-request.d.ts +4 -4
  86. package/lib/request/delete-model-deployment-request.d.ts +4 -4
  87. package/lib/request/delete-model-request.d.ts +4 -4
  88. package/lib/request/delete-model-version-set-request.d.ts +4 -4
  89. package/lib/request/delete-notebook-session-request.d.ts +4 -4
  90. package/lib/request/delete-pipeline-request.d.ts +4 -4
  91. package/lib/request/delete-pipeline-run-request.d.ts +4 -4
  92. package/lib/request/delete-project-request.d.ts +4 -4
  93. package/lib/request/export-model-artifact-request.d.ts +4 -4
  94. package/lib/request/get-data-science-private-endpoint-request.d.ts +1 -1
  95. package/lib/request/get-job-artifact-content-request.d.ts +1 -1
  96. package/lib/request/get-job-request.d.ts +1 -1
  97. package/lib/request/get-job-run-request.d.ts +1 -1
  98. package/lib/request/get-model-artifact-content-request.d.ts +1 -1
  99. package/lib/request/get-model-deployment-request.d.ts +1 -1
  100. package/lib/request/get-model-provenance-request.d.ts +1 -1
  101. package/lib/request/get-model-request.d.ts +1 -1
  102. package/lib/request/get-model-version-set-request.d.ts +1 -1
  103. package/lib/request/get-notebook-session-request.d.ts +1 -1
  104. package/lib/request/get-pipeline-request.d.ts +1 -1
  105. package/lib/request/get-pipeline-run-request.d.ts +1 -1
  106. package/lib/request/get-project-request.d.ts +1 -1
  107. package/lib/request/get-step-artifact-content-request.d.ts +1 -1
  108. package/lib/request/get-work-request-request.d.ts +1 -1
  109. package/lib/request/head-job-artifact-request.d.ts +1 -1
  110. package/lib/request/head-model-artifact-request.d.ts +1 -1
  111. package/lib/request/head-step-artifact-request.d.ts +1 -1
  112. package/lib/request/import-model-artifact-request.d.ts +4 -4
  113. package/lib/request/list-data-science-private-endpoints-request.d.ts +4 -4
  114. package/lib/request/list-fast-launch-job-configs-request.d.ts +3 -3
  115. package/lib/request/list-job-runs-request.d.ts +7 -7
  116. package/lib/request/list-job-shapes-request.d.ts +3 -3
  117. package/lib/request/list-jobs-request.d.ts +7 -7
  118. package/lib/request/list-model-deployment-shapes-request.d.ts +3 -3
  119. package/lib/request/list-model-deployments-request.d.ts +7 -7
  120. package/lib/request/list-model-version-sets-request.d.ts +5 -5
  121. package/lib/request/list-models-request.d.ts +6 -6
  122. package/lib/request/list-notebook-session-shapes-request.d.ts +3 -3
  123. package/lib/request/list-notebook-sessions-request.d.ts +7 -7
  124. package/lib/request/list-pipeline-runs-request.d.ts +7 -7
  125. package/lib/request/list-pipelines-request.d.ts +7 -7
  126. package/lib/request/list-projects-request.d.ts +7 -7
  127. package/lib/request/list-work-request-errors-request.d.ts +3 -3
  128. package/lib/request/list-work-request-logs-request.d.ts +3 -3
  129. package/lib/request/list-work-requests-request.d.ts +4 -4
  130. package/lib/request/update-data-science-private-endpoint-request.d.ts +4 -4
  131. package/lib/request/update-job-request.d.ts +4 -4
  132. package/lib/request/update-job-run-request.d.ts +4 -4
  133. package/lib/request/update-model-deployment-request.d.ts +7 -7
  134. package/lib/request/update-model-provenance-request.d.ts +4 -4
  135. package/lib/request/update-model-request.d.ts +5 -5
  136. package/lib/request/update-model-version-set-request.d.ts +5 -5
  137. package/lib/request/update-notebook-session-request.d.ts +6 -6
  138. package/lib/request/update-pipeline-request.d.ts +4 -4
  139. package/lib/request/update-pipeline-run-request.d.ts +4 -4
  140. package/lib/request/update-project-request.d.ts +5 -5
  141. package/lib/response/get-job-artifact-content-response.d.ts +1 -1
  142. package/lib/response/get-model-artifact-content-response.d.ts +1 -1
  143. package/lib/response/get-step-artifact-content-response.d.ts +1 -1
  144. package/lib/response/head-job-artifact-response.d.ts +1 -1
  145. package/lib/response/head-model-artifact-response.d.ts +1 -1
  146. package/lib/response/head-step-artifact-response.d.ts +1 -1
  147. package/package.json +3 -3
@@ -19,41 +19,41 @@ export interface OcirModelDeploymentEnvironmentConfigurationDetails extends mode
19
19
  /**
20
20
  * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format.
21
21
  * Acceptable format:
22
- * `<region>.ocir.io/<registry>/<image>:<tag>`
23
- * `<region>.ocir.io/<registry>/<image>:<tag>@digest`
22
+ * {@code <region>.ocir.io/<registry>/<image>:<tag>}
23
+ * {@code <region>.ocir.io/<registry>/<image>:<tag>@digest}
24
24
  *
25
25
  */
26
26
  "image": string;
27
27
  /**
28
28
  * The digest of the container image. For example,
29
- * `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030`
29
+ * {@code sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030}
30
30
  *
31
31
  */
32
32
  "imageDigest"?: string;
33
33
  /**
34
34
  * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings.
35
- * Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`.
36
- * The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes.
35
+ * Use {@code CMD} as arguments to the {@code ENTRYPOINT} or the only command to run in the absence of an {@code ENTRYPOINT}.
36
+ * The combined size of {@code CMD} and {@code ENTRYPOINT} must be less than 2048 bytes.
37
37
  *
38
38
  */
39
39
  "cmd"?: Array<string>;
40
40
  /**
41
41
  * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings.
42
- * Accept the `CMD` as extra arguments.
43
- * The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes.
44
- * More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact).
42
+ * Accept the {@code CMD} as extra arguments.
43
+ * The combined size of {@code CMD} and {@code ENTRYPOINT} must be less than 2048 bytes.
44
+ * More information on how {@code CMD} and {@code ENTRYPOINT} interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact).
45
45
  *
46
46
  */
47
47
  "entrypoint"?: Array<string>;
48
48
  /**
49
49
  * The port on which the web server serving the inference is running.
50
- * The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`.
50
+ * The port can be anything between {@code 1024} and {@code 65535}. The following ports cannot be used {@code 24224}, {@code 8446}, {@code 8447}.
51
51
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
52
52
  */
53
53
  "serverPort"?: number;
54
54
  /**
55
55
  * The port on which the container [HEALTHCHECK](https://docs.docker.com/engine/reference/builder/#healthcheck) would listen.
56
- * The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`.
56
+ * The port can be anything between {@code 1024} and {@code 65535}. The following ports cannot be used {@code 24224}, {@code 8446}, {@code 8447}.
57
57
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
58
58
  */
59
59
  "healthCheckPort"?: number;
@@ -64,7 +64,7 @@ export interface OcirModelDeploymentEnvironmentConfigurationDetails extends mode
64
64
  * Key should contain only letters, digits and underscore (_)
65
65
  * Key should start with a letter.
66
66
  * Key should have at least 2 characters.
67
- * Key should not end with underscore eg. `TEST_`
67
+ * Key should not end with underscore eg. {@code TEST_}
68
68
  * Key if added cannot be empty. Value can be empty.
69
69
  * No specific size limits on individual Values. But overall environment variables is limited to 2048 bytes.
70
70
  * Key can't be reserved Model Deployment environment variables.
@@ -66,7 +66,7 @@ export interface PipelineRunSummary {
66
66
  "lifecycleDetails"?: string;
67
67
  /**
68
68
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
69
- * Example: `{\"Department\": \"Finance\"}`
69
+ * Example: {@code {\"Department\": \"Finance\"}}
70
70
  *
71
71
  */
72
72
  "freeformTags"?: {
@@ -74,7 +74,7 @@ export interface PipelineRunSummary {
74
74
  };
75
75
  /**
76
76
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
77
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
77
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
78
78
  *
79
79
  */
80
80
  "definedTags"?: {
@@ -84,7 +84,7 @@ export interface PipelineRunSummary {
84
84
  };
85
85
  /**
86
86
  * Usage of system tag keys. These predefined keys are scoped to namespaces.
87
- * Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
87
+ * Example: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}}
88
88
  *
89
89
  */
90
90
  "systemTags"?: {
@@ -78,7 +78,7 @@ export interface PipelineRun {
78
78
  "lifecycleDetails"?: string;
79
79
  /**
80
80
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
81
- * Example: `{\"Department\": \"Finance\"}`
81
+ * Example: {@code {\"Department\": \"Finance\"}}
82
82
  *
83
83
  */
84
84
  "freeformTags"?: {
@@ -86,7 +86,7 @@ export interface PipelineRun {
86
86
  };
87
87
  /**
88
88
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
89
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
89
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
90
90
  *
91
91
  */
92
92
  "definedTags"?: {
@@ -96,7 +96,7 @@ export interface PipelineRun {
96
96
  };
97
97
  /**
98
98
  * Usage of system tag keys. These predefined keys are scoped to namespaces.
99
- * Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
99
+ * Example: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}}
100
100
  *
101
101
  */
102
102
  "systemTags"?: {
@@ -54,7 +54,7 @@ export interface PipelineSummary {
54
54
  "lifecycleState": model.PipelineLifecycleState;
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. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
57
- * Example: `{\"Department\": \"Finance\"}`
57
+ * Example: {@code {\"Department\": \"Finance\"}}
58
58
  *
59
59
  */
60
60
  "freeformTags"?: {
@@ -62,7 +62,7 @@ export interface PipelineSummary {
62
62
  };
63
63
  /**
64
64
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
65
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
65
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
66
66
  *
67
67
  */
68
68
  "definedTags"?: {
@@ -72,7 +72,7 @@ export interface PipelineSummary {
72
72
  };
73
73
  /**
74
74
  * Usage of system tag keys. These predefined keys are scoped to namespaces.
75
- * Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
75
+ * Example: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}}
76
76
  *
77
77
  */
78
78
  "systemTags"?: {
@@ -69,7 +69,7 @@ export interface Pipeline {
69
69
  "lifecycleDetails"?: string;
70
70
  /**
71
71
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
72
- * Example: `{\"Department\": \"Finance\"}`
72
+ * Example: {@code {\"Department\": \"Finance\"}}
73
73
  *
74
74
  */
75
75
  "freeformTags"?: {
@@ -77,7 +77,7 @@ export interface Pipeline {
77
77
  };
78
78
  /**
79
79
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
80
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
80
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
81
81
  *
82
82
  */
83
83
  "definedTags"?: {
@@ -87,7 +87,7 @@ export interface Pipeline {
87
87
  };
88
88
  /**
89
89
  * Usage of system tag keys. These predefined keys are scoped to namespaces.
90
- * Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`
90
+ * Example: {@code {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}}
91
91
  *
92
92
  */
93
93
  "systemTags"?: {
@@ -48,7 +48,7 @@ export interface ProjectSummary {
48
48
  "lifecycleState": model.ProjectLifecycleState;
49
49
  /**
50
50
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
51
- * Example: `{\"Department\": \"Finance\"}`
51
+ * Example: {@code {\"Department\": \"Finance\"}}
52
52
  *
53
53
  */
54
54
  "freeformTags"?: {
@@ -56,7 +56,7 @@ export interface ProjectSummary {
56
56
  };
57
57
  /**
58
58
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
59
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
59
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
60
60
  *
61
61
  */
62
62
  "definedTags"?: {
@@ -49,7 +49,7 @@ export interface Project {
49
49
  "lifecycleState": model.ProjectLifecycleState;
50
50
  /**
51
51
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
52
- * Example: `{\"Department\": \"Finance\"}`
52
+ * Example: {@code {\"Department\": \"Finance\"}}
53
53
  *
54
54
  */
55
55
  "freeformTags"?: {
@@ -57,7 +57,7 @@ export interface Project {
57
57
  };
58
58
  /**
59
59
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
60
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
60
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
61
61
  *
62
62
  */
63
63
  "definedTags"?: {
@@ -18,7 +18,7 @@
18
18
  export interface UpdateDataSciencePrivateEndpointDetails {
19
19
  /**
20
20
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
21
- * Example: `{\"Department\": \"Finance\"}`
21
+ * Example: {@code {\"Department\": \"Finance\"}}
22
22
  *
23
23
  */
24
24
  "freeformTags"?: {
@@ -26,7 +26,7 @@ export interface UpdateDataSciencePrivateEndpointDetails {
26
26
  };
27
27
  /**
28
28
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
29
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
29
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
30
30
  *
31
31
  */
32
32
  "definedTags"?: {
@@ -23,7 +23,7 @@ export interface UpdateDefaultModelDeploymentEnvironmentConfigurationDetails ext
23
23
  * Key should contain only letters, digits and underscore (_)
24
24
  * Key should start with a letter.
25
25
  * Key should have at least 2 characters.
26
- * Key should not end with underscore eg. `TEST_`
26
+ * Key should not end with underscore eg. {@code TEST_}
27
27
  * Key if added cannot be empty. Value can be empty.
28
28
  * No specific size limits on individual Values. But overall environment variables is limited to 2048 bytes.
29
29
  * Key can't be reserved Model Deployment environment variables.
@@ -31,7 +31,7 @@ export interface UpdateJobDetails {
31
31
  "jobStorageMountConfigurationDetailsList"?: Array<model.StorageMountConfigurationDetails>;
32
32
  /**
33
33
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
34
- * Example: `{\"Department\": \"Finance\"}`
34
+ * Example: {@code {\"Department\": \"Finance\"}}
35
35
  *
36
36
  */
37
37
  "freeformTags"?: {
@@ -39,7 +39,7 @@ export interface UpdateJobDetails {
39
39
  };
40
40
  /**
41
41
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
42
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
42
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
43
43
  *
44
44
  */
45
45
  "definedTags"?: {
@@ -21,7 +21,7 @@ export interface UpdateJobRunDetails {
21
21
  "displayName"?: string;
22
22
  /**
23
23
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
24
- * Example: `{\"Department\": \"Finance\"}`
24
+ * Example: {@code {\"Department\": \"Finance\"}}
25
25
  *
26
26
  */
27
27
  "freeformTags"?: {
@@ -29,7 +29,7 @@ export interface UpdateJobRunDetails {
29
29
  };
30
30
  /**
31
31
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
32
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
32
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
33
33
  *
34
34
  */
35
35
  "definedTags"?: {
@@ -13,15 +13,15 @@
13
13
  */
14
14
  import * as model from "../model";
15
15
  /**
16
- * Details for updating a model deployment. You can update `modelDeploymentConfigurationDetails` and change `instanceShapeName` and `modelId` when the model deployment is in
17
- * the ACTIVE lifecycle state. The `bandwidthMbps` or `instanceCount` can only be updated while the model deployment is in the `INACTIVE` state. Changes to the `bandwidthMbps`
18
- * or `instanceCount` will take effect the next time the `ActivateModelDeployment` action is invoked on the model deployment resource.
16
+ * Details for updating a model deployment. You can update {@code modelDeploymentConfigurationDetails} and change {@code instanceShapeName} and {@code modelId} when the model deployment is in
17
+ * the ACTIVE lifecycle state. The {@code bandwidthMbps} or {@code instanceCount} can only be updated while the model deployment is in the {@code INACTIVE} state. Changes to the {@code bandwidthMbps}
18
+ * or {@code instanceCount} will take effect the next time the {@code ActivateModelDeployment} action is invoked on the model deployment resource.
19
19
  *
20
20
  */
21
21
  export interface UpdateModelDeploymentDetails {
22
22
  /**
23
23
  * A user-friendly display name for the resource. Does not have to be unique, and can be modified. Avoid entering confidential information.
24
- * Example: `My ModelDeployment`
24
+ * Example: {@code My ModelDeployment}
25
25
  *
26
26
  */
27
27
  "displayName"?: string;
@@ -33,7 +33,7 @@ export interface UpdateModelDeploymentDetails {
33
33
  "categoryLogDetails"?: model.UpdateCategoryLogDetails;
34
34
  /**
35
35
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
36
- * Example: `{\"Department\": \"Finance\"}`
36
+ * Example: {@code {\"Department\": \"Finance\"}}
37
37
  *
38
38
  */
39
39
  "freeformTags"?: {
@@ -41,7 +41,7 @@ export interface UpdateModelDeploymentDetails {
41
41
  };
42
42
  /**
43
43
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
44
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
44
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
45
45
  *
46
46
  */
47
47
  "definedTags"?: {
@@ -19,7 +19,7 @@ import * as model from "../model";
19
19
  export interface UpdateModelDetails {
20
20
  /**
21
21
  * A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
22
- * Example: `My Model`
22
+ * Example: {@code My Model}
23
23
  *
24
24
  */
25
25
  "displayName"?: string;
@@ -29,7 +29,7 @@ export interface UpdateModelDetails {
29
29
  "description"?: string;
30
30
  /**
31
31
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
32
- * Example: `{\"Department\": \"Finance\"}`
32
+ * Example: {@code {\"Department\": \"Finance\"}}
33
33
  *
34
34
  */
35
35
  "freeformTags"?: {
@@ -37,7 +37,7 @@ export interface UpdateModelDetails {
37
37
  };
38
38
  /**
39
39
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
40
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
40
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
41
41
  *
42
42
  */
43
43
  "definedTags"?: {
@@ -22,7 +22,7 @@ export interface UpdateModelVersionSetDetails {
22
22
  "description"?: string;
23
23
  /**
24
24
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
25
- * Example: `{\"Department\": \"Finance\"}`
25
+ * Example: {@code {\"Department\": \"Finance\"}}
26
26
  *
27
27
  */
28
28
  "freeformTags"?: {
@@ -30,7 +30,7 @@ export interface UpdateModelVersionSetDetails {
30
30
  };
31
31
  /**
32
32
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
33
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
33
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
34
34
  *
35
35
  */
36
36
  "definedTags"?: {
@@ -13,21 +13,21 @@
13
13
  */
14
14
  import * as model from "../model";
15
15
  /**
16
- * Details for updating a notebook session. `notebookSessionConfigurationDetails` can only be updated while the notebook session is in the `INACTIVE` state.
17
- * Changes to the `notebookSessionConfigurationDetails` take effect the next time the `ActivateNotebookSession` action is invoked on the notebook session resource.
16
+ * Details for updating a notebook session. {@code notebookSessionConfigurationDetails} can only be updated while the notebook session is in the {@code INACTIVE} state.
17
+ * Changes to the {@code notebookSessionConfigurationDetails} take effect the next time the {@code ActivateNotebookSession} action is invoked on the notebook session resource.
18
18
  *
19
19
  */
20
20
  export interface UpdateNotebookSessionDetails {
21
21
  /**
22
22
  * A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information.
23
- * Example: `My NotebookSession`
23
+ * Example: {@code My NotebookSession}
24
24
  *
25
25
  */
26
26
  "displayName"?: string;
27
27
  "notebookSessionConfigurationDetails"?: model.NotebookSessionConfigurationDetails;
28
28
  /**
29
29
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
30
- * Example: `{\"Department\": \"Finance\"}`
30
+ * Example: {@code {\"Department\": \"Finance\"}}
31
31
  *
32
32
  */
33
33
  "freeformTags"?: {
@@ -35,7 +35,7 @@ export interface UpdateNotebookSessionDetails {
35
35
  };
36
36
  /**
37
37
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
38
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
38
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
39
39
  *
40
40
  */
41
41
  "definedTags"?: {
@@ -19,41 +19,41 @@ export interface UpdateOcirModelDeploymentEnvironmentConfigurationDetails extend
19
19
  /**
20
20
  * The full path to the Oracle Container Repository (OCIR) registry, image, and tag in a canonical format.
21
21
  * Acceptable format:
22
- * `<region>.ocir.io/<registry>/<image>:<tag>`
23
- * `<region>.ocir.io/<registry>/<image>:<tag>@digest`
22
+ * {@code <region>.ocir.io/<registry>/<image>:<tag>}
23
+ * {@code <region>.ocir.io/<registry>/<image>:<tag>@digest}
24
24
  *
25
25
  */
26
26
  "image"?: string;
27
27
  /**
28
28
  * The digest of the container image. For example,
29
- * `sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030`
29
+ * {@code sha256:881303a6b2738834d795a32b4a98eb0e5e3d1cad590a712d1e04f9b2fa90a030}
30
30
  *
31
31
  */
32
32
  "imageDigest"?: string;
33
33
  /**
34
34
  * The container image run [CMD](https://docs.docker.com/engine/reference/builder/#cmd) as a list of strings.
35
- * Use `CMD` as arguments to the `ENTRYPOINT` or the only command to run in the absence of an `ENTRYPOINT`.
36
- * The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes.
35
+ * Use {@code CMD} as arguments to the {@code ENTRYPOINT} or the only command to run in the absence of an {@code ENTRYPOINT}.
36
+ * The combined size of {@code CMD} and {@code ENTRYPOINT} must be less than 2048 bytes.
37
37
  *
38
38
  */
39
39
  "cmd"?: Array<string>;
40
40
  /**
41
41
  * The container image run [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) as a list of strings.
42
- * Accept the `CMD` as extra arguments.
43
- * The combined size of `CMD` and `ENTRYPOINT` must be less than 2048 bytes.
44
- * More information on how `CMD` and `ENTRYPOINT` interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact).
42
+ * Accept the {@code CMD} as extra arguments.
43
+ * The combined size of {@code CMD} and {@code ENTRYPOINT} must be less than 2048 bytes.
44
+ * More information on how {@code CMD} and {@code ENTRYPOINT} interact are [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact).
45
45
  *
46
46
  */
47
47
  "entrypoint"?: Array<string>;
48
48
  /**
49
49
  * The port on which the web server serving the inference is running.
50
- * The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`.
50
+ * The port can be anything between {@code 1024} and {@code 65535}. The following ports cannot be used {@code 24224}, {@code 8446}, {@code 8447}.
51
51
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
52
52
  */
53
53
  "serverPort"?: number;
54
54
  /**
55
55
  * The port on which the container [HEALTHCHECK](https://docs.docker.com/engine/reference/builder/#healthcheck) would listen.
56
- * The port can be anything between `1024` and `65535`. The following ports cannot be used `24224`, `8446`, `8447`.
56
+ * The port can be anything between {@code 1024} and {@code 65535}. The following ports cannot be used {@code 24224}, {@code 8446}, {@code 8447}.
57
57
  * Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
58
58
  */
59
59
  "healthCheckPort"?: number;
@@ -64,7 +64,7 @@ export interface UpdateOcirModelDeploymentEnvironmentConfigurationDetails extend
64
64
  * Key should contain only letters, digits and underscore (_)
65
65
  * Key should start with a letter.
66
66
  * Key should have at least 2 characters.
67
- * Key should not end with underscore eg. `TEST_`
67
+ * Key should not end with underscore eg. {@code TEST_}
68
68
  * Key if added cannot be empty. Value can be empty.
69
69
  * No specific size limits on individual Values. But overall environment variables is limited to 2048 bytes.
70
70
  * Key can't be reserved Model Deployment environment variables.
@@ -32,7 +32,7 @@ export interface UpdatePipelineDetails {
32
32
  "stepDetails"?: Array<model.PipelineStepUpdateDetails>;
33
33
  /**
34
34
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
35
- * Example: `{\"Department\": \"Finance\"}`
35
+ * Example: {@code {\"Department\": \"Finance\"}}
36
36
  *
37
37
  */
38
38
  "freeformTags"?: {
@@ -40,7 +40,7 @@ export interface UpdatePipelineDetails {
40
40
  };
41
41
  /**
42
42
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
43
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
43
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
44
44
  *
45
45
  */
46
46
  "definedTags"?: {
@@ -21,7 +21,7 @@ export interface UpdatePipelineRunDetails {
21
21
  "displayName"?: string;
22
22
  /**
23
23
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
24
- * Example: `{\"Department\": \"Finance\"}`
24
+ * Example: {@code {\"Department\": \"Finance\"}}
25
25
  *
26
26
  */
27
27
  "freeformTags"?: {
@@ -29,7 +29,7 @@ export interface UpdatePipelineRunDetails {
29
29
  };
30
30
  /**
31
31
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
32
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
32
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
33
33
  *
34
34
  */
35
35
  "definedTags"?: {
@@ -25,7 +25,7 @@ export interface UpdateProjectDetails {
25
25
  "description"?: string;
26
26
  /**
27
27
  * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
28
- * Example: `{\"Department\": \"Finance\"}`
28
+ * Example: {@code {\"Department\": \"Finance\"}}
29
29
  *
30
30
  */
31
31
  "freeformTags"?: {
@@ -33,7 +33,7 @@ export interface UpdateProjectDetails {
33
33
  };
34
34
  /**
35
35
  * Defined tags for this resource. Each key is predefined and scoped to a namespace. See [Resource Tags](https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).
36
- * Example: `{\"Operations\": {\"CostCenter\": \"42\"}}`
36
+ * Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
37
37
  *
38
38
  */
39
39
  "definedTags"?: {
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/datascience/ActivateModelDeployment.ts.html |here} to see how to use ActivateModelDeploymentRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.1/datascience/ActivateModelDeployment.ts.html |here} to see how to use ActivateModelDeploymentRequest.
16
16
  */
17
17
  export interface ActivateModelDeploymentRequest extends common.BaseRequest {
18
18
  /**
@@ -21,10 +21,10 @@ export interface ActivateModelDeploymentRequest extends common.BaseRequest {
21
21
  "modelDeploymentId": string;
22
22
  /**
23
23
  * For optimistic concurrency control. In the PUT or DELETE call
24
- * for a resource, set the `if-match` parameter to the value of the
24
+ * for a resource, set the {@code if-match} parameter to the value of the
25
25
  * etag from a previous GET or POST response for that resource.
26
- * The resource is updated or deleted only if the `etag` you
27
- * provide matches the resource's current `etag` value.
26
+ * The resource is updated or deleted only if the {@code etag} you
27
+ * provide matches the resource's current {@code etag} value.
28
28
  *
29
29
  */
30
30
  "ifMatch"?: string;
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/datascience/ActivateModel.ts.html |here} to see how to use ActivateModelRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.1/datascience/ActivateModel.ts.html |here} to see how to use ActivateModelRequest.
16
16
  */
17
17
  export interface ActivateModelRequest extends common.BaseRequest {
18
18
  /**
@@ -21,10 +21,10 @@ export interface ActivateModelRequest extends common.BaseRequest {
21
21
  "modelId": string;
22
22
  /**
23
23
  * For optimistic concurrency control. In the PUT or DELETE call
24
- * for a resource, set the `if-match` parameter to the value of the
24
+ * for a resource, set the {@code if-match} parameter to the value of the
25
25
  * etag from a previous GET or POST response for that resource.
26
- * The resource is updated or deleted only if the `etag` you
27
- * provide matches the resource's current `etag` value.
26
+ * The resource is updated or deleted only if the {@code etag} you
27
+ * provide matches the resource's current {@code etag} value.
28
28
  *
29
29
  */
30
30
  "ifMatch"?: string;
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/datascience/ActivateNotebookSession.ts.html |here} to see how to use ActivateNotebookSessionRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.1/datascience/ActivateNotebookSession.ts.html |here} to see how to use ActivateNotebookSessionRequest.
16
16
  */
17
17
  export interface ActivateNotebookSessionRequest extends common.BaseRequest {
18
18
  /**
@@ -21,10 +21,10 @@ export interface ActivateNotebookSessionRequest extends common.BaseRequest {
21
21
  "notebookSessionId": string;
22
22
  /**
23
23
  * For optimistic concurrency control. In the PUT or DELETE call
24
- * for a resource, set the `if-match` parameter to the value of the
24
+ * for a resource, set the {@code if-match} parameter to the value of the
25
25
  * etag from a previous GET or POST response for that resource.
26
- * The resource is updated or deleted only if the `etag` you
27
- * provide matches the resource's current `etag` value.
26
+ * The resource is updated or deleted only if the {@code etag} you
27
+ * provide matches the resource's current {@code etag} value.
28
28
  *
29
29
  */
30
30
  "ifMatch"?: string;
@@ -12,7 +12,7 @@
12
12
  */
13
13
  import common = require("oci-common");
14
14
  /**
15
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.76.1/datascience/CancelJobRun.ts.html |here} to see how to use CancelJobRunRequest.
15
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.77.1/datascience/CancelJobRun.ts.html |here} to see how to use CancelJobRunRequest.
16
16
  */
17
17
  export interface CancelJobRunRequest extends common.BaseRequest {
18
18
  /**
@@ -26,10 +26,10 @@ export interface CancelJobRunRequest extends common.BaseRequest {
26
26
  "opcRequestId"?: string;
27
27
  /**
28
28
  * For optimistic concurrency control. In the PUT or DELETE call
29
- * for a resource, set the `if-match` parameter to the value of the
29
+ * for a resource, set the {@code if-match} parameter to the value of the
30
30
  * etag from a previous GET or POST response for that resource.
31
- * The resource is updated or deleted only if the `etag` you
32
- * provide matches the resource's current `etag` value.
31
+ * The resource is updated or deleted only if the {@code etag} you
32
+ * provide matches the resource's current {@code etag} value.
33
33
  *
34
34
  */
35
35
  "ifMatch"?: string;