@Generated(value="OracleSDKGenerator", comments="API Version: 20181201") public interface NotificationControlPlaneAsync extends AutoCloseable
Use the Notifications API to broadcast messages to distributed components by topic, using a publish-subscribe pattern. For information about managing topics, subscriptions, and messages, see Notifications Overview.
Modifier and Type | Method and Description |
---|---|
Future<ChangeTopicCompartmentResponse> |
changeTopicCompartment(ChangeTopicCompartmentRequest request,
AsyncHandler<ChangeTopicCompartmentRequest,ChangeTopicCompartmentResponse> handler)
Moves a topic into a different compartment within the same tenancy.
|
Future<CreateTopicResponse> |
createTopic(CreateTopicRequest request,
AsyncHandler<CreateTopicRequest,CreateTopicResponse> handler)
Creates a topic in the specified compartment.
|
Future<DeleteTopicResponse> |
deleteTopic(DeleteTopicRequest request,
AsyncHandler<DeleteTopicRequest,DeleteTopicResponse> handler)
Deletes the specified topic.
|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
Future<GetTopicResponse> |
getTopic(GetTopicRequest request,
AsyncHandler<GetTopicRequest,GetTopicResponse> handler)
Gets the specified topic’s configuration information.
|
Future<ListTopicsResponse> |
listTopics(ListTopicsRequest request,
AsyncHandler<ListTopicsRequest,ListTopicsResponse> handler)
Lists topics in the specified compartment.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
Future<UpdateTopicResponse> |
updateTopic(UpdateTopicRequest request,
AsyncHandler<UpdateTopicRequest,UpdateTopicResponse> handler)
Updates the specified topic’s configuration.
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the serice.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the endpoint. If the service is not available in this region, however, an IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call
setRegion
.
If no known Region could be determined, it will create an endpoint based on the
default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.Future<ChangeTopicCompartmentResponse> changeTopicCompartment(ChangeTopicCompartmentRequest request, AsyncHandler<ChangeTopicCompartmentRequest,ChangeTopicCompartmentResponse> handler)
Moves a topic into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<CreateTopicResponse> createTopic(CreateTopicRequest request, AsyncHandler<CreateTopicRequest,CreateTopicResponse> handler)
Creates a topic in the specified compartment. For general information about topics, see Managing Topics and Subscriptions.
For the purposes of access control, you must provide the OCID of the compartment where you want the topic to reside. For information about access control and compartments, see [Overview of the IAM Service](https://docs.cloud.oracle.com/Content/Identity/Concepts/overview.htm).
You must specify a display name for the topic.
All Oracle Cloud Infrastructure resources, including topics, get an Oracle-assigned, unique ID called an Oracle Cloud Identifier (OCID). When you create a resource, you can find its OCID in the response. You can also retrieve a resource's OCID by using a List API operation on that resource type, or by viewing the resource in the Console. For more information, see [Resource Identifiers](https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<DeleteTopicResponse> deleteTopic(DeleteTopicRequest request, AsyncHandler<DeleteTopicRequest,DeleteTopicResponse> handler)
Deletes the specified topic.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<GetTopicResponse> getTopic(GetTopicRequest request, AsyncHandler<GetTopicRequest,GetTopicResponse> handler)
Gets the specified topic’s configuration information.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<ListTopicsResponse> listTopics(ListTopicsRequest request, AsyncHandler<ListTopicsRequest,ListTopicsResponse> handler)
Lists topics in the specified compartment.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 120.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Future<UpdateTopicResponse> updateTopic(UpdateTopicRequest request, AsyncHandler<UpdateTopicRequest,UpdateTopicResponse> handler)
Updates the specified topic’s configuration.
Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.
request
- The request object containing the details to sendhandler
- The request handler to invoke upon completion, may be null.Copyright © 2016–2021. All rights reserved.