oci-analytics 2.4.0 → 2.6.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.
- package/LICENSE.txt +6 -0
- package/lib/client.d.ts +115 -22
- package/lib/client.js +182 -44
- package/lib/client.js.map +1 -1
- package/lib/request/change-analytics-instance-compartment-request.d.ts +1 -1
- package/lib/request/change-analytics-instance-network-endpoint-request.d.ts +1 -1
- package/lib/request/create-analytics-instance-request.d.ts +1 -1
- package/lib/request/create-private-access-channel-request.d.ts +1 -1
- package/lib/request/create-vanity-url-request.d.ts +1 -1
- package/lib/request/delete-analytics-instance-request.d.ts +1 -1
- package/lib/request/delete-private-access-channel-request.d.ts +1 -1
- package/lib/request/delete-vanity-url-request.d.ts +1 -1
- package/lib/request/delete-work-request-request.d.ts +1 -1
- package/lib/request/get-analytics-instance-request.d.ts +1 -1
- package/lib/request/get-private-access-channel-request.d.ts +1 -1
- package/lib/request/get-work-request-request.d.ts +1 -1
- package/lib/request/list-analytics-instances-request.d.ts +1 -1
- package/lib/request/list-work-request-errors-request.d.ts +1 -1
- package/lib/request/list-work-request-logs-request.d.ts +1 -1
- package/lib/request/list-work-requests-request.d.ts +1 -1
- package/lib/request/scale-analytics-instance-request.d.ts +1 -1
- package/lib/request/start-analytics-instance-request.d.ts +1 -1
- package/lib/request/stop-analytics-instance-request.d.ts +1 -1
- package/lib/request/update-analytics-instance-request.d.ts +1 -1
- package/lib/request/update-private-access-channel-request.d.ts +1 -1
- package/lib/request/update-vanity-url-request.d.ts +1 -1
- package/package.json +3 -3
package/LICENSE.txt
CHANGED
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
Copyright (c) 2016, 2018, Oracle and/or its affiliates. All rights reserved.
|
|
2
|
+
|
|
3
|
+
This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 or Apache License 2.0. See below for license terms. You may choose either license.
|
|
4
|
+
|
|
5
|
+
____________________________
|
|
6
|
+
|
|
1
7
|
The Universal Permissive License (UPL), Version 1.0
|
|
2
8
|
|
|
3
9
|
Subject to the condition set forth below, permission is hereby granted to any
|
package/lib/client.d.ts
CHANGED
|
@@ -18,6 +18,9 @@ import * as responses from "./response";
|
|
|
18
18
|
import { AnalyticsWaiter } from "./analytics-waiter";
|
|
19
19
|
export declare enum AnalyticsApiKeys {
|
|
20
20
|
}
|
|
21
|
+
/**
|
|
22
|
+
* This service client does not use circuit breakers by default if the user has not defined a circuit breaker configuration.
|
|
23
|
+
*/
|
|
21
24
|
export declare class AnalyticsClient {
|
|
22
25
|
protected static serviceEndpointTemplate: string;
|
|
23
26
|
protected "_endpoint": string;
|
|
@@ -69,126 +72,140 @@ export declare class AnalyticsClient {
|
|
|
69
72
|
* Change the compartment of an Analytics instance. The operation is long-running
|
|
70
73
|
* and creates a new WorkRequest.
|
|
71
74
|
*
|
|
75
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
72
76
|
* @param ChangeAnalyticsInstanceCompartmentRequest
|
|
73
77
|
* @return ChangeAnalyticsInstanceCompartmentResponse
|
|
74
78
|
* @throws OciError when an error occurs
|
|
75
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
79
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/ChangeAnalyticsInstanceCompartment.ts.html |here} to see how to use ChangeAnalyticsInstanceCompartment API.
|
|
76
80
|
*/
|
|
77
81
|
changeAnalyticsInstanceCompartment(changeAnalyticsInstanceCompartmentRequest: requests.ChangeAnalyticsInstanceCompartmentRequest): Promise<responses.ChangeAnalyticsInstanceCompartmentResponse>;
|
|
78
82
|
/**
|
|
79
83
|
* Change an Analytics instance network endpoint. The operation is long-running
|
|
80
84
|
* and creates a new WorkRequest.
|
|
81
85
|
*
|
|
86
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
82
87
|
* @param ChangeAnalyticsInstanceNetworkEndpointRequest
|
|
83
88
|
* @return ChangeAnalyticsInstanceNetworkEndpointResponse
|
|
84
89
|
* @throws OciError when an error occurs
|
|
85
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
90
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/ChangeAnalyticsInstanceNetworkEndpoint.ts.html |here} to see how to use ChangeAnalyticsInstanceNetworkEndpoint API.
|
|
86
91
|
*/
|
|
87
92
|
changeAnalyticsInstanceNetworkEndpoint(changeAnalyticsInstanceNetworkEndpointRequest: requests.ChangeAnalyticsInstanceNetworkEndpointRequest): Promise<responses.ChangeAnalyticsInstanceNetworkEndpointResponse>;
|
|
88
93
|
/**
|
|
89
94
|
* Create a new AnalyticsInstance in the specified compartment. The operation is long-running
|
|
90
95
|
* and creates a new WorkRequest.
|
|
91
96
|
*
|
|
97
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
92
98
|
* @param CreateAnalyticsInstanceRequest
|
|
93
99
|
* @return CreateAnalyticsInstanceResponse
|
|
94
100
|
* @throws OciError when an error occurs
|
|
95
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
101
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/CreateAnalyticsInstance.ts.html |here} to see how to use CreateAnalyticsInstance API.
|
|
96
102
|
*/
|
|
97
103
|
createAnalyticsInstance(createAnalyticsInstanceRequest: requests.CreateAnalyticsInstanceRequest): Promise<responses.CreateAnalyticsInstanceResponse>;
|
|
98
104
|
/**
|
|
99
105
|
* Create an Private access Channel for the Analytics instance. The operation is long-running
|
|
100
106
|
* and creates a new WorkRequest.
|
|
101
107
|
*
|
|
108
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
102
109
|
* @param CreatePrivateAccessChannelRequest
|
|
103
110
|
* @return CreatePrivateAccessChannelResponse
|
|
104
111
|
* @throws OciError when an error occurs
|
|
105
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
112
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/CreatePrivateAccessChannel.ts.html |here} to see how to use CreatePrivateAccessChannel API.
|
|
106
113
|
*/
|
|
107
114
|
createPrivateAccessChannel(createPrivateAccessChannelRequest: requests.CreatePrivateAccessChannelRequest): Promise<responses.CreatePrivateAccessChannelResponse>;
|
|
108
115
|
/**
|
|
109
116
|
* Allows specifying a custom host name to be used to access the analytics instance. This requires prior setup of DNS entry and certificate
|
|
110
117
|
* for this host.
|
|
111
118
|
*
|
|
119
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
112
120
|
* @param CreateVanityUrlRequest
|
|
113
121
|
* @return CreateVanityUrlResponse
|
|
114
122
|
* @throws OciError when an error occurs
|
|
115
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
123
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/CreateVanityUrl.ts.html |here} to see how to use CreateVanityUrl API.
|
|
116
124
|
*/
|
|
117
125
|
createVanityUrl(createVanityUrlRequest: requests.CreateVanityUrlRequest): Promise<responses.CreateVanityUrlResponse>;
|
|
118
126
|
/**
|
|
119
127
|
* Terminates the specified Analytics instance. The operation is long-running
|
|
120
128
|
* and creates a new WorkRequest.
|
|
121
129
|
*
|
|
130
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
122
131
|
* @param DeleteAnalyticsInstanceRequest
|
|
123
132
|
* @return DeleteAnalyticsInstanceResponse
|
|
124
133
|
* @throws OciError when an error occurs
|
|
125
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
134
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/DeleteAnalyticsInstance.ts.html |here} to see how to use DeleteAnalyticsInstance API.
|
|
126
135
|
*/
|
|
127
136
|
deleteAnalyticsInstance(deleteAnalyticsInstanceRequest: requests.DeleteAnalyticsInstanceRequest): Promise<responses.DeleteAnalyticsInstanceResponse>;
|
|
128
137
|
/**
|
|
129
138
|
* Delete an Analytics instance's Private access channel with the given unique identifier key.
|
|
130
139
|
*
|
|
140
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
131
141
|
* @param DeletePrivateAccessChannelRequest
|
|
132
142
|
* @return DeletePrivateAccessChannelResponse
|
|
133
143
|
* @throws OciError when an error occurs
|
|
134
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
144
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/DeletePrivateAccessChannel.ts.html |here} to see how to use DeletePrivateAccessChannel API.
|
|
135
145
|
*/
|
|
136
146
|
deletePrivateAccessChannel(deletePrivateAccessChannelRequest: requests.DeletePrivateAccessChannelRequest): Promise<responses.DeletePrivateAccessChannelResponse>;
|
|
137
147
|
/**
|
|
138
148
|
* Allows deleting a previously created vanity url.
|
|
139
149
|
*
|
|
150
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
140
151
|
* @param DeleteVanityUrlRequest
|
|
141
152
|
* @return DeleteVanityUrlResponse
|
|
142
153
|
* @throws OciError when an error occurs
|
|
143
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
154
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/DeleteVanityUrl.ts.html |here} to see how to use DeleteVanityUrl API.
|
|
144
155
|
*/
|
|
145
156
|
deleteVanityUrl(deleteVanityUrlRequest: requests.DeleteVanityUrlRequest): Promise<responses.DeleteVanityUrlResponse>;
|
|
146
157
|
/**
|
|
147
158
|
* Cancel a work request that has not started yet.
|
|
148
159
|
*
|
|
160
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
149
161
|
* @param DeleteWorkRequestRequest
|
|
150
162
|
* @return DeleteWorkRequestResponse
|
|
151
163
|
* @throws OciError when an error occurs
|
|
152
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
164
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/DeleteWorkRequest.ts.html |here} to see how to use DeleteWorkRequest API.
|
|
153
165
|
*/
|
|
154
166
|
deleteWorkRequest(deleteWorkRequestRequest: requests.DeleteWorkRequestRequest): Promise<responses.DeleteWorkRequestResponse>;
|
|
155
167
|
/**
|
|
156
168
|
* Info for a specific Analytics instance.
|
|
157
169
|
*
|
|
170
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
158
171
|
* @param GetAnalyticsInstanceRequest
|
|
159
172
|
* @return GetAnalyticsInstanceResponse
|
|
160
173
|
* @throws OciError when an error occurs
|
|
161
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
174
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/GetAnalyticsInstance.ts.html |here} to see how to use GetAnalyticsInstance API.
|
|
162
175
|
*/
|
|
163
176
|
getAnalyticsInstance(getAnalyticsInstanceRequest: requests.GetAnalyticsInstanceRequest): Promise<responses.GetAnalyticsInstanceResponse>;
|
|
164
177
|
/**
|
|
165
178
|
* Retrieve private access channel in the specified Analytics Instance.
|
|
166
179
|
*
|
|
180
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
167
181
|
* @param GetPrivateAccessChannelRequest
|
|
168
182
|
* @return GetPrivateAccessChannelResponse
|
|
169
183
|
* @throws OciError when an error occurs
|
|
170
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
184
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/GetPrivateAccessChannel.ts.html |here} to see how to use GetPrivateAccessChannel API.
|
|
171
185
|
*/
|
|
172
186
|
getPrivateAccessChannel(getPrivateAccessChannelRequest: requests.GetPrivateAccessChannelRequest): Promise<responses.GetPrivateAccessChannelResponse>;
|
|
173
187
|
/**
|
|
174
188
|
* Get the details of a work request.
|
|
175
189
|
*
|
|
190
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
176
191
|
* @param GetWorkRequestRequest
|
|
177
192
|
* @return GetWorkRequestResponse
|
|
178
193
|
* @throws OciError when an error occurs
|
|
179
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
194
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
|
|
180
195
|
*/
|
|
181
196
|
getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
|
|
182
197
|
/**
|
|
183
198
|
* List Analytics instances.
|
|
184
199
|
*
|
|
200
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
185
201
|
* @param ListAnalyticsInstancesRequest
|
|
186
202
|
* @return ListAnalyticsInstancesResponse
|
|
187
203
|
* @throws OciError when an error occurs
|
|
188
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
204
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/ListAnalyticsInstances.ts.html |here} to see how to use ListAnalyticsInstances API.
|
|
189
205
|
*/
|
|
190
206
|
listAnalyticsInstances(listAnalyticsInstancesRequest: requests.ListAnalyticsInstancesRequest): Promise<responses.ListAnalyticsInstancesResponse>;
|
|
191
207
|
/**
|
|
208
|
+
* NOTE: This function is deprecated in favor of listAnalyticsInstancesRecordIterator function.
|
|
192
209
|
* Creates a new async iterator which will iterate over the models.AnalyticsInstanceSummary objects
|
|
193
210
|
* contained in responses from the listAnalyticsInstances operation. This iterator will fetch more data from the
|
|
194
211
|
* server as needed.
|
|
@@ -197,22 +214,40 @@ export declare class AnalyticsClient {
|
|
|
197
214
|
*/
|
|
198
215
|
listAllAnalyticsInstances(request: requests.ListAnalyticsInstancesRequest): AsyncIterableIterator<model.AnalyticsInstanceSummary>;
|
|
199
216
|
/**
|
|
217
|
+
* NOTE: This function is deprecated in favor of listAnalyticsInstancesResponseIterator function.
|
|
200
218
|
* Creates a new async iterator which will iterate over the responses received from the listAnalyticsInstances operation. This iterator
|
|
201
219
|
* will fetch more data from the server as needed.
|
|
202
220
|
*
|
|
203
221
|
* @param request a request which can be sent to the service operation
|
|
204
222
|
*/
|
|
205
223
|
listAllAnalyticsInstancesResponses(request: requests.ListAnalyticsInstancesRequest): AsyncIterableIterator<responses.ListAnalyticsInstancesResponse>;
|
|
224
|
+
/**
|
|
225
|
+
* Creates a new async iterator which will iterate over the models.AnalyticsInstanceSummary objects
|
|
226
|
+
* contained in responses from the listAnalyticsInstances operation. This iterator will fetch more data from the
|
|
227
|
+
* server as needed.
|
|
228
|
+
*
|
|
229
|
+
* @param request a request which can be sent to the service operation
|
|
230
|
+
*/
|
|
231
|
+
listAnalyticsInstancesRecordIterator(request: requests.ListAnalyticsInstancesRequest): AsyncIterableIterator<model.AnalyticsInstanceSummary>;
|
|
232
|
+
/**
|
|
233
|
+
* Creates a new async iterator which will iterate over the responses received from the listAnalyticsInstances operation. This iterator
|
|
234
|
+
* will fetch more data from the server as needed.
|
|
235
|
+
*
|
|
236
|
+
* @param request a request which can be sent to the service operation
|
|
237
|
+
*/
|
|
238
|
+
listAnalyticsInstancesResponseIterator(request: requests.ListAnalyticsInstancesRequest): AsyncIterableIterator<responses.ListAnalyticsInstancesResponse>;
|
|
206
239
|
/**
|
|
207
240
|
* Get the errors of a work request.
|
|
208
241
|
*
|
|
242
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
209
243
|
* @param ListWorkRequestErrorsRequest
|
|
210
244
|
* @return ListWorkRequestErrorsResponse
|
|
211
245
|
* @throws OciError when an error occurs
|
|
212
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
246
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
|
|
213
247
|
*/
|
|
214
248
|
listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
|
|
215
249
|
/**
|
|
250
|
+
* NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function.
|
|
216
251
|
* Creates a new async iterator which will iterate over the models.WorkRequestError objects
|
|
217
252
|
* contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the
|
|
218
253
|
* server as needed.
|
|
@@ -221,22 +256,40 @@ export declare class AnalyticsClient {
|
|
|
221
256
|
*/
|
|
222
257
|
listAllWorkRequestErrors(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator<model.WorkRequestError>;
|
|
223
258
|
/**
|
|
259
|
+
* NOTE: This function is deprecated in favor of listWorkRequestErrorsResponseIterator function.
|
|
224
260
|
* Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator
|
|
225
261
|
* will fetch more data from the server as needed.
|
|
226
262
|
*
|
|
227
263
|
* @param request a request which can be sent to the service operation
|
|
228
264
|
*/
|
|
229
265
|
listAllWorkRequestErrorsResponses(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator<responses.ListWorkRequestErrorsResponse>;
|
|
266
|
+
/**
|
|
267
|
+
* Creates a new async iterator which will iterate over the models.WorkRequestError objects
|
|
268
|
+
* contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the
|
|
269
|
+
* server as needed.
|
|
270
|
+
*
|
|
271
|
+
* @param request a request which can be sent to the service operation
|
|
272
|
+
*/
|
|
273
|
+
listWorkRequestErrorsRecordIterator(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator<model.WorkRequestError>;
|
|
274
|
+
/**
|
|
275
|
+
* Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator
|
|
276
|
+
* will fetch more data from the server as needed.
|
|
277
|
+
*
|
|
278
|
+
* @param request a request which can be sent to the service operation
|
|
279
|
+
*/
|
|
280
|
+
listWorkRequestErrorsResponseIterator(request: requests.ListWorkRequestErrorsRequest): AsyncIterableIterator<responses.ListWorkRequestErrorsResponse>;
|
|
230
281
|
/**
|
|
231
282
|
* Get the logs of a work request.
|
|
232
283
|
*
|
|
284
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
233
285
|
* @param ListWorkRequestLogsRequest
|
|
234
286
|
* @return ListWorkRequestLogsResponse
|
|
235
287
|
* @throws OciError when an error occurs
|
|
236
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
288
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
|
|
237
289
|
*/
|
|
238
290
|
listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
|
|
239
291
|
/**
|
|
292
|
+
* NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function.
|
|
240
293
|
* Creates a new async iterator which will iterate over the models.WorkRequestLog objects
|
|
241
294
|
* contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the
|
|
242
295
|
* server as needed.
|
|
@@ -245,22 +298,40 @@ export declare class AnalyticsClient {
|
|
|
245
298
|
*/
|
|
246
299
|
listAllWorkRequestLogs(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator<model.WorkRequestLog>;
|
|
247
300
|
/**
|
|
301
|
+
* NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function.
|
|
248
302
|
* Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator
|
|
249
303
|
* will fetch more data from the server as needed.
|
|
250
304
|
*
|
|
251
305
|
* @param request a request which can be sent to the service operation
|
|
252
306
|
*/
|
|
253
307
|
listAllWorkRequestLogsResponses(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator<responses.ListWorkRequestLogsResponse>;
|
|
308
|
+
/**
|
|
309
|
+
* Creates a new async iterator which will iterate over the models.WorkRequestLog objects
|
|
310
|
+
* contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the
|
|
311
|
+
* server as needed.
|
|
312
|
+
*
|
|
313
|
+
* @param request a request which can be sent to the service operation
|
|
314
|
+
*/
|
|
315
|
+
listWorkRequestLogsRecordIterator(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator<model.WorkRequestLog>;
|
|
316
|
+
/**
|
|
317
|
+
* Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator
|
|
318
|
+
* will fetch more data from the server as needed.
|
|
319
|
+
*
|
|
320
|
+
* @param request a request which can be sent to the service operation
|
|
321
|
+
*/
|
|
322
|
+
listWorkRequestLogsResponseIterator(request: requests.ListWorkRequestLogsRequest): AsyncIterableIterator<responses.ListWorkRequestLogsResponse>;
|
|
254
323
|
/**
|
|
255
324
|
* List all work requests in a compartment.
|
|
256
325
|
*
|
|
326
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
257
327
|
* @param ListWorkRequestsRequest
|
|
258
328
|
* @return ListWorkRequestsResponse
|
|
259
329
|
* @throws OciError when an error occurs
|
|
260
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
330
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
|
|
261
331
|
*/
|
|
262
332
|
listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
|
|
263
333
|
/**
|
|
334
|
+
* NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function.
|
|
264
335
|
* Creates a new async iterator which will iterate over the models.WorkRequestSummary objects
|
|
265
336
|
* contained in responses from the listWorkRequests operation. This iterator will fetch more data from the
|
|
266
337
|
* server as needed.
|
|
@@ -269,68 +340,90 @@ export declare class AnalyticsClient {
|
|
|
269
340
|
*/
|
|
270
341
|
listAllWorkRequests(request: requests.ListWorkRequestsRequest): AsyncIterableIterator<model.WorkRequestSummary>;
|
|
271
342
|
/**
|
|
343
|
+
* NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function.
|
|
272
344
|
* Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator
|
|
273
345
|
* will fetch more data from the server as needed.
|
|
274
346
|
*
|
|
275
347
|
* @param request a request which can be sent to the service operation
|
|
276
348
|
*/
|
|
277
349
|
listAllWorkRequestsResponses(request: requests.ListWorkRequestsRequest): AsyncIterableIterator<responses.ListWorkRequestsResponse>;
|
|
350
|
+
/**
|
|
351
|
+
* Creates a new async iterator which will iterate over the models.WorkRequestSummary objects
|
|
352
|
+
* contained in responses from the listWorkRequests operation. This iterator will fetch more data from the
|
|
353
|
+
* server as needed.
|
|
354
|
+
*
|
|
355
|
+
* @param request a request which can be sent to the service operation
|
|
356
|
+
*/
|
|
357
|
+
listWorkRequestsRecordIterator(request: requests.ListWorkRequestsRequest): AsyncIterableIterator<model.WorkRequestSummary>;
|
|
358
|
+
/**
|
|
359
|
+
* Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator
|
|
360
|
+
* will fetch more data from the server as needed.
|
|
361
|
+
*
|
|
362
|
+
* @param request a request which can be sent to the service operation
|
|
363
|
+
*/
|
|
364
|
+
listWorkRequestsResponseIterator(request: requests.ListWorkRequestsRequest): AsyncIterableIterator<responses.ListWorkRequestsResponse>;
|
|
278
365
|
/**
|
|
279
366
|
* Scale an Analytics instance up or down. The operation is long-running
|
|
280
367
|
* and creates a new WorkRequest.
|
|
281
368
|
*
|
|
369
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
282
370
|
* @param ScaleAnalyticsInstanceRequest
|
|
283
371
|
* @return ScaleAnalyticsInstanceResponse
|
|
284
372
|
* @throws OciError when an error occurs
|
|
285
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
373
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/ScaleAnalyticsInstance.ts.html |here} to see how to use ScaleAnalyticsInstance API.
|
|
286
374
|
*/
|
|
287
375
|
scaleAnalyticsInstance(scaleAnalyticsInstanceRequest: requests.ScaleAnalyticsInstanceRequest): Promise<responses.ScaleAnalyticsInstanceResponse>;
|
|
288
376
|
/**
|
|
289
377
|
* Starts the specified Analytics instance. The operation is long-running
|
|
290
378
|
* and creates a new WorkRequest.
|
|
291
379
|
*
|
|
380
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
292
381
|
* @param StartAnalyticsInstanceRequest
|
|
293
382
|
* @return StartAnalyticsInstanceResponse
|
|
294
383
|
* @throws OciError when an error occurs
|
|
295
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
384
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/StartAnalyticsInstance.ts.html |here} to see how to use StartAnalyticsInstance API.
|
|
296
385
|
*/
|
|
297
386
|
startAnalyticsInstance(startAnalyticsInstanceRequest: requests.StartAnalyticsInstanceRequest): Promise<responses.StartAnalyticsInstanceResponse>;
|
|
298
387
|
/**
|
|
299
388
|
* Stop the specified Analytics instance. The operation is long-running
|
|
300
389
|
* and creates a new WorkRequest.
|
|
301
390
|
*
|
|
391
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
302
392
|
* @param StopAnalyticsInstanceRequest
|
|
303
393
|
* @return StopAnalyticsInstanceResponse
|
|
304
394
|
* @throws OciError when an error occurs
|
|
305
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
395
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/StopAnalyticsInstance.ts.html |here} to see how to use StopAnalyticsInstance API.
|
|
306
396
|
*/
|
|
307
397
|
stopAnalyticsInstance(stopAnalyticsInstanceRequest: requests.StopAnalyticsInstanceRequest): Promise<responses.StopAnalyticsInstanceResponse>;
|
|
308
398
|
/**
|
|
309
399
|
* Updates certain fields of an Analytics instance. Fields that are not provided in the
|
|
310
400
|
* request will not be updated.
|
|
311
401
|
*
|
|
402
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
312
403
|
* @param UpdateAnalyticsInstanceRequest
|
|
313
404
|
* @return UpdateAnalyticsInstanceResponse
|
|
314
405
|
* @throws OciError when an error occurs
|
|
315
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
406
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/UpdateAnalyticsInstance.ts.html |here} to see how to use UpdateAnalyticsInstance API.
|
|
316
407
|
*/
|
|
317
408
|
updateAnalyticsInstance(updateAnalyticsInstanceRequest: requests.UpdateAnalyticsInstanceRequest): Promise<responses.UpdateAnalyticsInstanceResponse>;
|
|
318
409
|
/**
|
|
319
410
|
* Update the Private Access Channel with the given unique identifier key in the specified Analytics Instance.
|
|
320
411
|
*
|
|
412
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
321
413
|
* @param UpdatePrivateAccessChannelRequest
|
|
322
414
|
* @return UpdatePrivateAccessChannelResponse
|
|
323
415
|
* @throws OciError when an error occurs
|
|
324
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
416
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/UpdatePrivateAccessChannel.ts.html |here} to see how to use UpdatePrivateAccessChannel API.
|
|
325
417
|
*/
|
|
326
418
|
updatePrivateAccessChannel(updatePrivateAccessChannelRequest: requests.UpdatePrivateAccessChannelRequest): Promise<responses.UpdatePrivateAccessChannelResponse>;
|
|
327
419
|
/**
|
|
328
420
|
* Allows uploading a new certificate for a vanity url, which will have to be done when the current certificate is expiring.
|
|
329
421
|
*
|
|
422
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
330
423
|
* @param UpdateVanityUrlRequest
|
|
331
424
|
* @return UpdateVanityUrlResponse
|
|
332
425
|
* @throws OciError when an error occurs
|
|
333
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
426
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.6.0/analytics/UpdateVanityUrl.ts.html |here} to see how to use UpdateVanityUrl API.
|
|
334
427
|
*/
|
|
335
428
|
updateVanityUrl(updateVanityUrlRequest: requests.UpdateVanityUrlRequest): Promise<responses.UpdateVanityUrlResponse>;
|
|
336
429
|
}
|