com.oracle.bmc.announcementsservice

Interface Announcement

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AnnouncementClient

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

Method Summary

Modifier and Type	Method and Description
GetAnnouncementResponse	getAnnouncement(GetAnnouncementRequest request) Gets the details of a specific announcement.
GetAnnouncementUserStatusResponse	getAnnouncementUserStatus(GetAnnouncementUserStatusRequest request) Gets information about whether a specific announcement was acknowledged by a user.
AnnouncementPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ListAnnouncementsResponse	listAnnouncements(ListAnnouncementsRequest request) Gets a list of announcements for the current tenancy.
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’).
UpdateAnnouncementUserStatusResponse	updateAnnouncementUserStatus(UpdateAnnouncementUserStatusRequest request) Updates the status of the specified announcement with regard to whether it has been marked as read.

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.

getAnnouncement

GetAnnouncementResponse getAnnouncement(GetAnnouncementRequest request)

Gets the details of a specific announcement.

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.

getAnnouncementUserStatus

GetAnnouncementUserStatusResponse getAnnouncementUserStatus(GetAnnouncementUserStatusRequest request)

Gets information about whether a specific announcement was acknowledged by a user.

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.

listAnnouncements

ListAnnouncementsResponse listAnnouncements(ListAnnouncementsRequest request)

Gets a list of announcements for the current tenancy.

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.

updateAnnouncementUserStatus

UpdateAnnouncementUserStatusResponse updateAnnouncementUserStatus(UpdateAnnouncementUserStatusRequest request)

Updates the status of the specified announcement with regard to whether it has been marked as read.

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

AnnouncementPaginators 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.