com.oracle.bmc.events

Interface Events

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

EventsClient

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

API for the Events Service. Use this API to manage rules and actions that create automation in your tenancy. For more information, see Overview of Events.

Method Summary

Modifier and Type	Method and Description
ChangeRuleCompartmentResponse	changeRuleCompartment(ChangeRuleCompartmentRequest request) Moves a rule into a different compartment within the same tenancy.
CreateRuleResponse	createRule(CreateRuleRequest request) Creates a new rule.
DeleteRuleResponse	deleteRule(DeleteRuleRequest request) Deletes a rule.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
EventsPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetRuleResponse	getRule(GetRuleRequest request) Retrieves a rule.
EventsWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
ListRulesResponse	listRules(ListRulesRequest request) Lists rules for this compartment.
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’).
UpdateRuleResponse	updateRule(UpdateRuleRequest request) Updates a rule.

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.

changeRuleCompartment

ChangeRuleCompartmentResponse changeRuleCompartment(ChangeRuleCompartmentRequest request)

Moves a rule 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

Returns:

A response object containing details about the completed operation

Throws:

BmcException - when an error occurs.

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

createRule

CreateRuleResponse createRule(CreateRuleRequest request)

Creates a new rule.

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 CreateRule API.

deleteRule

DeleteRuleResponse deleteRule(DeleteRuleRequest request)

Deletes a rule.

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 DeleteRule API.

getRule

GetRuleResponse getRule(GetRuleRequest request)

Retrieves a rule.

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 GetRule API.

listRules

ListRulesResponse listRules(ListRulesRequest request)

Lists rules for this compartment.

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 ListRules API.

updateRule

UpdateRuleResponse updateRule(UpdateRuleRequest request)

Updates a rule.

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 UpdateRule API.

getWaiters

EventsWaiters getWaiters()

Gets the pre-configured waiters available for resources for this service.

Returns:

The service waiters.

getPaginators

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