com.oracle.bmc.osmanagementhub

Interface EventAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

EventAsyncClient

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

Use the OS Management Hub API to manage and monitor updates and patches for instances in OCI, your private data center, or 3rd-party clouds. For more information, see Overview of OS Management Hub.

Method Summary

Modifier and Type	Method and Description
Future<ChangeEventCompartmentResponse>	changeEventCompartment(ChangeEventCompartmentRequest request, AsyncHandler<ChangeEventCompartmentRequest,ChangeEventCompartmentResponse> handler) Moves an event into a different compartment within the same tenancy.
Future<DeleteEventResponse>	deleteEvent(DeleteEventRequest request, AsyncHandler<DeleteEventRequest,DeleteEventResponse> handler) Deletes the specified event.
Future<DeleteEventContentResponse>	deleteEventContent(DeleteEventContentRequest request, AsyncHandler<DeleteEventContentRequest,DeleteEventContentResponse> handler) Deletes 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) Returns information about the specified event.
Future<GetEventContentResponse>	getEventContent(GetEventContentRequest request, AsyncHandler<GetEventContentRequest,GetEventContentResponse> handler) Returns a ZIP archive with additional information about an event.
Future<ImportEventContentResponse>	importEventContent(ImportEventContentRequest request, AsyncHandler<ImportEventContentRequest,ImportEventContentResponse> handler) Uploads an event content ZIP archive from an instance to the service.
Future<ListEventsResponse>	listEvents(ListEventsRequest request, AsyncHandler<ListEventsRequest,ListEventsResponse> handler) Lists events that match the specified criteria, such as compartment, state, and event type.
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 the tags for an event.
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

changeEventCompartment

Future<ChangeEventCompartmentResponse> changeEventCompartment(ChangeEventCompartmentRequest request,
                                                              AsyncHandler<ChangeEventCompartmentRequest,ChangeEventCompartmentResponse> handler)

Moves an event into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

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.

deleteEvent

Future<DeleteEventResponse> deleteEvent(DeleteEventRequest request,
                                        AsyncHandler<DeleteEventRequest,DeleteEventResponse> handler)

Deletes the specified event.

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.

deleteEventContent

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

Deletes 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)

Returns information about the specified event.

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)

Returns a ZIP archive with additional information about an event. The archive content depends on the event type.

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.

importEventContent

Future<ImportEventContentResponse> importEventContent(ImportEventContentRequest request,
                                                      AsyncHandler<ImportEventContentRequest,ImportEventContentResponse> handler)

Uploads an event content ZIP archive from an 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.

listEvents

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

Lists events that match the specified criteria, such as compartment, state, and event type.

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 the tags for an event.

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.