com.oracle.bmc.osmanagement

Interface Event

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

EventClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190801")
public interface Event
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
DeleteEventContentResponse	deleteEventContent(DeleteEventContentRequest request) Delete an event content ZIP archive from the service
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
GetEventResponse	getEvent(GetEventRequest request) Gets an Event by identifier
GetEventContentResponse	getEventContent(GetEventContentRequest request) Get additional data about a event as a ZIP archive.
GetEventReportResponse	getEventReport(GetEventReportRequest request) Get summary information about events on this instance.
EventPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
ListEventsResponse	listEvents(ListEventsRequest request) Returns a list of Events.
ListRelatedEventsResponse	listRelatedEvents(ListRelatedEventsRequest request) Returns a list of related events.
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’).
UpdateEventResponse	updateEvent(UpdateEventRequest request) Updates an existing event associated to a managed instance
UploadEventContentResponse	uploadEventContent(UploadEventContentRequest request) Upload the event content as a ZIP archive from the managed instance to the service

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.

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.

deleteEventContent

DeleteEventContentResponse deleteEventContent(DeleteEventContentRequest request)

Delete an event content ZIP archive from the service

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.

Example: Click here to see how to use DeleteEventContent API.

getEvent

GetEventResponse getEvent(GetEventRequest request)

Gets an Event by identifier

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.

Example: Click here to see how to use GetEvent API.

getEventContent

GetEventContentResponse getEventContent(GetEventContentRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use GetEventContent API.

getEventReport

GetEventReportResponse getEventReport(GetEventReportRequest request)

Get summary information about events on this instance.

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.

Example: Click here to see how to use GetEventReport API.

listEvents

ListEventsResponse listEvents(ListEventsRequest request)

Returns a list of Events.

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.

Example: Click here to see how to use ListEvents API.

listRelatedEvents

ListRelatedEventsResponse listRelatedEvents(ListRelatedEventsRequest request)

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

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.

Example: Click here to see how to use ListRelatedEvents API.

updateEvent

UpdateEventResponse updateEvent(UpdateEventRequest request)

Updates an existing event associated to a managed instance

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.

Example: Click here to see how to use UpdateEvent API.

uploadEventContent

UploadEventContentResponse uploadEventContent(UploadEventContentRequest request)

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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

Example: Click here to see how to use UploadEventContent API.

getPaginators

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