com.oracle.bmc.loggingsearch

Class LogSearchClient

java.lang.Object

com.oracle.bmc.loggingsearch.LogSearchClient

All Implemented Interfaces:

LogSearch, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190909")
public class LogSearchClient
extends Object
implements LogSearch

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static com.oracle.bmc.Service	SERVICE Service instance for LogSearch.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static LogSearchClient.Builder	builder() Create a builder for this client.
void	close()
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
SearchLogsResponse	searchLogs(SearchLogsRequest request) Submit a query to search logs.
void	setEndpoint(String endpoint) Sets the endpoint to call (ex, https://www.example.com).
void	setRegion(com.oracle.bmc.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’).

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE

public static final com.oracle.bmc.Service SERVICE

Service instance for LogSearch.

Constructor Detail

LogSearchClient

public LogSearchClient(com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

LogSearchClient

public LogSearchClient(com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                       com.oracle.bmc.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.

LogSearchClient

public LogSearchClient(com.oracle.bmc.auth.BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                       com.oracle.bmc.ClientConfiguration configuration,
                       com.oracle.bmc.http.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.

LogSearchClient

public LogSearchClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       com.oracle.bmc.ClientConfiguration configuration,
                       com.oracle.bmc.http.ClientConfigurator clientConfigurator,
                       com.oracle.bmc.http.signing.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.

LogSearchClient

public LogSearchClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       com.oracle.bmc.ClientConfiguration configuration,
                       com.oracle.bmc.http.ClientConfigurator clientConfigurator,
                       com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory,
                       List<com.oracle.bmc.http.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.

LogSearchClient

public LogSearchClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       com.oracle.bmc.ClientConfiguration configuration,
                       com.oracle.bmc.http.ClientConfigurator clientConfigurator,
                       com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory,
                       List<com.oracle.bmc.http.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)

LogSearchClient

public LogSearchClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       com.oracle.bmc.ClientConfiguration configuration,
                       com.oracle.bmc.http.ClientConfigurator clientConfigurator,
                       com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory,
                       Map<com.oracle.bmc.http.signing.SigningStrategy,com.oracle.bmc.http.signing.RequestSignerFactory> signingStrategyRequestSignerFactories,
                       List<com.oracle.bmc.http.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)

LogSearchClient

protected LogSearchClient(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                          com.oracle.bmc.ClientConfiguration configuration,
                          com.oracle.bmc.http.ClientConfigurator clientConfigurator,
                          com.oracle.bmc.http.signing.RequestSignerFactory defaultRequestSignerFactory,
                          Map<com.oracle.bmc.http.signing.SigningStrategy,com.oracle.bmc.http.signing.RequestSignerFactory> signingStrategyRequestSignerFactories,
                          List<com.oracle.bmc.http.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 LogSearchClient.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 LogSearchClient.Builder builder()

Create a builder for this client.

Returns:

builder

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: LogSearch

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

Specified by:

setEndpoint in interface LogSearch

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: LogSearch

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

Specified by:

getEndpoint in interface LogSearch

setRegion

public void setRegion(com.oracle.bmc.Region region)

Description copied from interface: LogSearch

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 LogSearch

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: LogSearch

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 LogSearch

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

searchLogs

public SearchLogsResponse searchLogs(SearchLogsRequest request)

Description copied from interface: LogSearch

Submit a query to search logs.

Specified by:

searchLogs in interface LogSearch

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation