com.oracle.bmc.osmanagement

Class EventClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.osmanagement.EventClient

All Implemented Interfaces:

Event, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190801")
public class EventClient
extends BaseSyncClient
implements Event

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventClient.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
EventClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Deprecated. Use the builder instead.
EventClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Deprecated. Use the builder instead.
EventClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
EventClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Deprecated. Use the builder instead.
EventClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Deprecated. Use the builder instead.
EventClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Deprecated. Use the builder instead.
EventClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Deprecated. Use the builder instead.

Method Summary

Modifier and Type	Method and Description
static EventClient.Builder	builder() Create a builder for this client.
void	close()
DeleteEventContentResponse	deleteEventContent(DeleteEventContentRequest request) Delete an event content ZIP archive from the service
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
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.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
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	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.
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
void	useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled) This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

clientCall

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

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

EventClient

@Deprecated
public EventClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

EventClient

@Deprecated
public EventClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                               ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

EventClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

EventClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

EventClient

@Deprecated
public EventClient(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 EventClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

EventClient

@Deprecated
public EventClient(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 EventClient.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)

EventClient

@Deprecated
public EventClient(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 EventClient.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 EventClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Event

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 Event

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Event

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 Event

Parameters:

regionId - The public region ID.

deleteEventContent

public DeleteEventContentResponse deleteEventContent(DeleteEventContentRequest request)

Description copied from interface: Event

Delete an event content ZIP archive from the service

Specified by:

deleteEventContent in interface Event

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getEvent

public GetEventResponse getEvent(GetEventRequest request)

Description copied from interface: Event

Gets an Event by identifier

Specified by:

getEvent in interface Event

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getEventContent

public GetEventContentResponse getEventContent(GetEventContentRequest request)

Description copied from interface: Event

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

Specified by:

getEventContent in interface Event

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getEventReport

public GetEventReportResponse getEventReport(GetEventReportRequest request)

Description copied from interface: Event

Get summary information about events on this instance.

Specified by:

getEventReport in interface Event

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listEvents

public ListEventsResponse listEvents(ListEventsRequest request)

Description copied from interface: Event

Returns a list of Events.

Specified by:

listEvents in interface Event

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listRelatedEvents

public ListRelatedEventsResponse listRelatedEvents(ListRelatedEventsRequest request)

Description copied from interface: Event

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

Specified by:

listRelatedEvents in interface Event

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateEvent

public UpdateEventResponse updateEvent(UpdateEventRequest request)

Description copied from interface: Event

Updates an existing event associated to a managed instance

Specified by:

updateEvent in interface Event

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

uploadEventContent

public UploadEventContentResponse uploadEventContent(UploadEventContentRequest request)

Description copied from interface: Event

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

Specified by:

uploadEventContent in interface Event

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPaginators

public EventPaginators getPaginators()

Description copied from interface: Event

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 Event

Returns:

The service paginators.

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()