com.oracle.bmc.events

Class EventsClient

java.lang.Object

com.oracle.bmc.events.EventsClient

All Implemented Interfaces:

Events, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public class EventsClient
extends Object
implements Events

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventsClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for Events.

Constructor Summary

Constructors

Modifier	Constructor and Description
	EventsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	EventsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	EventsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	EventsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	EventsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Creates a new service instance using the given authentication provider and client configuration.
protected	EventsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder) Creates a new service instance using the given authentication provider and client configuration.
	EventsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	EventsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	EventsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Creates a new service instance using the given authentication provider and client configuration.

Method Summary

Modifier and Type	Method and Description
static EventsClient.Builder	builder() Create a builder for this client.
ChangeRuleCompartmentResponse	changeRuleCompartment(ChangeRuleCompartmentRequest request) Moves a rule into a different compartment within the same tenancy.
void	close()
CreateRuleResponse	createRule(CreateRuleRequest request) Creates a new rule.
DeleteRuleResponse	deleteRule(DeleteRuleRequest request) Deletes a rule.
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Events.

Constructor Detail

EventsClient

public EventsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

EventsClient

public EventsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration)

Creates a new service instance using the given authentication provider and client configuration.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

EventsClient

public EventsClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

EventsClient

public EventsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

EventsClient

public EventsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory,
                    List<ClientConfigurator> additionalClientConfigurators)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

EventsClient

public EventsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory,
                    List<ClientConfigurator> additionalClientConfigurators,
                    String endpoint)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

EventsClient

public EventsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory,
                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                    List<ClientConfigurator> additionalClientConfigurators,
                    String endpoint)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

EventsClient

public EventsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                    ClientConfiguration configuration,
                    ClientConfigurator clientConfigurator,
                    RequestSignerFactory defaultRequestSignerFactory,
                    Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                    List<ClientConfigurator> additionalClientConfigurators,
                    String endpoint,
                    ExecutorService executorService)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

EventsClient

protected EventsClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint,
                       ExecutorService executorService,
                       com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed. Use the EventsClient.Builder to get access to all these parameters.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

restClientFactoryBuilder - the builder for the RestClientFactory

Method Detail

builder

public static EventsClient.Builder builder()

Create a builder for this client.

Returns:

builder

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: Events

Sets the endpoint to call (ex, https://www.example.com).

Specified by:

setEndpoint in interface Events

Parameters:

endpoint - The endpoint of the service.

setRegion

public void setRegion(Region region)

Description copied from interface: Events

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.

Specified by:

setRegion in interface Events

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Events

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.

Specified by:

setRegion in interface Events

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

changeRuleCompartment

public ChangeRuleCompartmentResponse changeRuleCompartment(ChangeRuleCompartmentRequest request)

Description copied from interface: Events

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.

Specified by:

changeRuleCompartment in interface Events

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createRule

public CreateRuleResponse createRule(CreateRuleRequest request)

Description copied from interface: Events

Creates a new rule.

Specified by:

createRule in interface Events

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteRule

public DeleteRuleResponse deleteRule(DeleteRuleRequest request)

Description copied from interface: Events

Deletes a rule.

Specified by:

deleteRule in interface Events

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getRule

public GetRuleResponse getRule(GetRuleRequest request)

Description copied from interface: Events

Retrieves a rule.

Specified by:

getRule in interface Events

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRules

public ListRulesResponse listRules(ListRulesRequest request)

Description copied from interface: Events

Lists rules for this compartment.

Specified by:

listRules in interface Events

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateRule

public UpdateRuleResponse updateRule(UpdateRuleRequest request)

Description copied from interface: Events

Updates a rule.

Specified by:

updateRule in interface Events

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public EventsWaiters getWaiters()

Description copied from interface: Events

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

Specified by:

getWaiters in interface Events

Returns:

The service waiters.

getPaginators

public EventsPaginators getPaginators()

Description copied from interface: Events

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.

Specified by:

getPaginators in interface Events

Returns:

The service paginators.