com.oracle.bmc.announcementsservice

Interface AnnouncementAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AnnouncementAsyncClient

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

Manage Oracle Cloud Infrastructure console announcements.

Method Summary

Modifier and Type	Method and Description
Future<GetAnnouncementResponse>	getAnnouncement(GetAnnouncementRequest request, AsyncHandler<GetAnnouncementRequest,GetAnnouncementResponse> handler) Gets the details of a specific announcement.
Future<GetAnnouncementCompartmentResponse>	getAnnouncementCompartment(GetAnnouncementCompartmentRequest request, AsyncHandler<GetAnnouncementCompartmentRequest,GetAnnouncementCompartmentResponse> handler) Gets the compartment details of an announcement.
Future<GetAnnouncementUserStatusResponse>	getAnnouncementUserStatus(GetAnnouncementUserStatusRequest request, AsyncHandler<GetAnnouncementUserStatusRequest,GetAnnouncementUserStatusResponse> handler) Gets information about whether a specific announcement was acknowledged by a user.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<ListAnnouncementsResponse>	listAnnouncements(ListAnnouncementsRequest request, AsyncHandler<ListAnnouncementsRequest,ListAnnouncementsResponse> handler) Gets a list of announcements for the current tenancy.
void	refreshClient() Rebuilds the client from scratch.
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<UpdateAnnouncementUserStatusResponse>	updateAnnouncementUserStatus(UpdateAnnouncementUserStatusRequest request, AsyncHandler<UpdateAnnouncementUserStatusRequest,UpdateAnnouncementUserStatusResponse> handler) Updates the status of the specified announcement with regard to whether it has been marked as read.
void	useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled) Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

refreshClient

void refreshClient()

Rebuilds the client from scratch. Useful to refresh certificates.

setEndpoint

void setEndpoint(String endpoint)

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

Parameters:

endpoint - The endpoint of the serice.

getEndpoint

String getEndpoint()

Gets the set endpoint for REST call (ex, https://www.example.com)

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.

useRealmSpecificEndpointTemplate

void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)

Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

Parameters:

realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

getAnnouncement

Future<GetAnnouncementResponse> getAnnouncement(GetAnnouncementRequest request,
                                                AsyncHandler<GetAnnouncementRequest,GetAnnouncementResponse> handler)

Gets the details of a specific announcement.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getAnnouncementCompartment

Future<GetAnnouncementCompartmentResponse> getAnnouncementCompartment(GetAnnouncementCompartmentRequest request,
                                                                      AsyncHandler<GetAnnouncementCompartmentRequest,GetAnnouncementCompartmentResponse> handler)

Gets the compartment details of an announcement.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

getAnnouncementUserStatus

Future<GetAnnouncementUserStatusResponse> getAnnouncementUserStatus(GetAnnouncementUserStatusRequest request,
                                                                    AsyncHandler<GetAnnouncementUserStatusRequest,GetAnnouncementUserStatusResponse> handler)

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

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

listAnnouncements

Future<ListAnnouncementsResponse> listAnnouncements(ListAnnouncementsRequest request,
                                                    AsyncHandler<ListAnnouncementsRequest,ListAnnouncementsResponse> handler)

Gets a list of announcements for the current tenancy.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

updateAnnouncementUserStatus

Future<UpdateAnnouncementUserStatusResponse> updateAnnouncementUserStatus(UpdateAnnouncementUserStatusRequest request,
                                                                          AsyncHandler<UpdateAnnouncementUserStatusRequest,UpdateAnnouncementUserStatusResponse> handler)

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

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:

request - The request object containing the details to send

handler - The request handler to invoke upon completion, may be null.

Returns:

A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.