com.oracle.bmc.ons

Interface NotificationControlPlane

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

NotificationControlPlaneClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public interface NotificationControlPlane
extends AutoCloseable

Method Summary

Modifier and Type	Method and Description
ChangeTopicCompartmentResponse	changeTopicCompartment(ChangeTopicCompartmentRequest request) Moves a topic into a different compartment within the same tenancy.
CreateTopicResponse	createTopic(CreateTopicRequest request) Creates a topic in the specified compartment.
DeleteTopicResponse	deleteTopic(DeleteTopicRequest request) Deletes the specified topic.
NotificationControlPlanePaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetTopicResponse	getTopic(GetTopicRequest request) Gets the specified topic’s configuration information.
ListTopicsResponse	listTopics(ListTopicsRequest request) 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’).
UpdateTopicResponse	updateTopic(UpdateTopicRequest request) Updates the specified topic’s configuration.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

setEndpoint

void setEndpoint(String endpoint)

Sets the endpoint to call (ex, https://www.example.com).

Parameters:

endpoint - The endpoint of the service.

setRegion

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.

Parameters:

region - The region of the service.

setRegion

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.

Parameters:

regionId - The public region ID.

changeTopicCompartment

ChangeTopicCompartmentResponse changeTopicCompartment(ChangeTopicCompartmentRequest request)

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.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

createTopic

CreateTopicResponse createTopic(CreateTopicRequest request)

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.

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.

Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

deleteTopic

DeleteTopicResponse deleteTopic(DeleteTopicRequest request)

Deletes the specified topic.

Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

getTopic

GetTopicResponse getTopic(GetTopicRequest request)

Gets the specified topic’s configuration information.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

listTopics

ListTopicsResponse listTopics(ListTopicsRequest request)

Lists topics in the specified compartment.

Transactions Per Minute (TPM) per-tenancy limit for this operation: 120.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

updateTopic

UpdateTopicResponse updateTopic(UpdateTopicRequest request)

Updates the specified topic’s configuration.

Transactions Per Minute (TPM) per-tenancy limit for this operation: 60.

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

getPaginators

NotificationControlPlanePaginators getPaginators()

Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data. These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

Returns:

The service paginators.