oci-bds 2.5.2 → 2.8.0

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 (77) hide show
  1. package/lib/bds-waiter.d.ts +8 -0
  2. package/lib/bds-waiter.js +12 -0
  3. package/lib/bds-waiter.js.map +1 -1
  4. package/lib/client.d.ts +124 -21
  5. package/lib/client.js +444 -42
  6. package/lib/client.js.map +1 -1
  7. package/lib/model/bds-api-key-summary.d.ts +46 -0
  8. package/lib/model/bds-api-key-summary.js +30 -0
  9. package/lib/model/bds-api-key-summary.js.map +1 -0
  10. package/lib/model/bds-api-key.d.ts +74 -0
  11. package/lib/model/bds-api-key.js +43 -0
  12. package/lib/model/bds-api-key.js.map +1 -0
  13. package/lib/model/create-bds-api-key-details.d.ts +42 -0
  14. package/lib/model/create-bds-api-key-details.js +30 -0
  15. package/lib/model/create-bds-api-key-details.js.map +1 -0
  16. package/lib/model/index.d.ts +8 -0
  17. package/lib/model/index.js +9 -1
  18. package/lib/model/index.js.map +1 -1
  19. package/lib/model/test-bds-object-storage-connection-details.d.ts +34 -0
  20. package/lib/model/test-bds-object-storage-connection-details.js +30 -0
  21. package/lib/model/test-bds-object-storage-connection-details.js.map +1 -0
  22. package/lib/request/add-auto-scaling-configuration-request.d.ts +1 -1
  23. package/lib/request/add-block-storage-request.d.ts +1 -1
  24. package/lib/request/add-cloud-sql-request.d.ts +1 -1
  25. package/lib/request/add-worker-nodes-request.d.ts +1 -1
  26. package/lib/request/change-bds-instance-compartment-request.d.ts +1 -1
  27. package/lib/request/change-shape-request.d.ts +1 -1
  28. package/lib/request/create-bds-api-key-request.d.ts +40 -0
  29. package/lib/request/create-bds-api-key-request.js +15 -0
  30. package/lib/request/create-bds-api-key-request.js.map +1 -0
  31. package/lib/request/create-bds-instance-request.d.ts +1 -1
  32. package/lib/request/delete-bds-api-key-request.d.ts +39 -0
  33. package/lib/request/delete-bds-api-key-request.js +15 -0
  34. package/lib/request/delete-bds-api-key-request.js.map +1 -0
  35. package/lib/request/delete-bds-instance-request.d.ts +1 -1
  36. package/lib/request/get-auto-scaling-configuration-request.d.ts +1 -1
  37. package/lib/request/get-bds-api-key-request.d.ts +30 -0
  38. package/lib/request/get-bds-api-key-request.js +15 -0
  39. package/lib/request/get-bds-api-key-request.js.map +1 -0
  40. package/lib/request/get-bds-instance-request.d.ts +1 -1
  41. package/lib/request/get-work-request-request.d.ts +1 -1
  42. package/lib/request/index.d.ts +10 -0
  43. package/lib/request/index.js +3 -1
  44. package/lib/request/index.js.map +1 -1
  45. package/lib/request/list-auto-scaling-configurations-request.d.ts +1 -1
  46. package/lib/request/list-bds-api-keys-request.d.ts +62 -0
  47. package/lib/request/list-bds-api-keys-request.js +24 -0
  48. package/lib/request/list-bds-api-keys-request.js.map +1 -0
  49. package/lib/request/list-bds-instances-request.d.ts +1 -1
  50. package/lib/request/list-work-request-errors-request.d.ts +1 -1
  51. package/lib/request/list-work-request-logs-request.d.ts +1 -1
  52. package/lib/request/list-work-requests-request.d.ts +1 -1
  53. package/lib/request/remove-auto-scaling-configuration-request.d.ts +1 -1
  54. package/lib/request/remove-cloud-sql-request.d.ts +1 -1
  55. package/lib/request/restart-node-request.d.ts +1 -1
  56. package/lib/request/test-bds-object-storage-connection-request.d.ts +35 -0
  57. package/lib/request/test-bds-object-storage-connection-request.js +15 -0
  58. package/lib/request/test-bds-object-storage-connection-request.js.map +1 -0
  59. package/lib/request/update-auto-scaling-configuration-request.d.ts +1 -1
  60. package/lib/request/update-bds-instance-request.d.ts +1 -1
  61. package/lib/response/create-bds-api-key-response.d.ts +25 -0
  62. package/lib/response/create-bds-api-key-response.js +15 -0
  63. package/lib/response/create-bds-api-key-response.js.map +1 -0
  64. package/lib/response/delete-bds-api-key-response.d.ts +25 -0
  65. package/lib/response/delete-bds-api-key-response.js +15 -0
  66. package/lib/response/delete-bds-api-key-response.js.map +1 -0
  67. package/lib/response/get-bds-api-key-response.d.ts +30 -0
  68. package/lib/response/get-bds-api-key-response.js +15 -0
  69. package/lib/response/get-bds-api-key-response.js.map +1 -0
  70. package/lib/response/index.d.ts +10 -0
  71. package/lib/response/list-bds-api-keys-response.d.ts +32 -0
  72. package/lib/response/list-bds-api-keys-response.js +15 -0
  73. package/lib/response/list-bds-api-keys-response.js.map +1 -0
  74. package/lib/response/test-bds-object-storage-connection-response.d.ts +25 -0
  75. package/lib/response/test-bds-object-storage-connection-response.js +15 -0
  76. package/lib/response/test-bds-object-storage-connection-response.js.map +1 -0
  77. package/package.json +3 -3
@@ -27,6 +27,14 @@ export declare class BdsWaiter {
27
27
  * @return response returns GetAutoScalingConfigurationResponse | null (null in case of 404 response)
28
28
  */
29
29
  forAutoScalingConfiguration(request: serviceRequests.GetAutoScalingConfigurationRequest, ...targetStates: models.AutoScalingConfiguration.LifecycleState[]): Promise<serviceResponses.GetAutoScalingConfigurationResponse | null>;
30
+ /**
31
+ * Waits forBdsApiKey till it reaches any of the provided states
32
+ *
33
+ * @param request the request to send
34
+ * @param targetStates the desired states to wait for. The waiter will return once the resource reaches any of the provided states
35
+ * @return response returns GetBdsApiKeyResponse | null (null in case of 404 response)
36
+ */
37
+ forBdsApiKey(request: serviceRequests.GetBdsApiKeyRequest, ...targetStates: models.BdsApiKey.LifecycleState[]): Promise<serviceResponses.GetBdsApiKeyResponse | null>;
30
38
  /**
31
39
  * Waits forBdsInstance till it reaches any of the provided states
32
40
  *
package/lib/bds-waiter.js CHANGED
@@ -61,6 +61,18 @@ class BdsWaiter {
61
61
  return oci_common_1.genericTerminalConditionWaiter(this.config, () => this.client.getAutoScalingConfiguration(request), response => targetStates.includes(response.autoScalingConfiguration.lifecycleState), targetStates.includes(models.AutoScalingConfiguration.LifecycleState.Deleted));
62
62
  });
63
63
  }
64
+ /**
65
+ * Waits forBdsApiKey till it reaches any of the provided states
66
+ *
67
+ * @param request the request to send
68
+ * @param targetStates the desired states to wait for. The waiter will return once the resource reaches any of the provided states
69
+ * @return response returns GetBdsApiKeyResponse | null (null in case of 404 response)
70
+ */
71
+ forBdsApiKey(request, ...targetStates) {
72
+ return __awaiter(this, void 0, void 0, function* () {
73
+ return oci_common_1.genericTerminalConditionWaiter(this.config, () => this.client.getBdsApiKey(request), response => targetStates.includes(response.bdsApiKey.lifecycleState), targetStates.includes(models.BdsApiKey.LifecycleState.Deleted));
74
+ });
75
+ }
64
76
  /**
65
77
  * Waits forBdsInstance till it reaches any of the provided states
66
78
  *
@@ -1 +1 @@
1
- {"version":3,"file":"bds-waiter.js","sourceRoot":"","sources":["../../../../lib/bds/lib/bds-waiter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIH,gDAAkC;AAElC,2CAAgG;AAEhG,MAAa,SAAS;IACpB,YAA2B,MAAiB,EAAmB,MAA4B;QAAhE,WAAM,GAAN,MAAM,CAAW;QAAmB,WAAM,GAAN,MAAM,CAAsB;IAAG,CAAC;IAE/F;;;;;;OAMG;IACU,2BAA2B,CACtC,OAA2D,EAC3D,GAAG,YAA8D;;YAEjE,OAAO,2CAA8B,CACnC,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,OAAO,CAAC,EACtD,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,wBAAwB,CAAC,cAAe,CAAC,EACpF,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,wBAAwB,CAAC,cAAc,CAAC,OAAO,CAAC,CAC9E,CAAC;QACJ,CAAC;KAAA;IAED;;;;;;OAMG;IACU,cAAc,CACzB,OAA8C,EAC9C,GAAG,YAAiD;;YAEpD,OAAO,2CAA8B,CACnC,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,EACzC,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAe,CAAC,EACvE,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC,CACjE,CAAC;QACJ,CAAC;KAAA;IAED;;;;;OAKG;IACU,cAAc,CACzB,OAA8C;;YAE9C,OAAO,0BAAa,CAClB,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,EACzC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAC/D,CAAC;QACJ,CAAC;KAAA;CACF;AAxDD,8BAwDC"}
1
+ {"version":3,"file":"bds-waiter.js","sourceRoot":"","sources":["../../../../lib/bds/lib/bds-waiter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIH,gDAAkC;AAElC,2CAAgG;AAEhG,MAAa,SAAS;IACpB,YAA2B,MAAiB,EAAmB,MAA4B;QAAhE,WAAM,GAAN,MAAM,CAAW;QAAmB,WAAM,GAAN,MAAM,CAAsB;IAAG,CAAC;IAE/F;;;;;;OAMG;IACU,2BAA2B,CACtC,OAA2D,EAC3D,GAAG,YAA8D;;YAEjE,OAAO,2CAA8B,CACnC,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,2BAA2B,CAAC,OAAO,CAAC,EACtD,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,wBAAwB,CAAC,cAAe,CAAC,EACpF,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,wBAAwB,CAAC,cAAc,CAAC,OAAO,CAAC,CAC9E,CAAC;QACJ,CAAC;KAAA;IAED;;;;;;OAMG;IACU,YAAY,CACvB,OAA4C,EAC5C,GAAG,YAA+C;;YAElD,OAAO,2CAA8B,CACnC,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,EACvC,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,cAAe,CAAC,EACrE,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,OAAO,CAAC,CAC/D,CAAC;QACJ,CAAC;KAAA;IAED;;;;;;OAMG;IACU,cAAc,CACzB,OAA8C,EAC9C,GAAG,YAAiD;;YAEpD,OAAO,2CAA8B,CACnC,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,EACzC,QAAQ,CAAC,EAAE,CAAC,YAAY,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,cAAe,CAAC,EACvE,YAAY,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,OAAO,CAAC,CACjE,CAAC;QACJ,CAAC;KAAA;IAED;;;;;OAKG;IACU,cAAc,CACzB,OAA8C;;YAE9C,OAAO,0BAAa,CAClB,IAAI,CAAC,MAAM,EACX,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,OAAO,CAAC,EACzC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAC/D,CAAC;QACJ,CAAC;KAAA;CACF;AA3ED,8BA2EC"}
package/lib/client.d.ts CHANGED
@@ -18,6 +18,9 @@ import * as responses from "./response";
18
18
  import { BdsWaiter } from "./bds-waiter";
19
19
  export declare enum BdsApiKeys {
20
20
  }
21
+ /**
22
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
23
+ */
21
24
  export declare class BdsClient {
22
25
  protected static serviceEndpointTemplate: string;
23
26
  protected "_endpoint": string;
@@ -68,106 +71,146 @@ export declare class BdsClient {
68
71
  /**
69
72
  * Add an autoscale configuration to the cluster.
70
73
  *
74
+ * This operation does not retry by default if the user has not defined a retry configuration.
71
75
  * @param AddAutoScalingConfigurationRequest
72
76
  * @return AddAutoScalingConfigurationResponse
73
77
  * @throws OciError when an error occurs
74
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/AddAutoScalingConfiguration.ts.html |here} to see how to use AddAutoScalingConfiguration API.
78
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/AddAutoScalingConfiguration.ts.html |here} to see how to use AddAutoScalingConfiguration API.
75
79
  */
76
80
  addAutoScalingConfiguration(addAutoScalingConfigurationRequest: requests.AddAutoScalingConfigurationRequest): Promise<responses.AddAutoScalingConfigurationResponse>;
77
81
  /**
78
82
  * Adds block storage to existing worker nodes. The same amount of storage will be added to all worker nodes. No change will be made to storage that is already attached. Block storage cannot be removed.
79
83
  *
84
+ * This operation does not retry by default if the user has not defined a retry configuration.
80
85
  * @param AddBlockStorageRequest
81
86
  * @return AddBlockStorageResponse
82
87
  * @throws OciError when an error occurs
83
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/AddBlockStorage.ts.html |here} to see how to use AddBlockStorage API.
88
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/AddBlockStorage.ts.html |here} to see how to use AddBlockStorage API.
84
89
  */
85
90
  addBlockStorage(addBlockStorageRequest: requests.AddBlockStorageRequest): Promise<responses.AddBlockStorageResponse>;
86
91
  /**
87
92
  * Adds Cloud SQL to your cluster. You can use Cloud SQL to query against non-relational data stored in multiple big data sources, including Apache Hive, HDFS, Oracle NoSQL Database, and Apache HBase. Adding Cloud SQL adds a query server node to the cluster and creates cell servers on all the worker nodes in the cluster.
88
93
  *
94
+ * This operation does not retry by default if the user has not defined a retry configuration.
89
95
  * @param AddCloudSqlRequest
90
96
  * @return AddCloudSqlResponse
91
97
  * @throws OciError when an error occurs
92
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/AddCloudSql.ts.html |here} to see how to use AddCloudSql API.
98
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/AddCloudSql.ts.html |here} to see how to use AddCloudSql API.
93
99
  */
94
100
  addCloudSql(addCloudSqlRequest: requests.AddCloudSqlRequest): Promise<responses.AddCloudSqlResponse>;
95
101
  /**
96
102
  * Increases the size (scales out) a cluster by adding worker nodes. The added worker nodes will have the same shape and will have the same amount of attached block storage as other worker nodes in the cluster.
97
103
  *
104
+ * This operation does not retry by default if the user has not defined a retry configuration.
98
105
  * @param AddWorkerNodesRequest
99
106
  * @return AddWorkerNodesResponse
100
107
  * @throws OciError when an error occurs
101
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/AddWorkerNodes.ts.html |here} to see how to use AddWorkerNodes API.
108
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/AddWorkerNodes.ts.html |here} to see how to use AddWorkerNodes API.
102
109
  */
103
110
  addWorkerNodes(addWorkerNodesRequest: requests.AddWorkerNodesRequest): Promise<responses.AddWorkerNodesResponse>;
104
111
  /**
105
112
  * Moves a Big Data Service cluster into a different compartment.
106
113
  *
114
+ * This operation does not retry by default if the user has not defined a retry configuration.
107
115
  * @param ChangeBdsInstanceCompartmentRequest
108
116
  * @return ChangeBdsInstanceCompartmentResponse
109
117
  * @throws OciError when an error occurs
110
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/ChangeBdsInstanceCompartment.ts.html |here} to see how to use ChangeBdsInstanceCompartment API.
118
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/ChangeBdsInstanceCompartment.ts.html |here} to see how to use ChangeBdsInstanceCompartment API.
111
119
  */
112
120
  changeBdsInstanceCompartment(changeBdsInstanceCompartmentRequest: requests.ChangeBdsInstanceCompartmentRequest): Promise<responses.ChangeBdsInstanceCompartmentResponse>;
113
121
  /**
114
122
  * Changes the size of a cluster by scaling up or scaling down the nodes. Nodes are scaled up or down by changing the shapes of all the nodes of the same type to the next larger or smaller shape. The node types are master, utility, worker, and Cloud SQL. Only nodes with VM-STANDARD shapes can be scaled.
115
123
  *
124
+ * This operation does not retry by default if the user has not defined a retry configuration.
116
125
  * @param ChangeShapeRequest
117
126
  * @return ChangeShapeResponse
118
127
  * @throws OciError when an error occurs
119
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/ChangeShape.ts.html |here} to see how to use ChangeShape API.
128
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/ChangeShape.ts.html |here} to see how to use ChangeShape API.
120
129
  */
121
130
  changeShape(changeShapeRequest: requests.ChangeShapeRequest): Promise<responses.ChangeShapeResponse>;
131
+ /**
132
+ * Create an API key on behalf of the specified user.
133
+ *
134
+ * This operation does not retry by default if the user has not defined a retry configuration.
135
+ * @param CreateBdsApiKeyRequest
136
+ * @return CreateBdsApiKeyResponse
137
+ * @throws OciError when an error occurs
138
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/CreateBdsApiKey.ts.html |here} to see how to use CreateBdsApiKey API.
139
+ */
140
+ createBdsApiKey(createBdsApiKeyRequest: requests.CreateBdsApiKeyRequest): Promise<responses.CreateBdsApiKeyResponse>;
122
141
  /**
123
142
  * Creates a Big Data Service cluster.
124
143
  *
144
+ * This operation does not retry by default if the user has not defined a retry configuration.
125
145
  * @param CreateBdsInstanceRequest
126
146
  * @return CreateBdsInstanceResponse
127
147
  * @throws OciError when an error occurs
128
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/CreateBdsInstance.ts.html |here} to see how to use CreateBdsInstance API.
148
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/CreateBdsInstance.ts.html |here} to see how to use CreateBdsInstance API.
129
149
  */
130
150
  createBdsInstance(createBdsInstanceRequest: requests.CreateBdsInstanceRequest): Promise<responses.CreateBdsInstanceResponse>;
151
+ /**
152
+ * Deletes the user's API key represented by the provided ID.
153
+ * This operation does not retry by default if the user has not defined a retry configuration.
154
+ * @param DeleteBdsApiKeyRequest
155
+ * @return DeleteBdsApiKeyResponse
156
+ * @throws OciError when an error occurs
157
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/DeleteBdsApiKey.ts.html |here} to see how to use DeleteBdsApiKey API.
158
+ */
159
+ deleteBdsApiKey(deleteBdsApiKeyRequest: requests.DeleteBdsApiKeyRequest): Promise<responses.DeleteBdsApiKeyResponse>;
131
160
  /**
132
161
  * Deletes the cluster identified by the given ID.
162
+ * This operation does not retry by default if the user has not defined a retry configuration.
133
163
  * @param DeleteBdsInstanceRequest
134
164
  * @return DeleteBdsInstanceResponse
135
165
  * @throws OciError when an error occurs
136
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/DeleteBdsInstance.ts.html |here} to see how to use DeleteBdsInstance API.
166
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/DeleteBdsInstance.ts.html |here} to see how to use DeleteBdsInstance API.
137
167
  */
138
168
  deleteBdsInstance(deleteBdsInstanceRequest: requests.DeleteBdsInstanceRequest): Promise<responses.DeleteBdsInstanceResponse>;
139
169
  /**
140
170
  * Returns details of the autoscale configuration identified by the given ID.
141
171
  *
172
+ * This operation does not retry by default if the user has not defined a retry configuration.
142
173
  * @param GetAutoScalingConfigurationRequest
143
174
  * @return GetAutoScalingConfigurationResponse
144
175
  * @throws OciError when an error occurs
145
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/GetAutoScalingConfiguration.ts.html |here} to see how to use GetAutoScalingConfiguration API.
176
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/GetAutoScalingConfiguration.ts.html |here} to see how to use GetAutoScalingConfiguration API.
146
177
  */
147
178
  getAutoScalingConfiguration(getAutoScalingConfigurationRequest: requests.GetAutoScalingConfigurationRequest): Promise<responses.GetAutoScalingConfigurationResponse>;
179
+ /**
180
+ * Returns the user's API key information for the given ID.
181
+ * This operation does not retry by default if the user has not defined a retry configuration.
182
+ * @param GetBdsApiKeyRequest
183
+ * @return GetBdsApiKeyResponse
184
+ * @throws OciError when an error occurs
185
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/GetBdsApiKey.ts.html |here} to see how to use GetBdsApiKey API.
186
+ */
187
+ getBdsApiKey(getBdsApiKeyRequest: requests.GetBdsApiKeyRequest): Promise<responses.GetBdsApiKeyResponse>;
148
188
  /**
149
189
  * Returns information about the Big Data Service cluster identified by the given ID.
190
+ * This operation does not retry by default if the user has not defined a retry configuration.
150
191
  * @param GetBdsInstanceRequest
151
192
  * @return GetBdsInstanceResponse
152
193
  * @throws OciError when an error occurs
153
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/GetBdsInstance.ts.html |here} to see how to use GetBdsInstance API.
194
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/GetBdsInstance.ts.html |here} to see how to use GetBdsInstance API.
154
195
  */
155
196
  getBdsInstance(getBdsInstanceRequest: requests.GetBdsInstanceRequest): Promise<responses.GetBdsInstanceResponse>;
156
197
  /**
157
198
  * Returns the status of the work request identified by the given ID.
199
+ * This operation does not retry by default if the user has not defined a retry configuration.
158
200
  * @param GetWorkRequestRequest
159
201
  * @return GetWorkRequestResponse
160
202
  * @throws OciError when an error occurs
161
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
203
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
162
204
  */
163
205
  getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
164
206
  /**
165
207
  * Returns information about the autoscaling configurations for a cluster.
166
208
  *
209
+ * This operation does not retry by default if the user has not defined a retry configuration.
167
210
  * @param ListAutoScalingConfigurationsRequest
168
211
  * @return ListAutoScalingConfigurationsResponse
169
212
  * @throws OciError when an error occurs
170
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/ListAutoScalingConfigurations.ts.html |here} to see how to use ListAutoScalingConfigurations API.
213
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/ListAutoScalingConfigurations.ts.html |here} to see how to use ListAutoScalingConfigurations API.
171
214
  */
172
215
  listAutoScalingConfigurations(listAutoScalingConfigurationsRequest: requests.ListAutoScalingConfigurationsRequest): Promise<responses.ListAutoScalingConfigurationsResponse>;
173
216
  /**
@@ -202,13 +245,56 @@ export declare class BdsClient {
202
245
  * @param request a request which can be sent to the service operation
203
246
  */
204
247
  listAutoScalingConfigurationsResponseIterator(request: requests.ListAutoScalingConfigurationsRequest): AsyncIterableIterator<responses.ListAutoScalingConfigurationsResponse>;
248
+ /**
249
+ * Returns a list of all API keys associated with this Big Data Service cluster.
250
+ *
251
+ * This operation does not retry by default if the user has not defined a retry configuration.
252
+ * @param ListBdsApiKeysRequest
253
+ * @return ListBdsApiKeysResponse
254
+ * @throws OciError when an error occurs
255
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/ListBdsApiKeys.ts.html |here} to see how to use ListBdsApiKeys API.
256
+ */
257
+ listBdsApiKeys(listBdsApiKeysRequest: requests.ListBdsApiKeysRequest): Promise<responses.ListBdsApiKeysResponse>;
258
+ /**
259
+ * NOTE: This function is deprecated in favor of listBdsApiKeysRecordIterator function.
260
+ * Creates a new async iterator which will iterate over the models.BdsApiKeySummary objects
261
+ * contained in responses from the listBdsApiKeys operation. This iterator will fetch more data from the
262
+ * server as needed.
263
+ *
264
+ * @param request a request which can be sent to the service operation
265
+ */
266
+ listAllBdsApiKeys(request: requests.ListBdsApiKeysRequest): AsyncIterableIterator<model.BdsApiKeySummary>;
267
+ /**
268
+ * NOTE: This function is deprecated in favor of listBdsApiKeysResponseIterator function.
269
+ * Creates a new async iterator which will iterate over the responses received from the listBdsApiKeys operation. This iterator
270
+ * will fetch more data from the server as needed.
271
+ *
272
+ * @param request a request which can be sent to the service operation
273
+ */
274
+ listAllBdsApiKeysResponses(request: requests.ListBdsApiKeysRequest): AsyncIterableIterator<responses.ListBdsApiKeysResponse>;
275
+ /**
276
+ * Creates a new async iterator which will iterate over the models.BdsApiKeySummary objects
277
+ * contained in responses from the listBdsApiKeys operation. This iterator will fetch more data from the
278
+ * server as needed.
279
+ *
280
+ * @param request a request which can be sent to the service operation
281
+ */
282
+ listBdsApiKeysRecordIterator(request: requests.ListBdsApiKeysRequest): AsyncIterableIterator<model.BdsApiKeySummary>;
283
+ /**
284
+ * Creates a new async iterator which will iterate over the responses received from the listBdsApiKeys operation. This iterator
285
+ * will fetch more data from the server as needed.
286
+ *
287
+ * @param request a request which can be sent to the service operation
288
+ */
289
+ listBdsApiKeysResponseIterator(request: requests.ListBdsApiKeysRequest): AsyncIterableIterator<responses.ListBdsApiKeysResponse>;
205
290
  /**
206
291
  * Returns a list of all Big Data Service clusters in a compartment.
207
292
  *
293
+ * This operation does not retry by default if the user has not defined a retry configuration.
208
294
  * @param ListBdsInstancesRequest
209
295
  * @return ListBdsInstancesResponse
210
296
  * @throws OciError when an error occurs
211
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/ListBdsInstances.ts.html |here} to see how to use ListBdsInstances API.
297
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/ListBdsInstances.ts.html |here} to see how to use ListBdsInstances API.
212
298
  */
213
299
  listBdsInstances(listBdsInstancesRequest: requests.ListBdsInstancesRequest): Promise<responses.ListBdsInstancesResponse>;
214
300
  /**
@@ -246,10 +332,11 @@ export declare class BdsClient {
246
332
  /**
247
333
  * Returns a paginated list of errors for a work request identified by the given ID.
248
334
  *
335
+ * This operation does not retry by default if the user has not defined a retry configuration.
249
336
  * @param ListWorkRequestErrorsRequest
250
337
  * @return ListWorkRequestErrorsResponse
251
338
  * @throws OciError when an error occurs
252
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
339
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
253
340
  */
254
341
  listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
255
342
  /**
@@ -287,10 +374,11 @@ export declare class BdsClient {
287
374
  /**
288
375
  * Returns a paginated list of logs for a given work request.
289
376
  *
377
+ * This operation does not retry by default if the user has not defined a retry configuration.
290
378
  * @param ListWorkRequestLogsRequest
291
379
  * @return ListWorkRequestLogsResponse
292
380
  * @throws OciError when an error occurs
293
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
381
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
294
382
  */
295
383
  listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
296
384
  /**
@@ -328,10 +416,11 @@ export declare class BdsClient {
328
416
  /**
329
417
  * Lists the work requests in a compartment.
330
418
  *
419
+ * This operation does not retry by default if the user has not defined a retry configuration.
331
420
  * @param ListWorkRequestsRequest
332
421
  * @return ListWorkRequestsResponse
333
422
  * @throws OciError when an error occurs
334
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
423
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
335
424
  */
336
425
  listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
337
426
  /**
@@ -369,45 +458,59 @@ export declare class BdsClient {
369
458
  /**
370
459
  * Deletes an autoscale configuration.
371
460
  *
461
+ * This operation does not retry by default if the user has not defined a retry configuration.
372
462
  * @param RemoveAutoScalingConfigurationRequest
373
463
  * @return RemoveAutoScalingConfigurationResponse
374
464
  * @throws OciError when an error occurs
375
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/RemoveAutoScalingConfiguration.ts.html |here} to see how to use RemoveAutoScalingConfiguration API.
465
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/RemoveAutoScalingConfiguration.ts.html |here} to see how to use RemoveAutoScalingConfiguration API.
376
466
  */
377
467
  removeAutoScalingConfiguration(removeAutoScalingConfigurationRequest: requests.RemoveAutoScalingConfigurationRequest): Promise<responses.RemoveAutoScalingConfigurationResponse>;
378
468
  /**
379
469
  * Removes Cloud SQL from the cluster.
380
470
  *
471
+ * This operation does not retry by default if the user has not defined a retry configuration.
381
472
  * @param RemoveCloudSqlRequest
382
473
  * @return RemoveCloudSqlResponse
383
474
  * @throws OciError when an error occurs
384
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/RemoveCloudSql.ts.html |here} to see how to use RemoveCloudSql API.
475
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/RemoveCloudSql.ts.html |here} to see how to use RemoveCloudSql API.
385
476
  */
386
477
  removeCloudSql(removeCloudSqlRequest: requests.RemoveCloudSqlRequest): Promise<responses.RemoveCloudSqlResponse>;
387
478
  /**
388
479
  * Restarts a single node of a Big Data Service cluster
389
480
  *
481
+ * This operation does not retry by default if the user has not defined a retry configuration.
390
482
  * @param RestartNodeRequest
391
483
  * @return RestartNodeResponse
392
484
  * @throws OciError when an error occurs
393
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/RestartNode.ts.html |here} to see how to use RestartNode API.
485
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/RestartNode.ts.html |here} to see how to use RestartNode API.
394
486
  */
395
487
  restartNode(restartNodeRequest: requests.RestartNodeRequest): Promise<responses.RestartNodeResponse>;
488
+ /**
489
+ * Test access to specified Object Storage bucket using the API key.
490
+ * This operation does not retry by default if the user has not defined a retry configuration.
491
+ * @param TestBdsObjectStorageConnectionRequest
492
+ * @return TestBdsObjectStorageConnectionResponse
493
+ * @throws OciError when an error occurs
494
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/TestBdsObjectStorageConnection.ts.html |here} to see how to use TestBdsObjectStorageConnection API.
495
+ */
496
+ testBdsObjectStorageConnection(testBdsObjectStorageConnectionRequest: requests.TestBdsObjectStorageConnectionRequest): Promise<responses.TestBdsObjectStorageConnectionResponse>;
396
497
  /**
397
498
  * Updates fields on an autoscale configuration, including the name, the threshold value, and whether the autoscale configuration is enabled.
398
499
  *
500
+ * This operation does not retry by default if the user has not defined a retry configuration.
399
501
  * @param UpdateAutoScalingConfigurationRequest
400
502
  * @return UpdateAutoScalingConfigurationResponse
401
503
  * @throws OciError when an error occurs
402
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/UpdateAutoScalingConfiguration.ts.html |here} to see how to use UpdateAutoScalingConfiguration API.
504
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/UpdateAutoScalingConfiguration.ts.html |here} to see how to use UpdateAutoScalingConfiguration API.
403
505
  */
404
506
  updateAutoScalingConfiguration(updateAutoScalingConfigurationRequest: requests.UpdateAutoScalingConfigurationRequest): Promise<responses.UpdateAutoScalingConfigurationResponse>;
405
507
  /**
406
508
  * Updates the Big Data Service cluster identified by the given ID.
509
+ * This operation does not retry by default if the user has not defined a retry configuration.
407
510
  * @param UpdateBdsInstanceRequest
408
511
  * @return UpdateBdsInstanceResponse
409
512
  * @throws OciError when an error occurs
410
- * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.5.2/bds/UpdateBdsInstance.ts.html |here} to see how to use UpdateBdsInstance API.
513
+ * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/bds/UpdateBdsInstance.ts.html |here} to see how to use UpdateBdsInstance API.
411
514
  */
412
515
  updateBdsInstance(updateBdsInstanceRequest: requests.UpdateBdsInstanceRequest): Promise<responses.UpdateBdsInstanceResponse>;
413
516
  }