oci-ons 2.102.2 → 2.103.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/index.d.ts +1 -1
- package/index.js +1 -1
- package/lib/client.d.ts +25 -25
- package/lib/client.js +25 -25
- package/lib/model/backoff-retry-policy.d.ts +2 -2
- package/lib/model/backoff-retry-policy.js +1 -1
- package/lib/model/change-compartment-details.d.ts +2 -2
- package/lib/model/change-compartment-details.js +1 -1
- package/lib/model/confirmation-result.d.ts +4 -4
- package/lib/model/confirmation-result.js +1 -1
- package/lib/model/create-subscription-details.d.ts +7 -7
- package/lib/model/create-subscription-details.js +1 -1
- package/lib/model/create-topic-details.d.ts +4 -4
- package/lib/model/create-topic-details.js +1 -1
- package/lib/model/delivery-policy.d.ts +1 -1
- package/lib/model/delivery-policy.js +1 -1
- package/lib/model/index.d.ts +1 -1
- package/lib/model/index.js +1 -1
- package/lib/model/message-details.d.ts +1 -1
- package/lib/model/message-details.js +1 -1
- package/lib/model/notification-topic-summary.d.ts +5 -5
- package/lib/model/notification-topic-summary.js +1 -1
- package/lib/model/notification-topic.d.ts +6 -6
- package/lib/model/notification-topic.js +1 -1
- package/lib/model/publish-result.d.ts +1 -1
- package/lib/model/publish-result.js +1 -1
- package/lib/model/subscription-summary.d.ts +7 -7
- package/lib/model/subscription-summary.js +1 -1
- package/lib/model/subscription.d.ts +8 -8
- package/lib/model/subscription.js +1 -1
- package/lib/model/topic-attributes-details.d.ts +3 -3
- package/lib/model/topic-attributes-details.js +1 -1
- package/lib/model/update-subscription-details.d.ts +3 -3
- package/lib/model/update-subscription-details.js +1 -1
- package/lib/notificationdataplane-waiter.d.ts +1 -1
- package/lib/notificationdataplane-waiter.js +1 -1
- package/lib/request/change-subscription-compartment-request.d.ts +2 -2
- package/lib/request/change-topic-compartment-request.d.ts +2 -2
- package/lib/request/create-subscription-request.d.ts +1 -1
- package/lib/request/create-topic-request.d.ts +1 -1
- package/lib/request/delete-subscription-request.d.ts +2 -2
- package/lib/request/delete-topic-request.d.ts +2 -2
- package/lib/request/get-confirm-subscription-request.d.ts +3 -3
- package/lib/request/get-subscription-request.d.ts +2 -2
- package/lib/request/get-topic-request.d.ts +2 -2
- package/lib/request/get-unsubscription-request.d.ts +3 -3
- package/lib/request/index.d.ts +1 -1
- package/lib/request/index.js +1 -1
- package/lib/request/list-subscriptions-request.d.ts +4 -4
- package/lib/request/list-topics-request.d.ts +4 -4
- package/lib/request/publish-message-request.d.ts +2 -2
- package/lib/request/resend-subscription-confirmation-request.d.ts +2 -2
- package/lib/request/update-subscription-request.d.ts +2 -2
- package/lib/request/update-topic-request.d.ts +2 -2
- package/lib/response/index.d.ts +1 -1
- package/lib/response/index.js +1 -1
- package/lib/response/list-subscriptions-response.d.ts +1 -1
- package/lib/response/list-topics-response.d.ts +2 -2
- package/package.json +3 -3
package/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Notifications API
|
|
3
3
|
* Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.
|
|
4
|
-
For information about managing topics, subscriptions, and messages, see [Notifications Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
4
|
+
For information about managing topics, subscriptions, and messages, see [Notifications Overview](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
5
5
|
|
|
6
6
|
* OpenAPI spec version: 20181201
|
|
7
7
|
*
|
package/index.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/**
|
|
3
3
|
* Notifications API
|
|
4
4
|
* Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.
|
|
5
|
-
For information about managing topics, subscriptions, and messages, see [Notifications Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
5
|
+
For information about managing topics, subscriptions, and messages, see [Notifications Overview](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
6
6
|
|
|
7
7
|
* OpenAPI spec version: 20181201
|
|
8
8
|
*
|
package/lib/client.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Notifications API
|
|
3
3
|
* Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.
|
|
4
|
-
For information about managing topics, subscriptions, and messages, see [Notifications Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
4
|
+
For information about managing topics, subscriptions, and messages, see [Notifications Overview](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
5
5
|
|
|
6
6
|
* OpenAPI spec version: 20181201
|
|
7
7
|
*
|
|
@@ -86,7 +86,7 @@ export declare class NotificationControlPlaneClient {
|
|
|
86
86
|
/**
|
|
87
87
|
* Moves a topic into a different compartment within the same tenancy. For information about moving resources
|
|
88
88
|
* between compartments, see
|
|
89
|
-
* [Moving Resources to a Different Compartment](https://docs.
|
|
89
|
+
* [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
|
|
90
90
|
* <p>
|
|
91
91
|
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
|
|
92
92
|
*
|
|
@@ -94,22 +94,22 @@ export declare class NotificationControlPlaneClient {
|
|
|
94
94
|
* @param ChangeTopicCompartmentRequest
|
|
95
95
|
* @return ChangeTopicCompartmentResponse
|
|
96
96
|
* @throws OciError when an error occurs
|
|
97
|
-
* @example Click {@link https://docs.
|
|
97
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/ChangeTopicCompartment.ts.html |here} to see how to use ChangeTopicCompartment API.
|
|
98
98
|
*/
|
|
99
99
|
changeTopicCompartment(changeTopicCompartmentRequest: requests.ChangeTopicCompartmentRequest): Promise<responses.ChangeTopicCompartmentResponse>;
|
|
100
100
|
/**
|
|
101
101
|
* Creates a topic in the specified compartment. For general information about topics, see
|
|
102
|
-
* [Managing Topics and Subscriptions](https://docs.
|
|
102
|
+
* [Managing Topics and Subscriptions](https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm).
|
|
103
103
|
* <p>
|
|
104
104
|
For the purposes of access control, you must provide the OCID of the compartment where you want the topic to reside.
|
|
105
|
-
* For information about access control and compartments, see [Overview of the IAM Service](https://docs.
|
|
105
|
+
* For information about access control and compartments, see [Overview of the IAM Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).
|
|
106
106
|
* <p>
|
|
107
107
|
You must specify a display name for the topic.
|
|
108
108
|
* <p>
|
|
109
109
|
All Oracle Cloud Infrastructure resources, including topics, get an Oracle-assigned, unique ID called an
|
|
110
110
|
* Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also
|
|
111
111
|
* retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the
|
|
112
|
-
* Console. For more information, see [Resource Identifiers](https://docs.
|
|
112
|
+
* Console. For more information, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
|
|
113
113
|
* <p>
|
|
114
114
|
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
|
|
115
115
|
*
|
|
@@ -117,7 +117,7 @@ export declare class NotificationControlPlaneClient {
|
|
|
117
117
|
* @param CreateTopicRequest
|
|
118
118
|
* @return CreateTopicResponse
|
|
119
119
|
* @throws OciError when an error occurs
|
|
120
|
-
* @example Click {@link https://docs.
|
|
120
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/CreateTopic.ts.html |here} to see how to use CreateTopic API.
|
|
121
121
|
*/
|
|
122
122
|
createTopic(createTopicRequest: requests.CreateTopicRequest): Promise<responses.CreateTopicResponse>;
|
|
123
123
|
/**
|
|
@@ -129,7 +129,7 @@ export declare class NotificationControlPlaneClient {
|
|
|
129
129
|
* @param DeleteTopicRequest
|
|
130
130
|
* @return DeleteTopicResponse
|
|
131
131
|
* @throws OciError when an error occurs
|
|
132
|
-
* @example Click {@link https://docs.
|
|
132
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/DeleteTopic.ts.html |here} to see how to use DeleteTopic API.
|
|
133
133
|
*/
|
|
134
134
|
deleteTopic(deleteTopicRequest: requests.DeleteTopicRequest): Promise<responses.DeleteTopicResponse>;
|
|
135
135
|
/**
|
|
@@ -139,7 +139,7 @@ export declare class NotificationControlPlaneClient {
|
|
|
139
139
|
* @param GetTopicRequest
|
|
140
140
|
* @return GetTopicResponse
|
|
141
141
|
* @throws OciError when an error occurs
|
|
142
|
-
* @example Click {@link https://docs.
|
|
142
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/GetTopic.ts.html |here} to see how to use GetTopic API.
|
|
143
143
|
*/
|
|
144
144
|
getTopic(getTopicRequest: requests.GetTopicRequest): Promise<responses.GetTopicResponse>;
|
|
145
145
|
/**
|
|
@@ -151,7 +151,7 @@ export declare class NotificationControlPlaneClient {
|
|
|
151
151
|
* @param ListTopicsRequest
|
|
152
152
|
* @return ListTopicsResponse
|
|
153
153
|
* @throws OciError when an error occurs
|
|
154
|
-
* @example Click {@link https://docs.
|
|
154
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/ListTopics.ts.html |here} to see how to use ListTopics API.
|
|
155
155
|
*/
|
|
156
156
|
listTopics(listTopicsRequest: requests.ListTopicsRequest): Promise<responses.ListTopicsResponse>;
|
|
157
157
|
/**
|
|
@@ -195,7 +195,7 @@ export declare class NotificationControlPlaneClient {
|
|
|
195
195
|
* @param UpdateTopicRequest
|
|
196
196
|
* @return UpdateTopicResponse
|
|
197
197
|
* @throws OciError when an error occurs
|
|
198
|
-
* @example Click {@link https://docs.
|
|
198
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/UpdateTopic.ts.html |here} to see how to use UpdateTopic API.
|
|
199
199
|
*/
|
|
200
200
|
updateTopic(updateTopicRequest: requests.UpdateTopicRequest): Promise<responses.UpdateTopicResponse>;
|
|
201
201
|
}
|
|
@@ -281,7 +281,7 @@ export declare class NotificationDataPlaneClient {
|
|
|
281
281
|
/**
|
|
282
282
|
* Moves a subscription into a different compartment within the same tenancy. For information about moving
|
|
283
283
|
* resources between compartments, see
|
|
284
|
-
* [Moving Resources to a Different Compartment](https://docs.
|
|
284
|
+
* [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
|
|
285
285
|
* <p>
|
|
286
286
|
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
|
|
287
287
|
*
|
|
@@ -289,13 +289,13 @@ export declare class NotificationDataPlaneClient {
|
|
|
289
289
|
* @param ChangeSubscriptionCompartmentRequest
|
|
290
290
|
* @return ChangeSubscriptionCompartmentResponse
|
|
291
291
|
* @throws OciError when an error occurs
|
|
292
|
-
* @example Click {@link https://docs.
|
|
292
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/ChangeSubscriptionCompartment.ts.html |here} to see how to use ChangeSubscriptionCompartment API.
|
|
293
293
|
*/
|
|
294
294
|
changeSubscriptionCompartment(changeSubscriptionCompartmentRequest: requests.ChangeSubscriptionCompartmentRequest): Promise<responses.ChangeSubscriptionCompartmentResponse>;
|
|
295
295
|
/**
|
|
296
296
|
* Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint. The subscription remains in \"Pending\" status until it has been confirmed.
|
|
297
297
|
* For information about confirming subscriptions, see
|
|
298
|
-
* [To confirm a subscription](https://docs.
|
|
298
|
+
* [To confirm a subscription](https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#confirmSub).
|
|
299
299
|
* <p>
|
|
300
300
|
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
|
|
301
301
|
*
|
|
@@ -303,7 +303,7 @@ export declare class NotificationDataPlaneClient {
|
|
|
303
303
|
* @param CreateSubscriptionRequest
|
|
304
304
|
* @return CreateSubscriptionResponse
|
|
305
305
|
* @throws OciError when an error occurs
|
|
306
|
-
* @example Click {@link https://docs.
|
|
306
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/CreateSubscription.ts.html |here} to see how to use CreateSubscription API.
|
|
307
307
|
*/
|
|
308
308
|
createSubscription(createSubscriptionRequest: requests.CreateSubscriptionRequest): Promise<responses.CreateSubscriptionResponse>;
|
|
309
309
|
/**
|
|
@@ -315,7 +315,7 @@ export declare class NotificationDataPlaneClient {
|
|
|
315
315
|
* @param DeleteSubscriptionRequest
|
|
316
316
|
* @return DeleteSubscriptionResponse
|
|
317
317
|
* @throws OciError when an error occurs
|
|
318
|
-
* @example Click {@link https://docs.
|
|
318
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/DeleteSubscription.ts.html |here} to see how to use DeleteSubscription API.
|
|
319
319
|
*/
|
|
320
320
|
deleteSubscription(deleteSubscriptionRequest: requests.DeleteSubscriptionRequest): Promise<responses.DeleteSubscriptionResponse>;
|
|
321
321
|
/**
|
|
@@ -327,7 +327,7 @@ export declare class NotificationDataPlaneClient {
|
|
|
327
327
|
* @param GetConfirmSubscriptionRequest
|
|
328
328
|
* @return GetConfirmSubscriptionResponse
|
|
329
329
|
* @throws OciError when an error occurs
|
|
330
|
-
* @example Click {@link https://docs.
|
|
330
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/GetConfirmSubscription.ts.html |here} to see how to use GetConfirmSubscription API.
|
|
331
331
|
*/
|
|
332
332
|
getConfirmSubscription(getConfirmSubscriptionRequest: requests.GetConfirmSubscriptionRequest): Promise<responses.GetConfirmSubscriptionResponse>;
|
|
333
333
|
/**
|
|
@@ -339,7 +339,7 @@ export declare class NotificationDataPlaneClient {
|
|
|
339
339
|
* @param GetSubscriptionRequest
|
|
340
340
|
* @return GetSubscriptionResponse
|
|
341
341
|
* @throws OciError when an error occurs
|
|
342
|
-
* @example Click {@link https://docs.
|
|
342
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/GetSubscription.ts.html |here} to see how to use GetSubscription API.
|
|
343
343
|
*/
|
|
344
344
|
getSubscription(getSubscriptionRequest: requests.GetSubscriptionRequest): Promise<responses.GetSubscriptionResponse>;
|
|
345
345
|
/**
|
|
@@ -351,7 +351,7 @@ export declare class NotificationDataPlaneClient {
|
|
|
351
351
|
* @param GetUnsubscriptionRequest
|
|
352
352
|
* @return GetUnsubscriptionResponse
|
|
353
353
|
* @throws OciError when an error occurs
|
|
354
|
-
* @example Click {@link https://docs.
|
|
354
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/GetUnsubscription.ts.html |here} to see how to use GetUnsubscription API.
|
|
355
355
|
*/
|
|
356
356
|
getUnsubscription(getUnsubscriptionRequest: requests.GetUnsubscriptionRequest): Promise<responses.GetUnsubscriptionResponse>;
|
|
357
357
|
/**
|
|
@@ -363,7 +363,7 @@ export declare class NotificationDataPlaneClient {
|
|
|
363
363
|
* @param ListSubscriptionsRequest
|
|
364
364
|
* @return ListSubscriptionsResponse
|
|
365
365
|
* @throws OciError when an error occurs
|
|
366
|
-
* @example Click {@link https://docs.
|
|
366
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/ListSubscriptions.ts.html |here} to see how to use ListSubscriptions API.
|
|
367
367
|
*/
|
|
368
368
|
listSubscriptions(listSubscriptionsRequest: requests.ListSubscriptionsRequest): Promise<responses.ListSubscriptionsResponse>;
|
|
369
369
|
/**
|
|
@@ -414,14 +414,14 @@ export declare class NotificationDataPlaneClient {
|
|
|
414
414
|
* <p>
|
|
415
415
|
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60 per topic. (This TPM limit represents messages per minute.)
|
|
416
416
|
* <p>
|
|
417
|
-
For more information about publishing messages, see [Publishing Messages](https://docs.
|
|
418
|
-
* For steps to request a limit increase, see [Requesting a Service Limit Increase](https://docs.
|
|
417
|
+
For more information about publishing messages, see [Publishing Messages](https://docs.oracle.com/iaas/Content/Notification/Tasks/publishingmessages.htm).
|
|
418
|
+
* For steps to request a limit increase, see [Requesting a Service Limit Increase](https://docs.oracle.com/iaas/Content/General/Concepts/servicelimits.htm#three).
|
|
419
419
|
*
|
|
420
420
|
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
421
421
|
* @param PublishMessageRequest
|
|
422
422
|
* @return PublishMessageResponse
|
|
423
423
|
* @throws OciError when an error occurs
|
|
424
|
-
* @example Click {@link https://docs.
|
|
424
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/PublishMessage.ts.html |here} to see how to use PublishMessage API.
|
|
425
425
|
*/
|
|
426
426
|
publishMessage(publishMessageRequest: requests.PublishMessageRequest): Promise<responses.PublishMessageResponse>;
|
|
427
427
|
/**
|
|
@@ -433,7 +433,7 @@ export declare class NotificationDataPlaneClient {
|
|
|
433
433
|
* @param ResendSubscriptionConfirmationRequest
|
|
434
434
|
* @return ResendSubscriptionConfirmationResponse
|
|
435
435
|
* @throws OciError when an error occurs
|
|
436
|
-
* @example Click {@link https://docs.
|
|
436
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/ResendSubscriptionConfirmation.ts.html |here} to see how to use ResendSubscriptionConfirmation API.
|
|
437
437
|
*/
|
|
438
438
|
resendSubscriptionConfirmation(resendSubscriptionConfirmationRequest: requests.ResendSubscriptionConfirmationRequest): Promise<responses.ResendSubscriptionConfirmationResponse>;
|
|
439
439
|
/**
|
|
@@ -445,7 +445,7 @@ export declare class NotificationDataPlaneClient {
|
|
|
445
445
|
* @param UpdateSubscriptionRequest
|
|
446
446
|
* @return UpdateSubscriptionResponse
|
|
447
447
|
* @throws OciError when an error occurs
|
|
448
|
-
* @example Click {@link https://docs.
|
|
448
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/UpdateSubscription.ts.html |here} to see how to use UpdateSubscription API.
|
|
449
449
|
*/
|
|
450
450
|
updateSubscription(updateSubscriptionRequest: requests.UpdateSubscriptionRequest): Promise<responses.UpdateSubscriptionResponse>;
|
|
451
451
|
}
|
package/lib/client.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/**
|
|
3
3
|
* Notifications API
|
|
4
4
|
* Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.
|
|
5
|
-
For information about managing topics, subscriptions, and messages, see [Notifications Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
5
|
+
For information about managing topics, subscriptions, and messages, see [Notifications Overview](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
6
6
|
|
|
7
7
|
* OpenAPI spec version: 20181201
|
|
8
8
|
*
|
|
@@ -192,7 +192,7 @@ class NotificationControlPlaneClient {
|
|
|
192
192
|
/**
|
|
193
193
|
* Moves a topic into a different compartment within the same tenancy. For information about moving resources
|
|
194
194
|
* between compartments, see
|
|
195
|
-
* [Moving Resources to a Different Compartment](https://docs.
|
|
195
|
+
* [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
|
|
196
196
|
* <p>
|
|
197
197
|
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
|
|
198
198
|
*
|
|
@@ -200,7 +200,7 @@ class NotificationControlPlaneClient {
|
|
|
200
200
|
* @param ChangeTopicCompartmentRequest
|
|
201
201
|
* @return ChangeTopicCompartmentResponse
|
|
202
202
|
* @throws OciError when an error occurs
|
|
203
|
-
* @example Click {@link https://docs.
|
|
203
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/ChangeTopicCompartment.ts.html |here} to see how to use ChangeTopicCompartment API.
|
|
204
204
|
*/
|
|
205
205
|
changeTopicCompartment(changeTopicCompartmentRequest) {
|
|
206
206
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -253,17 +253,17 @@ class NotificationControlPlaneClient {
|
|
|
253
253
|
}
|
|
254
254
|
/**
|
|
255
255
|
* Creates a topic in the specified compartment. For general information about topics, see
|
|
256
|
-
* [Managing Topics and Subscriptions](https://docs.
|
|
256
|
+
* [Managing Topics and Subscriptions](https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm).
|
|
257
257
|
* <p>
|
|
258
258
|
For the purposes of access control, you must provide the OCID of the compartment where you want the topic to reside.
|
|
259
|
-
* For information about access control and compartments, see [Overview of the IAM Service](https://docs.
|
|
259
|
+
* For information about access control and compartments, see [Overview of the IAM Service](https://docs.oracle.com/iaas/Content/Identity/Concepts/overview.htm).
|
|
260
260
|
* <p>
|
|
261
261
|
You must specify a display name for the topic.
|
|
262
262
|
* <p>
|
|
263
263
|
All Oracle Cloud Infrastructure resources, including topics, get an Oracle-assigned, unique ID called an
|
|
264
264
|
* Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also
|
|
265
265
|
* retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the
|
|
266
|
-
* Console. For more information, see [Resource Identifiers](https://docs.
|
|
266
|
+
* Console. For more information, see [Resource Identifiers](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
|
|
267
267
|
* <p>
|
|
268
268
|
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
|
|
269
269
|
*
|
|
@@ -271,7 +271,7 @@ class NotificationControlPlaneClient {
|
|
|
271
271
|
* @param CreateTopicRequest
|
|
272
272
|
* @return CreateTopicResponse
|
|
273
273
|
* @throws OciError when an error occurs
|
|
274
|
-
* @example Click {@link https://docs.
|
|
274
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/CreateTopic.ts.html |here} to see how to use CreateTopic API.
|
|
275
275
|
*/
|
|
276
276
|
createTopic(createTopicRequest) {
|
|
277
277
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -337,7 +337,7 @@ class NotificationControlPlaneClient {
|
|
|
337
337
|
* @param DeleteTopicRequest
|
|
338
338
|
* @return DeleteTopicResponse
|
|
339
339
|
* @throws OciError when an error occurs
|
|
340
|
-
* @example Click {@link https://docs.
|
|
340
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/DeleteTopic.ts.html |here} to see how to use DeleteTopic API.
|
|
341
341
|
*/
|
|
342
342
|
deleteTopic(deleteTopicRequest) {
|
|
343
343
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -393,7 +393,7 @@ class NotificationControlPlaneClient {
|
|
|
393
393
|
* @param GetTopicRequest
|
|
394
394
|
* @return GetTopicResponse
|
|
395
395
|
* @throws OciError when an error occurs
|
|
396
|
-
* @example Click {@link https://docs.
|
|
396
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/GetTopic.ts.html |here} to see how to use GetTopic API.
|
|
397
397
|
*/
|
|
398
398
|
getTopic(getTopicRequest) {
|
|
399
399
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -459,7 +459,7 @@ class NotificationControlPlaneClient {
|
|
|
459
459
|
* @param ListTopicsRequest
|
|
460
460
|
* @return ListTopicsResponse
|
|
461
461
|
* @throws OciError when an error occurs
|
|
462
|
-
* @example Click {@link https://docs.
|
|
462
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/ListTopics.ts.html |here} to see how to use ListTopics API.
|
|
463
463
|
*/
|
|
464
464
|
listTopics(listTopicsRequest) {
|
|
465
465
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -577,7 +577,7 @@ class NotificationControlPlaneClient {
|
|
|
577
577
|
* @param UpdateTopicRequest
|
|
578
578
|
* @return UpdateTopicResponse
|
|
579
579
|
* @throws OciError when an error occurs
|
|
580
|
-
* @example Click {@link https://docs.
|
|
580
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/UpdateTopic.ts.html |here} to see how to use UpdateTopic API.
|
|
581
581
|
*/
|
|
582
582
|
updateTopic(updateTopicRequest) {
|
|
583
583
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -801,7 +801,7 @@ class NotificationDataPlaneClient {
|
|
|
801
801
|
/**
|
|
802
802
|
* Moves a subscription into a different compartment within the same tenancy. For information about moving
|
|
803
803
|
* resources between compartments, see
|
|
804
|
-
* [Moving Resources to a Different Compartment](https://docs.
|
|
804
|
+
* [Moving Resources to a Different Compartment](https://docs.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
|
|
805
805
|
* <p>
|
|
806
806
|
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
|
|
807
807
|
*
|
|
@@ -809,7 +809,7 @@ class NotificationDataPlaneClient {
|
|
|
809
809
|
* @param ChangeSubscriptionCompartmentRequest
|
|
810
810
|
* @return ChangeSubscriptionCompartmentResponse
|
|
811
811
|
* @throws OciError when an error occurs
|
|
812
|
-
* @example Click {@link https://docs.
|
|
812
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/ChangeSubscriptionCompartment.ts.html |here} to see how to use ChangeSubscriptionCompartment API.
|
|
813
813
|
*/
|
|
814
814
|
changeSubscriptionCompartment(changeSubscriptionCompartmentRequest) {
|
|
815
815
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -863,7 +863,7 @@ class NotificationDataPlaneClient {
|
|
|
863
863
|
/**
|
|
864
864
|
* Creates a subscription for the specified topic and sends a subscription confirmation URL to the endpoint. The subscription remains in \"Pending\" status until it has been confirmed.
|
|
865
865
|
* For information about confirming subscriptions, see
|
|
866
|
-
* [To confirm a subscription](https://docs.
|
|
866
|
+
* [To confirm a subscription](https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#confirmSub).
|
|
867
867
|
* <p>
|
|
868
868
|
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
|
|
869
869
|
*
|
|
@@ -871,7 +871,7 @@ class NotificationDataPlaneClient {
|
|
|
871
871
|
* @param CreateSubscriptionRequest
|
|
872
872
|
* @return CreateSubscriptionResponse
|
|
873
873
|
* @throws OciError when an error occurs
|
|
874
|
-
* @example Click {@link https://docs.
|
|
874
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/CreateSubscription.ts.html |here} to see how to use CreateSubscription API.
|
|
875
875
|
*/
|
|
876
876
|
createSubscription(createSubscriptionRequest) {
|
|
877
877
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -937,7 +937,7 @@ class NotificationDataPlaneClient {
|
|
|
937
937
|
* @param DeleteSubscriptionRequest
|
|
938
938
|
* @return DeleteSubscriptionResponse
|
|
939
939
|
* @throws OciError when an error occurs
|
|
940
|
-
* @example Click {@link https://docs.
|
|
940
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/DeleteSubscription.ts.html |here} to see how to use DeleteSubscription API.
|
|
941
941
|
*/
|
|
942
942
|
deleteSubscription(deleteSubscriptionRequest) {
|
|
943
943
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -995,7 +995,7 @@ class NotificationDataPlaneClient {
|
|
|
995
995
|
* @param GetConfirmSubscriptionRequest
|
|
996
996
|
* @return GetConfirmSubscriptionResponse
|
|
997
997
|
* @throws OciError when an error occurs
|
|
998
|
-
* @example Click {@link https://docs.
|
|
998
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/GetConfirmSubscription.ts.html |here} to see how to use GetConfirmSubscription API.
|
|
999
999
|
*/
|
|
1000
1000
|
getConfirmSubscription(getConfirmSubscriptionRequest) {
|
|
1001
1001
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1064,7 +1064,7 @@ class NotificationDataPlaneClient {
|
|
|
1064
1064
|
* @param GetSubscriptionRequest
|
|
1065
1065
|
* @return GetSubscriptionResponse
|
|
1066
1066
|
* @throws OciError when an error occurs
|
|
1067
|
-
* @example Click {@link https://docs.
|
|
1067
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/GetSubscription.ts.html |here} to see how to use GetSubscription API.
|
|
1068
1068
|
*/
|
|
1069
1069
|
getSubscription(getSubscriptionRequest) {
|
|
1070
1070
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1130,7 +1130,7 @@ class NotificationDataPlaneClient {
|
|
|
1130
1130
|
* @param GetUnsubscriptionRequest
|
|
1131
1131
|
* @return GetUnsubscriptionResponse
|
|
1132
1132
|
* @throws OciError when an error occurs
|
|
1133
|
-
* @example Click {@link https://docs.
|
|
1133
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/GetUnsubscription.ts.html |here} to see how to use GetUnsubscription API.
|
|
1134
1134
|
*/
|
|
1135
1135
|
getUnsubscription(getUnsubscriptionRequest) {
|
|
1136
1136
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1194,7 +1194,7 @@ class NotificationDataPlaneClient {
|
|
|
1194
1194
|
* @param ListSubscriptionsRequest
|
|
1195
1195
|
* @return ListSubscriptionsResponse
|
|
1196
1196
|
* @throws OciError when an error occurs
|
|
1197
|
-
* @example Click {@link https://docs.
|
|
1197
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/ListSubscriptions.ts.html |here} to see how to use ListSubscriptions API.
|
|
1198
1198
|
*/
|
|
1199
1199
|
listSubscriptions(listSubscriptionsRequest) {
|
|
1200
1200
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1310,14 +1310,14 @@ class NotificationDataPlaneClient {
|
|
|
1310
1310
|
* <p>
|
|
1311
1311
|
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60 per topic. (This TPM limit represents messages per minute.)
|
|
1312
1312
|
* <p>
|
|
1313
|
-
For more information about publishing messages, see [Publishing Messages](https://docs.
|
|
1314
|
-
* For steps to request a limit increase, see [Requesting a Service Limit Increase](https://docs.
|
|
1313
|
+
For more information about publishing messages, see [Publishing Messages](https://docs.oracle.com/iaas/Content/Notification/Tasks/publishingmessages.htm).
|
|
1314
|
+
* For steps to request a limit increase, see [Requesting a Service Limit Increase](https://docs.oracle.com/iaas/Content/General/Concepts/servicelimits.htm#three).
|
|
1315
1315
|
*
|
|
1316
1316
|
* This operation does not retry by default if the user has not defined a retry configuration.
|
|
1317
1317
|
* @param PublishMessageRequest
|
|
1318
1318
|
* @return PublishMessageResponse
|
|
1319
1319
|
* @throws OciError when an error occurs
|
|
1320
|
-
* @example Click {@link https://docs.
|
|
1320
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/PublishMessage.ts.html |here} to see how to use PublishMessage API.
|
|
1321
1321
|
*/
|
|
1322
1322
|
publishMessage(publishMessageRequest) {
|
|
1323
1323
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1380,7 +1380,7 @@ class NotificationDataPlaneClient {
|
|
|
1380
1380
|
* @param ResendSubscriptionConfirmationRequest
|
|
1381
1381
|
* @return ResendSubscriptionConfirmationResponse
|
|
1382
1382
|
* @throws OciError when an error occurs
|
|
1383
|
-
* @example Click {@link https://docs.
|
|
1383
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/ResendSubscriptionConfirmation.ts.html |here} to see how to use ResendSubscriptionConfirmation API.
|
|
1384
1384
|
*/
|
|
1385
1385
|
resendSubscriptionConfirmation(resendSubscriptionConfirmationRequest) {
|
|
1386
1386
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1441,7 +1441,7 @@ class NotificationDataPlaneClient {
|
|
|
1441
1441
|
* @param UpdateSubscriptionRequest
|
|
1442
1442
|
* @return UpdateSubscriptionResponse
|
|
1443
1443
|
* @throws OciError when an error occurs
|
|
1444
|
-
* @example Click {@link https://docs.
|
|
1444
|
+
* @example Click {@link https://docs.oracle.com/en-us/iaas/tools/typescript-sdk-examples/latest/ons/UpdateSubscription.ts.html |here} to see how to use UpdateSubscription API.
|
|
1445
1445
|
*/
|
|
1446
1446
|
updateSubscription(updateSubscriptionRequest) {
|
|
1447
1447
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Notifications API
|
|
3
3
|
* Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.
|
|
4
|
-
For information about managing topics, subscriptions, and messages, see [Notifications Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
4
|
+
For information about managing topics, subscriptions, and messages, see [Notifications Overview](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
5
5
|
|
|
6
6
|
* OpenAPI spec version: 20181201
|
|
7
7
|
*
|
|
@@ -14,7 +14,7 @@ For information about managing topics, subscriptions, and messages, see [Notific
|
|
|
14
14
|
*/
|
|
15
15
|
/**
|
|
16
16
|
* The backoff retry portion of the subscription delivery policy. For information about retry durations for subscriptions, see
|
|
17
|
-
* [How Notifications Works](https://docs.
|
|
17
|
+
* [How Notifications Works](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm#how).
|
|
18
18
|
*
|
|
19
19
|
*/
|
|
20
20
|
export interface BackoffRetryPolicy {
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/**
|
|
3
3
|
* Notifications API
|
|
4
4
|
* Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.
|
|
5
|
-
For information about managing topics, subscriptions, and messages, see [Notifications Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
5
|
+
For information about managing topics, subscriptions, and messages, see [Notifications Overview](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
6
6
|
|
|
7
7
|
* OpenAPI spec version: 20181201
|
|
8
8
|
*
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Notifications API
|
|
3
3
|
* Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.
|
|
4
|
-
For information about managing topics, subscriptions, and messages, see [Notifications Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
4
|
+
For information about managing topics, subscriptions, and messages, see [Notifications Overview](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
5
5
|
|
|
6
6
|
* OpenAPI spec version: 20181201
|
|
7
7
|
*
|
|
@@ -18,7 +18,7 @@ For information about managing topics, subscriptions, and messages, see [Notific
|
|
|
18
18
|
*/
|
|
19
19
|
export interface ChangeCompartmentDetails {
|
|
20
20
|
/**
|
|
21
|
-
* The [OCID](https://docs.
|
|
21
|
+
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the specified topic
|
|
22
22
|
* or subscription to.
|
|
23
23
|
*
|
|
24
24
|
*/
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/**
|
|
3
3
|
* Notifications API
|
|
4
4
|
* Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.
|
|
5
|
-
For information about managing topics, subscriptions, and messages, see [Notifications Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
5
|
+
For information about managing topics, subscriptions, and messages, see [Notifications Overview](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
6
6
|
|
|
7
7
|
* OpenAPI spec version: 20181201
|
|
8
8
|
*
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Notifications API
|
|
3
3
|
* Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.
|
|
4
|
-
For information about managing topics, subscriptions, and messages, see [Notifications Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
4
|
+
For information about managing topics, subscriptions, and messages, see [Notifications Overview](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
5
5
|
|
|
6
6
|
* OpenAPI spec version: 20181201
|
|
7
7
|
*
|
|
@@ -15,7 +15,7 @@ For information about managing topics, subscriptions, and messages, see [Notific
|
|
|
15
15
|
/**
|
|
16
16
|
* The confirmation details for the specified subscription.
|
|
17
17
|
* For information about confirming subscriptions, see
|
|
18
|
-
* [To confirm a subscription](https://docs.
|
|
18
|
+
* [To confirm a subscription](https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#confirmSub).
|
|
19
19
|
*
|
|
20
20
|
*/
|
|
21
21
|
export interface ConfirmationResult {
|
|
@@ -25,7 +25,7 @@ export interface ConfirmationResult {
|
|
|
25
25
|
*/
|
|
26
26
|
"topicName": string;
|
|
27
27
|
/**
|
|
28
|
-
* The [OCID](https://docs.
|
|
28
|
+
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic associated with the specified subscription.
|
|
29
29
|
*
|
|
30
30
|
*/
|
|
31
31
|
"topicId": string;
|
|
@@ -44,7 +44,7 @@ export interface ConfirmationResult {
|
|
|
44
44
|
*/
|
|
45
45
|
"message": string;
|
|
46
46
|
/**
|
|
47
|
-
* The [OCID](https://docs.
|
|
47
|
+
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription specified in the request.
|
|
48
48
|
*/
|
|
49
49
|
"subscriptionId": string;
|
|
50
50
|
}
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/**
|
|
3
3
|
* Notifications API
|
|
4
4
|
* Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.
|
|
5
|
-
For information about managing topics, subscriptions, and messages, see [Notifications Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
5
|
+
For information about managing topics, subscriptions, and messages, see [Notifications Overview](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
6
6
|
|
|
7
7
|
* OpenAPI spec version: 20181201
|
|
8
8
|
*
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Notifications API
|
|
3
3
|
* Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.
|
|
4
|
-
For information about managing topics, subscriptions, and messages, see [Notifications Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
4
|
+
For information about managing topics, subscriptions, and messages, see [Notifications Overview](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
5
5
|
|
|
6
6
|
* OpenAPI spec version: 20181201
|
|
7
7
|
*
|
|
@@ -18,12 +18,12 @@ For information about managing topics, subscriptions, and messages, see [Notific
|
|
|
18
18
|
*/
|
|
19
19
|
export interface CreateSubscriptionDetails {
|
|
20
20
|
/**
|
|
21
|
-
* The [OCID](https://docs.
|
|
21
|
+
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the topic for the subscription.
|
|
22
22
|
*
|
|
23
23
|
*/
|
|
24
24
|
"topicId": string;
|
|
25
25
|
/**
|
|
26
|
-
* The [OCID](https://docs.
|
|
26
|
+
* The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment for the subscription.
|
|
27
27
|
*
|
|
28
28
|
*/
|
|
29
29
|
"compartmentId": string;
|
|
@@ -40,7 +40,7 @@ export interface CreateSubscriptionDetails {
|
|
|
40
40
|
* * {@code SMS}
|
|
41
41
|
* <p>
|
|
42
42
|
For information about subscription protocols, see
|
|
43
|
-
* [To create a subscription](https://docs.
|
|
43
|
+
* [To create a subscription](https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
|
|
44
44
|
*
|
|
45
45
|
*/
|
|
46
46
|
"protocol": string;
|
|
@@ -52,7 +52,7 @@ export interface CreateSubscriptionDetails {
|
|
|
52
52
|
* Avoid entering confidential information.
|
|
53
53
|
* <p>
|
|
54
54
|
For protocol-specific endpoint formats and steps to get or create endpoints, see
|
|
55
|
-
* [To create a subscription](https://docs.
|
|
55
|
+
* [To create a subscription](https://docs.oracle.com/iaas/Content/Notification/Tasks/managingtopicsandsubscriptions.htm#createSub).
|
|
56
56
|
*
|
|
57
57
|
*/
|
|
58
58
|
"endpoint": string;
|
|
@@ -61,7 +61,7 @@ export interface CreateSubscriptionDetails {
|
|
|
61
61
|
*/
|
|
62
62
|
"metadata"?: string;
|
|
63
63
|
/**
|
|
64
|
-
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.
|
|
64
|
+
* Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
|
|
65
65
|
* <p>
|
|
66
66
|
Example: {@code {\"Department\": \"Finance\"}}
|
|
67
67
|
*
|
|
@@ -70,7 +70,7 @@ export interface CreateSubscriptionDetails {
|
|
|
70
70
|
[key: string]: string;
|
|
71
71
|
};
|
|
72
72
|
/**
|
|
73
|
-
* Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.
|
|
73
|
+
* Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
|
|
74
74
|
* <p>
|
|
75
75
|
Example: {@code {\"Operations\": {\"CostCenter\": \"42\"}}}
|
|
76
76
|
*
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/**
|
|
3
3
|
* Notifications API
|
|
4
4
|
* Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern.
|
|
5
|
-
For information about managing topics, subscriptions, and messages, see [Notifications Overview](/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
5
|
+
For information about managing topics, subscriptions, and messages, see [Notifications Overview](https://docs.oracle.com/iaas/Content/Notification/Concepts/notificationoverview.htm).
|
|
6
6
|
|
|
7
7
|
* OpenAPI spec version: 20181201
|
|
8
8
|
*
|