com.oracle.bmc.audit

Class AuditClient

java.lang.Object

com.oracle.bmc.audit.AuditClient

All Implemented Interfaces:

Audit, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190901")
public class AuditClient
extends Object
implements Audit

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	AuditClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	AuditClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	AuditClient(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.
	AuditClient(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.
protected	AuditClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, com.oracle.bmc.http.internal.RestClientFactoryBuilder restClientFactoryBuilder) Creates a new service instance using the given authentication provider and client configuration.
	AuditClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	AuditClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	AuditClient(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 AuditClient.Builder	builder() Create a builder for this client.
void	close()
GetConfigurationResponse	getConfiguration(GetConfigurationRequest request) Get the configuration
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
AuditPaginators	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 all the audit events processed for the specified compartment within the specified time range.
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’).
UpdateConfigurationResponse	updateConfiguration(UpdateConfigurationRequest request) Update the configuration

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

Constructor Detail

AuditClient

public AuditClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

AuditClient

public AuditClient(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.

AuditClient

public AuditClient(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.

AuditClient

public AuditClient(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.

AuditClient

public AuditClient(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.

AuditClient

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

AuditClient

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

AuditClient

protected AuditClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                      ClientConfiguration configuration,
                      ClientConfigurator clientConfigurator,
                      RequestSignerFactory defaultRequestSignerFactory,
                      Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                      List<ClientConfigurator> additionalClientConfigurators,
                      String endpoint,
                      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 AuditClient.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)

restClientFactoryBuilder - the builder for the RestClientFactory

Method Detail

builder

public static AuditClient.Builder builder()

Create a builder for this client.

Returns:

builder

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: Audit

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

Specified by:

setEndpoint in interface Audit

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: Audit

Gets the set endpoint for REST call (ex, https://www.example.com)

Specified by:

getEndpoint in interface Audit

setRegion

public void setRegion(Region region)

Description copied from interface: Audit

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 Audit

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Audit

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 Audit

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

getConfiguration

public GetConfigurationResponse getConfiguration(GetConfigurationRequest request)

Description copied from interface: Audit

Get the configuration

Specified by:

getConfiguration in interface Audit

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: Audit

Returns all the audit events processed for the specified compartment within the specified time range.

Specified by:

listEvents in interface Audit

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateConfiguration

public UpdateConfigurationResponse updateConfiguration(UpdateConfigurationRequest request)

Description copied from interface: Audit

Update the configuration

Specified by:

updateConfiguration in interface Audit

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getPaginators

public AuditPaginators getPaginators()

Description copied from interface: Audit

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 Audit

Returns:

The service paginators.