com.oracle.bmc.osmanagement

Class EventAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.osmanagement.EventAsyncClient

All Implemented Interfaces:

EventAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190801")
public class EventAsyncClient
extends BaseAsyncClient
implements EventAsync

Async client implementation for Event service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is an InputStream, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
String	clientCommonLibraryVersion Compatible SDK version, provided by the codegen.
Optional<String>	minimumClientCommonLibraryVersionFromClient Minimum compatible SDK version, maybe provided by the codegen.
static Service	SERVICE Service instance for Event.

Constructor Summary

Constructors

Constructor and Description
EventAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
EventAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
EventAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
EventAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
EventAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
EventAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
EventAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static EventAsyncClient.Builder	builder() Create a builder for this client.
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER>	clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
void	close()
Future<DeleteEventContentResponse>	deleteEventContent(DeleteEventContentRequest request, AsyncHandler<DeleteEventContentRequest,DeleteEventContentResponse> handler) Delete an event content ZIP archive from the service
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetEventResponse>	getEvent(GetEventRequest request, AsyncHandler<GetEventRequest,GetEventResponse> handler) Gets an Event by identifier
Future<GetEventContentResponse>	getEventContent(GetEventContentRequest request, AsyncHandler<GetEventContentRequest,GetEventContentResponse> handler) Get additional data about a event as a ZIP archive.
Future<GetEventReportResponse>	getEventReport(GetEventReportRequest request, AsyncHandler<GetEventReportRequest,GetEventReportResponse> handler) Get summary information about events on this instance.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<ListEventsResponse>	listEvents(ListEventsRequest request, AsyncHandler<ListEventsRequest,ListEventsResponse> handler) Returns a list of Events.
Future<ListRelatedEventsResponse>	listRelatedEvents(ListRelatedEventsRequest request, AsyncHandler<ListRelatedEventsRequest,ListRelatedEventsResponse> handler) Returns a list of related events.
void	populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap) Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
void	refreshClient() Rebuild the backing HttpClient.
void	setEndpoint(String endpoint)
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’).
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateEventResponse>	updateEvent(UpdateEventRequest request, AsyncHandler<UpdateEventRequest,UpdateEventResponse> handler) Updates an existing event associated to a managed instance
Future<UploadEventContentResponse>	uploadEventContent(UploadEventContentRequest request, AsyncHandler<UploadEventContentRequest,UploadEventContentResponse> handler) Upload the event content as a ZIP archive from the managed instance to the service
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.oracle.bmc.osmanagement.EventAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Event.

clientCommonLibraryVersion

public final String clientCommonLibraryVersion

Compatible SDK version, provided by the codegen.

minimumClientCommonLibraryVersionFromClient

public final Optional<String> minimumClientCommonLibraryVersionFromClient

Minimum compatible SDK version, maybe provided by the codegen.

Constructor Detail

EventAsyncClient

@Deprecated
public EventAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see EventAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

EventAsyncClient

@Deprecated
public EventAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see EventAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

EventAsyncClient

@Deprecated
public EventAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see EventAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

EventAsyncClient

@Deprecated
public EventAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                                    ClientConfiguration configuration,
                                    ClientConfigurator clientConfigurator,
                                    RequestSignerFactory defaultRequestSignerFactory)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see EventAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

EventAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see EventAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

EventAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see EventAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

EventAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see EventAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

endpoint - ClientBuilderBase.endpoint(java.lang.String)

signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories

Method Detail

builder

public static EventAsyncClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: EventAsync

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 EventAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: EventAsync

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 EventAsync

Parameters:

regionId - The public region ID.

deleteEventContent

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

Description copied from interface: EventAsync

Delete an event content ZIP archive from the service

Specified by:

deleteEventContent in interface EventAsync

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

public Future<GetEventResponse> getEvent(GetEventRequest request,
                                         AsyncHandler<GetEventRequest,GetEventResponse> handler)

Description copied from interface: EventAsync

Gets an Event by identifier

Specified by:

getEvent in interface EventAsync

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

public Future<GetEventContentResponse> getEventContent(GetEventContentRequest request,
                                                       AsyncHandler<GetEventContentRequest,GetEventContentResponse> handler)

Description copied from interface: EventAsync

Get additional data about a event as a ZIP archive. The archive content depends on the event eventType.

Specified by:

getEventContent in interface EventAsync

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.

getEventReport

public Future<GetEventReportResponse> getEventReport(GetEventReportRequest request,
                                                     AsyncHandler<GetEventReportRequest,GetEventReportResponse> handler)

Description copied from interface: EventAsync

Get summary information about events on this instance.

Specified by:

getEventReport in interface EventAsync

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

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

Description copied from interface: EventAsync

Returns a list of Events.

Specified by:

listEvents in interface EventAsync

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.

listRelatedEvents

public Future<ListRelatedEventsResponse> listRelatedEvents(ListRelatedEventsRequest request,
                                                           AsyncHandler<ListRelatedEventsRequest,ListRelatedEventsResponse> handler)

Description copied from interface: EventAsync

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

Specified by:

listRelatedEvents in interface EventAsync

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

public Future<UpdateEventResponse> updateEvent(UpdateEventRequest request,
                                               AsyncHandler<UpdateEventRequest,UpdateEventResponse> handler)

Description copied from interface: EventAsync

Updates an existing event associated to a managed instance

Specified by:

updateEvent in interface EventAsync

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.

uploadEventContent

public Future<UploadEventContentResponse> uploadEventContent(UploadEventContentRequest request,
                                                             AsyncHandler<UploadEventContentRequest,UploadEventContentResponse> handler)

Description copied from interface: EventAsync

Upload the event content as a ZIP archive from the managed instance to the service

Specified by:

uploadEventContent in interface EventAsync

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.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

useRealmSpecificEndpointTemplate

public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)

This method should be used to enable or disable the use of realm-specific endpoint template. The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false

Parameters:

useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively

populateServiceParametersInEndpoint

public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)

Populate the parameters in the endpoint with its corresponding value and update the base endpoint. The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.

Parameters:

endpoint - The endpoint template in use

requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value

updateBaseEndpoint

public final void updateBaseEndpoint(String endpoint)

This method should be used for parameterized endpoint templates only. This does not include {region} and {secondLevelDomain} parameters.

Parameters:

endpoint - The updated endpoint to use

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

refreshClient

public final void refreshClient()

Rebuild the backing HttpClient. This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.

close

public final void close()

Specified by:

close in interface AutoCloseable

getClientCommonLibraryVersion

public String getClientCommonLibraryVersion()

getMinimumClientCommonLibraryVersionFromClient

public Optional<String> getMinimumClientCommonLibraryVersionFromClient()

clientCall

protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request,
                                                                                                                                                           Supplier<RESP_BUILDER> responseBuilder)