com.oracle.bmc.events

Interface EventsAsync

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

EventsAsyncClient

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public interface EventsAsync
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
Future<ChangeRuleCompartmentResponse>	changeRuleCompartment(ChangeRuleCompartmentRequest request, AsyncHandler<ChangeRuleCompartmentRequest,ChangeRuleCompartmentResponse> handler) Moves a rule into a different compartment within the same tenancy.
Future<CreateRuleResponse>	createRule(CreateRuleRequest request, AsyncHandler<CreateRuleRequest,CreateRuleResponse> handler) Creates a new rule.
Future<DeleteRuleResponse>	deleteRule(DeleteRuleRequest request, AsyncHandler<DeleteRuleRequest,DeleteRuleResponse> handler) Deletes a rule.
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
Future<GetRuleResponse>	getRule(GetRuleRequest request, AsyncHandler<GetRuleRequest,GetRuleResponse> handler) Retrieves a rule.
Future<ListRulesResponse>	listRules(ListRulesRequest request, AsyncHandler<ListRulesRequest,ListRulesResponse> handler) Lists rules for this compartment.
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<UpdateRuleResponse>	updateRule(UpdateRuleRequest request, AsyncHandler<UpdateRuleRequest,UpdateRuleResponse> handler) Updates a rule.
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

changeRuleCompartment

Future<ChangeRuleCompartmentResponse> changeRuleCompartment(ChangeRuleCompartmentRequest request,
                                                            AsyncHandler<ChangeRuleCompartmentRequest,ChangeRuleCompartmentResponse> handler)

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

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.

createRule

Future<CreateRuleResponse> createRule(CreateRuleRequest request,
                                      AsyncHandler<CreateRuleRequest,CreateRuleResponse> handler)

Creates a new rule.

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.

deleteRule

Future<DeleteRuleResponse> deleteRule(DeleteRuleRequest request,
                                      AsyncHandler<DeleteRuleRequest,DeleteRuleResponse> handler)

Deletes a rule.

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.

getRule

Future<GetRuleResponse> getRule(GetRuleRequest request,
                                AsyncHandler<GetRuleRequest,GetRuleResponse> handler)

Retrieves a rule.

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.

listRules

Future<ListRulesResponse> listRules(ListRulesRequest request,
                                    AsyncHandler<ListRulesRequest,ListRulesResponse> handler)

Lists rules for this 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.

updateRule

Future<UpdateRuleResponse> updateRule(UpdateRuleRequest request,
                                      AsyncHandler<UpdateRuleRequest,UpdateRuleResponse> handler)

Updates a rule.

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.