com.oracle.bmc.osmanagement

Interface EventAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

EventAsyncClient

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

API for the OS Management service. Use these API operations for working with Managed instances and Managed instance groups.

Method Summary

Modifier and Type	Method and Description
Future<DeleteEventContentResponse>	deleteEventContent(DeleteEventContentRequest request, AsyncHandler<DeleteEventContentRequest,DeleteEventContentResponse> handler) Delete an event content ZIP archive from the service
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetEventResponse>	getEvent(GetEventRequest request, AsyncHandler<GetEventRequest,GetEventResponse> handler) Gets an Event by identifier
Future<GetEventContentResponse>	getEventContent(GetEventContentRequest request, AsyncHandler<GetEventContentRequest,GetEventContentResponse> handler) Get additional data about a event as a ZIP archive.
Future<GetEventReportResponse>	getEventReport(GetEventReportRequest request, AsyncHandler<GetEventReportRequest,GetEventReportResponse> handler) Get summary information about events on this instance.
Future<ListEventsResponse>	listEvents(ListEventsRequest request, AsyncHandler<ListEventsRequest,ListEventsResponse> handler) Returns a list of Events.
Future<ListRelatedEventsResponse>	listRelatedEvents(ListRelatedEventsRequest request, AsyncHandler<ListRelatedEventsRequest,ListRelatedEventsResponse> handler) Returns a list of related events.
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<UpdateEventResponse>	updateEvent(UpdateEventRequest request, AsyncHandler<UpdateEventRequest,UpdateEventResponse> handler) Updates an existing event associated to a managed instance
Future<UploadEventContentResponse>	uploadEventContent(UploadEventContentRequest request, AsyncHandler<UploadEventContentRequest,UploadEventContentResponse> handler) Upload the event content as a ZIP archive from the managed instance to the service
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

deleteEventContent

Future<DeleteEventContentResponse> deleteEventContent(DeleteEventContentRequest request,
                                                      AsyncHandler<DeleteEventContentRequest,DeleteEventContentResponse> handler)

Delete an event content ZIP archive from the service

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.

getEvent

Future<GetEventResponse> getEvent(GetEventRequest request,
                                  AsyncHandler<GetEventRequest,GetEventResponse> handler)

Gets an Event by identifier

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.

getEventContent

Future<GetEventContentResponse> getEventContent(GetEventContentRequest request,
                                                AsyncHandler<GetEventContentRequest,GetEventContentResponse> handler)

Get additional data about a event as a ZIP archive. The archive content depends on the event eventType.

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.

getEventReport

Future<GetEventReportResponse> getEventReport(GetEventReportRequest request,
                                              AsyncHandler<GetEventReportRequest,GetEventReportResponse> handler)

Get summary information about events on this instance.

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.

listEvents

Future<ListEventsResponse> listEvents(ListEventsRequest request,
                                      AsyncHandler<ListEventsRequest,ListEventsResponse> handler)

Returns a list of Events.

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.

listRelatedEvents

Future<ListRelatedEventsResponse> listRelatedEvents(ListRelatedEventsRequest request,
                                                    AsyncHandler<ListRelatedEventsRequest,ListRelatedEventsResponse> handler)

Returns a list of related events. For now pagination is not implemented.

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.

updateEvent

Future<UpdateEventResponse> updateEvent(UpdateEventRequest request,
                                        AsyncHandler<UpdateEventRequest,UpdateEventResponse> handler)

Updates an existing event associated to a managed instance

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.

uploadEventContent

Future<UploadEventContentResponse> uploadEventContent(UploadEventContentRequest request,
                                                      AsyncHandler<UploadEventContentRequest,UploadEventContentResponse> handler)

Upload the event content as a ZIP archive from the managed instance to the service

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.