oci-apigateway 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.
- package/lib/client.d.ts +88 -38
- package/lib/client.js +192 -76
- package/lib/client.js.map +1 -1
- package/lib/request/cancel-work-request-request.d.ts +1 -1
- package/lib/request/change-api-compartment-request.d.ts +1 -1
- package/lib/request/change-certificate-compartment-request.d.ts +1 -1
- package/lib/request/change-deployment-compartment-request.d.ts +1 -1
- package/lib/request/change-gateway-compartment-request.d.ts +1 -1
- package/lib/request/create-api-request.d.ts +1 -1
- package/lib/request/create-certificate-request.d.ts +1 -1
- package/lib/request/create-deployment-request.d.ts +1 -1
- package/lib/request/create-gateway-request.d.ts +1 -1
- package/lib/request/create-sdk-request.d.ts +1 -1
- package/lib/request/delete-api-request.d.ts +1 -1
- package/lib/request/delete-certificate-request.d.ts +1 -1
- package/lib/request/delete-deployment-request.d.ts +1 -1
- package/lib/request/delete-gateway-request.d.ts +1 -1
- package/lib/request/delete-sdk-request.d.ts +1 -1
- package/lib/request/get-api-content-request.d.ts +1 -1
- package/lib/request/get-api-deployment-specification-request.d.ts +1 -1
- package/lib/request/get-api-request.d.ts +1 -1
- package/lib/request/get-api-validations-request.d.ts +1 -1
- package/lib/request/get-certificate-request.d.ts +1 -1
- package/lib/request/get-deployment-request.d.ts +1 -1
- package/lib/request/get-gateway-request.d.ts +1 -1
- package/lib/request/get-sdk-request.d.ts +1 -1
- package/lib/request/get-work-request-request.d.ts +1 -1
- package/lib/request/list-apis-request.d.ts +1 -1
- package/lib/request/list-certificates-request.d.ts +1 -1
- package/lib/request/list-deployments-request.d.ts +1 -1
- package/lib/request/list-gateways-request.d.ts +1 -1
- package/lib/request/list-sdk-language-types-request.d.ts +1 -1
- package/lib/request/list-sdks-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/update-api-request.d.ts +1 -1
- package/lib/request/update-certificate-request.d.ts +1 -1
- package/lib/request/update-deployment-request.d.ts +1 -1
- package/lib/request/update-gateway-request.d.ts +1 -1
- package/lib/request/update-sdk-request.d.ts +1 -1
- package/package.json +3 -3
package/lib/client.d.ts
CHANGED
|
@@ -22,6 +22,9 @@ import { GatewayWaiter } from "./gateway-waiter";
|
|
|
22
22
|
import { WorkRequestsWaiter } from "./workrequests-waiter";
|
|
23
23
|
export declare enum ApiGatewayApiKeys {
|
|
24
24
|
}
|
|
25
|
+
/**
|
|
26
|
+
* This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
|
|
27
|
+
*/
|
|
25
28
|
export declare class ApiGatewayClient {
|
|
26
29
|
protected static serviceEndpointTemplate: string;
|
|
27
30
|
protected "_endpoint": string;
|
|
@@ -71,179 +74,203 @@ export declare class ApiGatewayClient {
|
|
|
71
74
|
getWaiters(): ApiGatewayWaiter;
|
|
72
75
|
/**
|
|
73
76
|
* Changes the API compartment.
|
|
77
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
74
78
|
* @param ChangeApiCompartmentRequest
|
|
75
79
|
* @return ChangeApiCompartmentResponse
|
|
76
80
|
* @throws OciError when an error occurs
|
|
77
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
81
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/ChangeApiCompartment.ts.html |here} to see how to use ChangeApiCompartment API.
|
|
78
82
|
*/
|
|
79
83
|
changeApiCompartment(changeApiCompartmentRequest: requests.ChangeApiCompartmentRequest): Promise<responses.ChangeApiCompartmentResponse>;
|
|
80
84
|
/**
|
|
81
85
|
* Changes the certificate compartment.
|
|
86
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
82
87
|
* @param ChangeCertificateCompartmentRequest
|
|
83
88
|
* @return ChangeCertificateCompartmentResponse
|
|
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.8.0/apigateway/ChangeCertificateCompartment.ts.html |here} to see how to use ChangeCertificateCompartment API.
|
|
86
91
|
*/
|
|
87
92
|
changeCertificateCompartment(changeCertificateCompartmentRequest: requests.ChangeCertificateCompartmentRequest): Promise<responses.ChangeCertificateCompartmentResponse>;
|
|
88
93
|
/**
|
|
89
94
|
* Creates a new API.
|
|
90
95
|
*
|
|
96
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
91
97
|
* @param CreateApiRequest
|
|
92
98
|
* @return CreateApiResponse
|
|
93
99
|
* @throws OciError when an error occurs
|
|
94
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
100
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/CreateApi.ts.html |here} to see how to use CreateApi API.
|
|
95
101
|
*/
|
|
96
102
|
createApi(createApiRequest: requests.CreateApiRequest): Promise<responses.CreateApiResponse>;
|
|
97
103
|
/**
|
|
98
104
|
* Creates a new Certificate.
|
|
99
105
|
*
|
|
106
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
100
107
|
* @param CreateCertificateRequest
|
|
101
108
|
* @return CreateCertificateResponse
|
|
102
109
|
* @throws OciError when an error occurs
|
|
103
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
110
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/CreateCertificate.ts.html |here} to see how to use CreateCertificate API.
|
|
104
111
|
*/
|
|
105
112
|
createCertificate(createCertificateRequest: requests.CreateCertificateRequest): Promise<responses.CreateCertificateResponse>;
|
|
106
113
|
/**
|
|
107
114
|
* Creates a new SDK.
|
|
115
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
108
116
|
* @param CreateSdkRequest
|
|
109
117
|
* @return CreateSdkResponse
|
|
110
118
|
* @throws OciError when an error occurs
|
|
111
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
119
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/CreateSdk.ts.html |here} to see how to use CreateSdk API.
|
|
112
120
|
*/
|
|
113
121
|
createSdk(createSdkRequest: requests.CreateSdkRequest): Promise<responses.CreateSdkResponse>;
|
|
114
122
|
/**
|
|
115
123
|
* Deletes the API with the given identifier.
|
|
124
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
116
125
|
* @param DeleteApiRequest
|
|
117
126
|
* @return DeleteApiResponse
|
|
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.
|
|
128
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/DeleteApi.ts.html |here} to see how to use DeleteApi API.
|
|
120
129
|
*/
|
|
121
130
|
deleteApi(deleteApiRequest: requests.DeleteApiRequest): Promise<responses.DeleteApiResponse>;
|
|
122
131
|
/**
|
|
123
132
|
* Deletes the certificate with the given identifier.
|
|
133
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
124
134
|
* @param DeleteCertificateRequest
|
|
125
135
|
* @return DeleteCertificateResponse
|
|
126
136
|
* @throws OciError when an error occurs
|
|
127
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
137
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/DeleteCertificate.ts.html |here} to see how to use DeleteCertificate API.
|
|
128
138
|
*/
|
|
129
139
|
deleteCertificate(deleteCertificateRequest: requests.DeleteCertificateRequest): Promise<responses.DeleteCertificateResponse>;
|
|
130
140
|
/**
|
|
131
141
|
* Deletes provided SDK.
|
|
142
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
132
143
|
* @param DeleteSdkRequest
|
|
133
144
|
* @return DeleteSdkResponse
|
|
134
145
|
* @throws OciError when an error occurs
|
|
135
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
146
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/DeleteSdk.ts.html |here} to see how to use DeleteSdk API.
|
|
136
147
|
*/
|
|
137
148
|
deleteSdk(deleteSdkRequest: requests.DeleteSdkRequest): Promise<responses.DeleteSdkResponse>;
|
|
138
149
|
/**
|
|
139
150
|
* Gets an API by identifier.
|
|
151
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
140
152
|
* @param GetApiRequest
|
|
141
153
|
* @return GetApiResponse
|
|
142
154
|
* @throws OciError when an error occurs
|
|
143
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
155
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/GetApi.ts.html |here} to see how to use GetApi API.
|
|
144
156
|
*/
|
|
145
157
|
getApi(getApiRequest: requests.GetApiRequest): Promise<responses.GetApiResponse>;
|
|
146
158
|
/**
|
|
147
159
|
* Get the raw API content.
|
|
160
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
148
161
|
* @param GetApiContentRequest
|
|
149
162
|
* @return GetApiContentResponse
|
|
150
163
|
* @throws OciError when an error occurs
|
|
151
|
-
* @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.8.0/apigateway/GetApiContent.ts.html |here} to see how to use GetApiContent API.
|
|
152
165
|
*/
|
|
153
166
|
getApiContent(getApiContentRequest: requests.GetApiContentRequest): Promise<responses.GetApiContentResponse>;
|
|
154
167
|
/**
|
|
155
168
|
* Gets an API Deployment specification by identifier.
|
|
169
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
156
170
|
* @param GetApiDeploymentSpecificationRequest
|
|
157
171
|
* @return GetApiDeploymentSpecificationResponse
|
|
158
172
|
* @throws OciError when an error occurs
|
|
159
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
173
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/GetApiDeploymentSpecification.ts.html |here} to see how to use GetApiDeploymentSpecification API.
|
|
160
174
|
*/
|
|
161
175
|
getApiDeploymentSpecification(getApiDeploymentSpecificationRequest: requests.GetApiDeploymentSpecificationRequest): Promise<responses.GetApiDeploymentSpecificationResponse>;
|
|
162
176
|
/**
|
|
163
177
|
* Gets the API validation results.
|
|
178
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
164
179
|
* @param GetApiValidationsRequest
|
|
165
180
|
* @return GetApiValidationsResponse
|
|
166
181
|
* @throws OciError when an error occurs
|
|
167
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
182
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/GetApiValidations.ts.html |here} to see how to use GetApiValidations API.
|
|
168
183
|
*/
|
|
169
184
|
getApiValidations(getApiValidationsRequest: requests.GetApiValidationsRequest): Promise<responses.GetApiValidationsResponse>;
|
|
170
185
|
/**
|
|
171
186
|
* Gets a certificate by identifier.
|
|
187
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
172
188
|
* @param GetCertificateRequest
|
|
173
189
|
* @return GetCertificateResponse
|
|
174
190
|
* @throws OciError when an error occurs
|
|
175
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
191
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/GetCertificate.ts.html |here} to see how to use GetCertificate API.
|
|
176
192
|
*/
|
|
177
193
|
getCertificate(getCertificateRequest: requests.GetCertificateRequest): Promise<responses.GetCertificateResponse>;
|
|
178
194
|
/**
|
|
179
195
|
* Return object store downloadable URL and metadata.
|
|
196
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
180
197
|
* @param GetSdkRequest
|
|
181
198
|
* @return GetSdkResponse
|
|
182
199
|
* @throws OciError when an error occurs
|
|
183
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
200
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/GetSdk.ts.html |here} to see how to use GetSdk API.
|
|
184
201
|
*/
|
|
185
202
|
getSdk(getSdkRequest: requests.GetSdkRequest): Promise<responses.GetSdkResponse>;
|
|
186
203
|
/**
|
|
187
204
|
* Returns a list of APIs.
|
|
188
205
|
*
|
|
206
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
189
207
|
* @param ListApisRequest
|
|
190
208
|
* @return ListApisResponse
|
|
191
209
|
* @throws OciError when an error occurs
|
|
192
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
210
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/ListApis.ts.html |here} to see how to use ListApis API.
|
|
193
211
|
*/
|
|
194
212
|
listApis(listApisRequest: requests.ListApisRequest): Promise<responses.ListApisResponse>;
|
|
195
213
|
/**
|
|
196
214
|
* Returns a list of certificates.
|
|
197
215
|
*
|
|
216
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
198
217
|
* @param ListCertificatesRequest
|
|
199
218
|
* @return ListCertificatesResponse
|
|
200
219
|
* @throws OciError when an error occurs
|
|
201
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
220
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/ListCertificates.ts.html |here} to see how to use ListCertificates API.
|
|
202
221
|
*/
|
|
203
222
|
listCertificates(listCertificatesRequest: requests.ListCertificatesRequest): Promise<responses.ListCertificatesResponse>;
|
|
204
223
|
/**
|
|
205
224
|
* Lists programming languages in which SDK can be generated.
|
|
225
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
206
226
|
* @param ListSdkLanguageTypesRequest
|
|
207
227
|
* @return ListSdkLanguageTypesResponse
|
|
208
228
|
* @throws OciError when an error occurs
|
|
209
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
229
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/ListSdkLanguageTypes.ts.html |here} to see how to use ListSdkLanguageTypes API.
|
|
210
230
|
*/
|
|
211
231
|
listSdkLanguageTypes(listSdkLanguageTypesRequest: requests.ListSdkLanguageTypesRequest): Promise<responses.ListSdkLanguageTypesResponse>;
|
|
212
232
|
/**
|
|
213
233
|
* Returns list of generated SDKs.
|
|
234
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
214
235
|
* @param ListSdksRequest
|
|
215
236
|
* @return ListSdksResponse
|
|
216
237
|
* @throws OciError when an error occurs
|
|
217
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
238
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/ListSdks.ts.html |here} to see how to use ListSdks API.
|
|
218
239
|
*/
|
|
219
240
|
listSdks(listSdksRequest: requests.ListSdksRequest): Promise<responses.ListSdksResponse>;
|
|
220
241
|
/**
|
|
221
242
|
* Updates the API with the given identifier.
|
|
243
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
222
244
|
* @param UpdateApiRequest
|
|
223
245
|
* @return UpdateApiResponse
|
|
224
246
|
* @throws OciError when an error occurs
|
|
225
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
247
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/UpdateApi.ts.html |here} to see how to use UpdateApi API.
|
|
226
248
|
*/
|
|
227
249
|
updateApi(updateApiRequest: requests.UpdateApiRequest): Promise<responses.UpdateApiResponse>;
|
|
228
250
|
/**
|
|
229
251
|
* Updates a certificate with the given identifier
|
|
252
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
230
253
|
* @param UpdateCertificateRequest
|
|
231
254
|
* @return UpdateCertificateResponse
|
|
232
255
|
* @throws OciError when an error occurs
|
|
233
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
256
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/UpdateCertificate.ts.html |here} to see how to use UpdateCertificate API.
|
|
234
257
|
*/
|
|
235
258
|
updateCertificate(updateCertificateRequest: requests.UpdateCertificateRequest): Promise<responses.UpdateCertificateResponse>;
|
|
236
259
|
/**
|
|
237
260
|
* Updates the SDK with the given identifier.
|
|
261
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
238
262
|
* @param UpdateSdkRequest
|
|
239
263
|
* @return UpdateSdkResponse
|
|
240
264
|
* @throws OciError when an error occurs
|
|
241
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
265
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/UpdateSdk.ts.html |here} to see how to use UpdateSdk API.
|
|
242
266
|
*/
|
|
243
267
|
updateSdk(updateSdkRequest: requests.UpdateSdkRequest): Promise<responses.UpdateSdkResponse>;
|
|
244
268
|
}
|
|
245
269
|
export declare enum DeploymentApiKeys {
|
|
246
270
|
}
|
|
271
|
+
/**
|
|
272
|
+
* This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
|
|
273
|
+
*/
|
|
247
274
|
export declare class DeploymentClient {
|
|
248
275
|
protected static serviceEndpointTemplate: string;
|
|
249
276
|
protected "_endpoint": string;
|
|
@@ -293,57 +320,66 @@ export declare class DeploymentClient {
|
|
|
293
320
|
getWaiters(): DeploymentWaiter;
|
|
294
321
|
/**
|
|
295
322
|
* Changes the deployment compartment.
|
|
323
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
296
324
|
* @param ChangeDeploymentCompartmentRequest
|
|
297
325
|
* @return ChangeDeploymentCompartmentResponse
|
|
298
326
|
* @throws OciError when an error occurs
|
|
299
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
327
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/ChangeDeploymentCompartment.ts.html |here} to see how to use ChangeDeploymentCompartment API.
|
|
300
328
|
*/
|
|
301
329
|
changeDeploymentCompartment(changeDeploymentCompartmentRequest: requests.ChangeDeploymentCompartmentRequest): Promise<responses.ChangeDeploymentCompartmentResponse>;
|
|
302
330
|
/**
|
|
303
331
|
* Creates a new deployment.
|
|
304
332
|
*
|
|
333
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
305
334
|
* @param CreateDeploymentRequest
|
|
306
335
|
* @return CreateDeploymentResponse
|
|
307
336
|
* @throws OciError when an error occurs
|
|
308
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
337
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/CreateDeployment.ts.html |here} to see how to use CreateDeployment API.
|
|
309
338
|
*/
|
|
310
339
|
createDeployment(createDeploymentRequest: requests.CreateDeploymentRequest): Promise<responses.CreateDeploymentResponse>;
|
|
311
340
|
/**
|
|
312
341
|
* Deletes the deployment with the given identifier.
|
|
342
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
313
343
|
* @param DeleteDeploymentRequest
|
|
314
344
|
* @return DeleteDeploymentResponse
|
|
315
345
|
* @throws OciError when an error occurs
|
|
316
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
346
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/DeleteDeployment.ts.html |here} to see how to use DeleteDeployment API.
|
|
317
347
|
*/
|
|
318
348
|
deleteDeployment(deleteDeploymentRequest: requests.DeleteDeploymentRequest): Promise<responses.DeleteDeploymentResponse>;
|
|
319
349
|
/**
|
|
320
350
|
* Gets a deployment by identifier.
|
|
351
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
321
352
|
* @param GetDeploymentRequest
|
|
322
353
|
* @return GetDeploymentResponse
|
|
323
354
|
* @throws OciError when an error occurs
|
|
324
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
355
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/GetDeployment.ts.html |here} to see how to use GetDeployment API.
|
|
325
356
|
*/
|
|
326
357
|
getDeployment(getDeploymentRequest: requests.GetDeploymentRequest): Promise<responses.GetDeploymentResponse>;
|
|
327
358
|
/**
|
|
328
359
|
* Returns a list of deployments.
|
|
329
360
|
*
|
|
361
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
330
362
|
* @param ListDeploymentsRequest
|
|
331
363
|
* @return ListDeploymentsResponse
|
|
332
364
|
* @throws OciError when an error occurs
|
|
333
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
365
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/ListDeployments.ts.html |here} to see how to use ListDeployments API.
|
|
334
366
|
*/
|
|
335
367
|
listDeployments(listDeploymentsRequest: requests.ListDeploymentsRequest): Promise<responses.ListDeploymentsResponse>;
|
|
336
368
|
/**
|
|
337
369
|
* Updates the deployment with the given identifier.
|
|
370
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
338
371
|
* @param UpdateDeploymentRequest
|
|
339
372
|
* @return UpdateDeploymentResponse
|
|
340
373
|
* @throws OciError when an error occurs
|
|
341
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
374
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/UpdateDeployment.ts.html |here} to see how to use UpdateDeployment API.
|
|
342
375
|
*/
|
|
343
376
|
updateDeployment(updateDeploymentRequest: requests.UpdateDeploymentRequest): Promise<responses.UpdateDeploymentResponse>;
|
|
344
377
|
}
|
|
345
378
|
export declare enum GatewayApiKeys {
|
|
346
379
|
}
|
|
380
|
+
/**
|
|
381
|
+
* This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
|
|
382
|
+
*/
|
|
347
383
|
export declare class GatewayClient {
|
|
348
384
|
protected static serviceEndpointTemplate: string;
|
|
349
385
|
protected "_endpoint": string;
|
|
@@ -393,57 +429,66 @@ export declare class GatewayClient {
|
|
|
393
429
|
getWaiters(): GatewayWaiter;
|
|
394
430
|
/**
|
|
395
431
|
* Changes the gateway compartment.
|
|
432
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
396
433
|
* @param ChangeGatewayCompartmentRequest
|
|
397
434
|
* @return ChangeGatewayCompartmentResponse
|
|
398
435
|
* @throws OciError when an error occurs
|
|
399
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
436
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/ChangeGatewayCompartment.ts.html |here} to see how to use ChangeGatewayCompartment API.
|
|
400
437
|
*/
|
|
401
438
|
changeGatewayCompartment(changeGatewayCompartmentRequest: requests.ChangeGatewayCompartmentRequest): Promise<responses.ChangeGatewayCompartmentResponse>;
|
|
402
439
|
/**
|
|
403
440
|
* Creates a new gateway.
|
|
404
441
|
*
|
|
442
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
405
443
|
* @param CreateGatewayRequest
|
|
406
444
|
* @return CreateGatewayResponse
|
|
407
445
|
* @throws OciError when an error occurs
|
|
408
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
446
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/CreateGateway.ts.html |here} to see how to use CreateGateway API.
|
|
409
447
|
*/
|
|
410
448
|
createGateway(createGatewayRequest: requests.CreateGatewayRequest): Promise<responses.CreateGatewayResponse>;
|
|
411
449
|
/**
|
|
412
450
|
* Deletes the gateway with the given identifier.
|
|
451
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
413
452
|
* @param DeleteGatewayRequest
|
|
414
453
|
* @return DeleteGatewayResponse
|
|
415
454
|
* @throws OciError when an error occurs
|
|
416
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
455
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/DeleteGateway.ts.html |here} to see how to use DeleteGateway API.
|
|
417
456
|
*/
|
|
418
457
|
deleteGateway(deleteGatewayRequest: requests.DeleteGatewayRequest): Promise<responses.DeleteGatewayResponse>;
|
|
419
458
|
/**
|
|
420
459
|
* Gets a gateway by identifier.
|
|
460
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
421
461
|
* @param GetGatewayRequest
|
|
422
462
|
* @return GetGatewayResponse
|
|
423
463
|
* @throws OciError when an error occurs
|
|
424
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
464
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/GetGateway.ts.html |here} to see how to use GetGateway API.
|
|
425
465
|
*/
|
|
426
466
|
getGateway(getGatewayRequest: requests.GetGatewayRequest): Promise<responses.GetGatewayResponse>;
|
|
427
467
|
/**
|
|
428
468
|
* Returns a list of gateways.
|
|
429
469
|
*
|
|
470
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
430
471
|
* @param ListGatewaysRequest
|
|
431
472
|
* @return ListGatewaysResponse
|
|
432
473
|
* @throws OciError when an error occurs
|
|
433
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
474
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/ListGateways.ts.html |here} to see how to use ListGateways API.
|
|
434
475
|
*/
|
|
435
476
|
listGateways(listGatewaysRequest: requests.ListGatewaysRequest): Promise<responses.ListGatewaysResponse>;
|
|
436
477
|
/**
|
|
437
478
|
* Updates the gateway with the given identifier.
|
|
479
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
438
480
|
* @param UpdateGatewayRequest
|
|
439
481
|
* @return UpdateGatewayResponse
|
|
440
482
|
* @throws OciError when an error occurs
|
|
441
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
483
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/UpdateGateway.ts.html |here} to see how to use UpdateGateway API.
|
|
442
484
|
*/
|
|
443
485
|
updateGateway(updateGatewayRequest: requests.UpdateGatewayRequest): Promise<responses.UpdateGatewayResponse>;
|
|
444
486
|
}
|
|
445
487
|
export declare enum WorkRequestsApiKeys {
|
|
446
488
|
}
|
|
489
|
+
/**
|
|
490
|
+
* This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
|
|
491
|
+
*/
|
|
447
492
|
export declare class WorkRequestsClient {
|
|
448
493
|
protected static serviceEndpointTemplate: string;
|
|
449
494
|
protected "_endpoint": string;
|
|
@@ -493,45 +538,50 @@ export declare class WorkRequestsClient {
|
|
|
493
538
|
getWaiters(): WorkRequestsWaiter;
|
|
494
539
|
/**
|
|
495
540
|
* Cancels the work request.
|
|
541
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
496
542
|
* @param CancelWorkRequestRequest
|
|
497
543
|
* @return CancelWorkRequestResponse
|
|
498
544
|
* @throws OciError when an error occurs
|
|
499
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
545
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/CancelWorkRequest.ts.html |here} to see how to use CancelWorkRequest API.
|
|
500
546
|
*/
|
|
501
547
|
cancelWorkRequest(cancelWorkRequestRequest: requests.CancelWorkRequestRequest): Promise<responses.CancelWorkRequestResponse>;
|
|
502
548
|
/**
|
|
503
549
|
* Gets the status of the work request with the given identifier.
|
|
550
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
504
551
|
* @param GetWorkRequestRequest
|
|
505
552
|
* @return GetWorkRequestResponse
|
|
506
553
|
* @throws OciError when an error occurs
|
|
507
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
554
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/GetWorkRequest.ts.html |here} to see how to use GetWorkRequest API.
|
|
508
555
|
*/
|
|
509
556
|
getWorkRequest(getWorkRequestRequest: requests.GetWorkRequestRequest): Promise<responses.GetWorkRequestResponse>;
|
|
510
557
|
/**
|
|
511
558
|
* Returns a (paginated) list of errors for a given work request.
|
|
512
559
|
*
|
|
560
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
513
561
|
* @param ListWorkRequestErrorsRequest
|
|
514
562
|
* @return ListWorkRequestErrorsResponse
|
|
515
563
|
* @throws OciError when an error occurs
|
|
516
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
564
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/ListWorkRequestErrors.ts.html |here} to see how to use ListWorkRequestErrors API.
|
|
517
565
|
*/
|
|
518
566
|
listWorkRequestErrors(listWorkRequestErrorsRequest: requests.ListWorkRequestErrorsRequest): Promise<responses.ListWorkRequestErrorsResponse>;
|
|
519
567
|
/**
|
|
520
568
|
* Returns a (paginated) list of logs for a given work request.
|
|
521
569
|
*
|
|
570
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
522
571
|
* @param ListWorkRequestLogsRequest
|
|
523
572
|
* @return ListWorkRequestLogsResponse
|
|
524
573
|
* @throws OciError when an error occurs
|
|
525
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
574
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/ListWorkRequestLogs.ts.html |here} to see how to use ListWorkRequestLogs API.
|
|
526
575
|
*/
|
|
527
576
|
listWorkRequestLogs(listWorkRequestLogsRequest: requests.ListWorkRequestLogsRequest): Promise<responses.ListWorkRequestLogsResponse>;
|
|
528
577
|
/**
|
|
529
578
|
* Lists the work requests in a compartment.
|
|
530
579
|
*
|
|
580
|
+
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
531
581
|
* @param ListWorkRequestsRequest
|
|
532
582
|
* @return ListWorkRequestsResponse
|
|
533
583
|
* @throws OciError when an error occurs
|
|
534
|
-
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.
|
|
584
|
+
* @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.8.0/apigateway/ListWorkRequests.ts.html |here} to see how to use ListWorkRequests API.
|
|
535
585
|
*/
|
|
536
586
|
listWorkRequests(listWorkRequestsRequest: requests.ListWorkRequestsRequest): Promise<responses.ListWorkRequestsResponse>;
|
|
537
587
|
}
|