com.oracle.bmc.logging

Class LoggingManagementAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.logging.LoggingManagementAsyncClient

All Implemented Interfaces:

LoggingManagementAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200531")
public class LoggingManagementAsyncClient
extends BaseAsyncClient
implements LoggingManagementAsync

Async client implementation for LoggingManagement 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	LoggingManagementAsyncClient.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 LoggingManagement.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static LoggingManagementAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeLogGroupCompartmentResponse>	changeLogGroupCompartment(ChangeLogGroupCompartmentRequest request, AsyncHandler<ChangeLogGroupCompartmentRequest,ChangeLogGroupCompartmentResponse> handler) Moves a log group into a different compartment within the same tenancy.
Future<ChangeLogLogGroupResponse>	changeLogLogGroup(ChangeLogLogGroupRequest request, AsyncHandler<ChangeLogLogGroupRequest,ChangeLogLogGroupResponse> handler) Moves a log into a different log group within the same tenancy.
Future<ChangeLogSavedSearchCompartmentResponse>	changeLogSavedSearchCompartment(ChangeLogSavedSearchCompartmentRequest request, AsyncHandler<ChangeLogSavedSearchCompartmentRequest,ChangeLogSavedSearchCompartmentResponse> handler) Moves a saved search into a different compartment within the same tenancy.
Future<ChangeUnifiedAgentConfigurationCompartmentResponse>	changeUnifiedAgentConfigurationCompartment(ChangeUnifiedAgentConfigurationCompartmentRequest request, AsyncHandler<ChangeUnifiedAgentConfigurationCompartmentRequest,ChangeUnifiedAgentConfigurationCompartmentResponse> handler) Moves the unified agent configuration into a different compartment within the same tenancy.
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<CreateLogResponse>	createLog(CreateLogRequest request, AsyncHandler<CreateLogRequest,CreateLogResponse> handler) Creates a log within the specified log group.
Future<CreateLogGroupResponse>	createLogGroup(CreateLogGroupRequest request, AsyncHandler<CreateLogGroupRequest,CreateLogGroupResponse> handler) Create a new log group with a unique display name.
Future<CreateLogSavedSearchResponse>	createLogSavedSearch(CreateLogSavedSearchRequest request, AsyncHandler<CreateLogSavedSearchRequest,CreateLogSavedSearchResponse> handler) Creates a new LogSavedSearch.
Future<CreateUnifiedAgentConfigurationResponse>	createUnifiedAgentConfiguration(CreateUnifiedAgentConfigurationRequest request, AsyncHandler<CreateUnifiedAgentConfigurationRequest,CreateUnifiedAgentConfigurationResponse> handler) Create unified agent configuration registration.
Future<DeleteLogResponse>	deleteLog(DeleteLogRequest request, AsyncHandler<DeleteLogRequest,DeleteLogResponse> handler) Deletes the log object in a log group.
Future<DeleteLogGroupResponse>	deleteLogGroup(DeleteLogGroupRequest request, AsyncHandler<DeleteLogGroupRequest,DeleteLogGroupResponse> handler) Deletes the specified log group.
Future<DeleteLogSavedSearchResponse>	deleteLogSavedSearch(DeleteLogSavedSearchRequest request, AsyncHandler<DeleteLogSavedSearchRequest,DeleteLogSavedSearchResponse> handler) Deletes the specified LogSavedSearch.
Future<DeleteUnifiedAgentConfigurationResponse>	deleteUnifiedAgentConfiguration(DeleteUnifiedAgentConfigurationRequest request, AsyncHandler<DeleteUnifiedAgentConfigurationRequest,DeleteUnifiedAgentConfigurationResponse> handler) Delete unified agent configuration.
Future<DeleteWorkRequestResponse>	deleteWorkRequest(DeleteWorkRequestRequest request, AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler) Cancel a work request that has not started yet.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetLogResponse>	getLog(GetLogRequest request, AsyncHandler<GetLogRequest,GetLogResponse> handler) Gets the log object configuration for the log object OCID.
Future<GetLogGroupResponse>	getLogGroup(GetLogGroupRequest request, AsyncHandler<GetLogGroupRequest,GetLogGroupResponse> handler) Get the specified log group’s information.
Future<GetLogSavedSearchResponse>	getLogSavedSearch(GetLogSavedSearchRequest request, AsyncHandler<GetLogSavedSearchRequest,GetLogSavedSearchResponse> handler) Retrieves a LogSavedSearch.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<GetUnifiedAgentConfigurationResponse>	getUnifiedAgentConfiguration(GetUnifiedAgentConfigurationRequest request, AsyncHandler<GetUnifiedAgentConfigurationRequest,GetUnifiedAgentConfigurationResponse> handler) Get the unified agent configuration for an ID.
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the details of the work request with the given ID.
Future<ListLogGroupsResponse>	listLogGroups(ListLogGroupsRequest request, AsyncHandler<ListLogGroupsRequest,ListLogGroupsResponse> handler) Lists all log groups for the specified compartment or tenancy.
Future<ListLogsResponse>	listLogs(ListLogsRequest request, AsyncHandler<ListLogsRequest,ListLogsResponse> handler) Lists the specified log group’s log objects.
Future<ListLogSavedSearchesResponse>	listLogSavedSearches(ListLogSavedSearchesRequest request, AsyncHandler<ListLogSavedSearchesRequest,ListLogSavedSearchesResponse> handler) Lists LogSavedSearches for this compartment.
Future<ListServicesResponse>	listServices(ListServicesRequest request, AsyncHandler<ListServicesRequest,ListServicesResponse> handler) Lists all services that support logging.
Future<ListUnifiedAgentConfigurationsResponse>	listUnifiedAgentConfigurations(ListUnifiedAgentConfigurationsRequest request, AsyncHandler<ListUnifiedAgentConfigurationsRequest,ListUnifiedAgentConfigurationsResponse> handler) Lists all unified agent configurations in the specified compartment.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Return a list of errors for a given work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Return a list of logs for a given work request.
Future<ListWorkRequestsResponse>	listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler) Lists the work requests in a compartment.
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<UpdateLogResponse>	updateLog(UpdateLogRequest request, AsyncHandler<UpdateLogRequest,UpdateLogResponse> handler) Updates the existing log object with the associated configuration.
Future<UpdateLogGroupResponse>	updateLogGroup(UpdateLogGroupRequest request, AsyncHandler<UpdateLogGroupRequest,UpdateLogGroupResponse> handler) Updates the existing log group with the associated configuration.
Future<UpdateLogSavedSearchResponse>	updateLogSavedSearch(UpdateLogSavedSearchRequest request, AsyncHandler<UpdateLogSavedSearchRequest,UpdateLogSavedSearchResponse> handler) Updates an existing LogSavedSearch.
Future<UpdateUnifiedAgentConfigurationResponse>	updateUnifiedAgentConfiguration(UpdateUnifiedAgentConfigurationRequest request, AsyncHandler<UpdateUnifiedAgentConfigurationRequest,UpdateUnifiedAgentConfigurationResponse> handler) Update an existing unified agent configuration.
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.logging.LoggingManagementAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for LoggingManagement.

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

LoggingManagementAsyncClient

@Deprecated
public LoggingManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

LoggingManagementAsyncClient

@Deprecated
public LoggingManagementAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                                ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

LoggingManagementAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

LoggingManagementAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

LoggingManagementAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

LoggingManagementAsyncClient

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

LoggingManagementAsyncClient

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

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: LoggingManagementAsync

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 LoggingManagementAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: LoggingManagementAsync

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 LoggingManagementAsync

Parameters:

regionId - The public region ID.

changeLogGroupCompartment

public Future<ChangeLogGroupCompartmentResponse> changeLogGroupCompartment(ChangeLogGroupCompartmentRequest request,
                                                                           AsyncHandler<ChangeLogGroupCompartmentRequest,ChangeLogGroupCompartmentResponse> handler)

Description copied from interface: LoggingManagementAsync

Moves a log group into a different compartment within the same tenancy. When provided, the If-Match is checked against the resource ETag values. For information about moving resources between compartments, see Moving Resources Between Compartments.

Specified by:

changeLogGroupCompartment in interface LoggingManagementAsync

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.

changeLogLogGroup

public Future<ChangeLogLogGroupResponse> changeLogLogGroup(ChangeLogLogGroupRequest request,
                                                           AsyncHandler<ChangeLogLogGroupRequest,ChangeLogLogGroupResponse> handler)

Description copied from interface: LoggingManagementAsync

Moves a log into a different log group within the same tenancy. When provided, the If-Match is checked against the ETag values of the resource.

Specified by:

changeLogLogGroup in interface LoggingManagementAsync

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.

changeLogSavedSearchCompartment

public Future<ChangeLogSavedSearchCompartmentResponse> changeLogSavedSearchCompartment(ChangeLogSavedSearchCompartmentRequest request,
                                                                                       AsyncHandler<ChangeLogSavedSearchCompartmentRequest,ChangeLogSavedSearchCompartmentResponse> handler)

Description copied from interface: LoggingManagementAsync

Moves a saved search into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Specified by:

changeLogSavedSearchCompartment in interface LoggingManagementAsync

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.

changeUnifiedAgentConfigurationCompartment

public Future<ChangeUnifiedAgentConfigurationCompartmentResponse> changeUnifiedAgentConfigurationCompartment(ChangeUnifiedAgentConfigurationCompartmentRequest request,
                                                                                                             AsyncHandler<ChangeUnifiedAgentConfigurationCompartmentRequest,ChangeUnifiedAgentConfigurationCompartmentResponse> handler)

Description copied from interface: LoggingManagementAsync

Moves the unified agent configuration into a different compartment within the same tenancy. When provided, the If-Match is checked against the ETag values of the resource. For information about moving resources between compartments, see Moving Resources Between Compartments.

Specified by:

changeUnifiedAgentConfigurationCompartment in interface LoggingManagementAsync

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.

createLog

public Future<CreateLogResponse> createLog(CreateLogRequest request,
                                           AsyncHandler<CreateLogRequest,CreateLogResponse> handler)

Description copied from interface: LoggingManagementAsync

Creates a log within the specified log group. This call fails if a log group has already been created with the same displayName or (service, resource, category) triplet.

Specified by:

createLog in interface LoggingManagementAsync

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.

createLogGroup

public Future<CreateLogGroupResponse> createLogGroup(CreateLogGroupRequest request,
                                                     AsyncHandler<CreateLogGroupRequest,CreateLogGroupResponse> handler)

Description copied from interface: LoggingManagementAsync

Create a new log group with a unique display name. This call fails if the log group is already created with the same displayName in the compartment.

Specified by:

createLogGroup in interface LoggingManagementAsync

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.

createLogSavedSearch

public Future<CreateLogSavedSearchResponse> createLogSavedSearch(CreateLogSavedSearchRequest request,
                                                                 AsyncHandler<CreateLogSavedSearchRequest,CreateLogSavedSearchResponse> handler)

Description copied from interface: LoggingManagementAsync

Creates a new LogSavedSearch.

Specified by:

createLogSavedSearch in interface LoggingManagementAsync

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.

createUnifiedAgentConfiguration

public Future<CreateUnifiedAgentConfigurationResponse> createUnifiedAgentConfiguration(CreateUnifiedAgentConfigurationRequest request,
                                                                                       AsyncHandler<CreateUnifiedAgentConfigurationRequest,CreateUnifiedAgentConfigurationResponse> handler)

Description copied from interface: LoggingManagementAsync

Create unified agent configuration registration.

Specified by:

createUnifiedAgentConfiguration in interface LoggingManagementAsync

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.

deleteLog

public Future<DeleteLogResponse> deleteLog(DeleteLogRequest request,
                                           AsyncHandler<DeleteLogRequest,DeleteLogResponse> handler)

Description copied from interface: LoggingManagementAsync

Deletes the log object in a log group.

Specified by:

deleteLog in interface LoggingManagementAsync

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.

deleteLogGroup

public Future<DeleteLogGroupResponse> deleteLogGroup(DeleteLogGroupRequest request,
                                                     AsyncHandler<DeleteLogGroupRequest,DeleteLogGroupResponse> handler)

Description copied from interface: LoggingManagementAsync

Deletes the specified log group.

Specified by:

deleteLogGroup in interface LoggingManagementAsync

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.

deleteLogSavedSearch

public Future<DeleteLogSavedSearchResponse> deleteLogSavedSearch(DeleteLogSavedSearchRequest request,
                                                                 AsyncHandler<DeleteLogSavedSearchRequest,DeleteLogSavedSearchResponse> handler)

Description copied from interface: LoggingManagementAsync

Deletes the specified LogSavedSearch.

Specified by:

deleteLogSavedSearch in interface LoggingManagementAsync

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.

deleteUnifiedAgentConfiguration

public Future<DeleteUnifiedAgentConfigurationResponse> deleteUnifiedAgentConfiguration(DeleteUnifiedAgentConfigurationRequest request,
                                                                                       AsyncHandler<DeleteUnifiedAgentConfigurationRequest,DeleteUnifiedAgentConfigurationResponse> handler)

Description copied from interface: LoggingManagementAsync

Delete unified agent configuration.

Specified by:

deleteUnifiedAgentConfiguration in interface LoggingManagementAsync

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.

deleteWorkRequest

public Future<DeleteWorkRequestResponse> deleteWorkRequest(DeleteWorkRequestRequest request,
                                                           AsyncHandler<DeleteWorkRequestRequest,DeleteWorkRequestResponse> handler)

Description copied from interface: LoggingManagementAsync

Cancel a work request that has not started yet.

Specified by:

deleteWorkRequest in interface LoggingManagementAsync

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.

getLog

public Future<GetLogResponse> getLog(GetLogRequest request,
                                     AsyncHandler<GetLogRequest,GetLogResponse> handler)

Description copied from interface: LoggingManagementAsync

Gets the log object configuration for the log object OCID.

Specified by:

getLog in interface LoggingManagementAsync

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.

getLogGroup

public Future<GetLogGroupResponse> getLogGroup(GetLogGroupRequest request,
                                               AsyncHandler<GetLogGroupRequest,GetLogGroupResponse> handler)

Description copied from interface: LoggingManagementAsync

Get the specified log group’s information.

Specified by:

getLogGroup in interface LoggingManagementAsync

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.

getLogSavedSearch

public Future<GetLogSavedSearchResponse> getLogSavedSearch(GetLogSavedSearchRequest request,
                                                           AsyncHandler<GetLogSavedSearchRequest,GetLogSavedSearchResponse> handler)

Description copied from interface: LoggingManagementAsync

Retrieves a LogSavedSearch.

Specified by:

getLogSavedSearch in interface LoggingManagementAsync

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.

getUnifiedAgentConfiguration

public Future<GetUnifiedAgentConfigurationResponse> getUnifiedAgentConfiguration(GetUnifiedAgentConfigurationRequest request,
                                                                                 AsyncHandler<GetUnifiedAgentConfigurationRequest,GetUnifiedAgentConfigurationResponse> handler)

Description copied from interface: LoggingManagementAsync

Get the unified agent configuration for an ID.

Specified by:

getUnifiedAgentConfiguration in interface LoggingManagementAsync

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.

getWorkRequest

public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request,
                                                     AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)

Description copied from interface: LoggingManagementAsync

Gets the details of the work request with the given ID.

Specified by:

getWorkRequest in interface LoggingManagementAsync

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.

listLogGroups

public Future<ListLogGroupsResponse> listLogGroups(ListLogGroupsRequest request,
                                                   AsyncHandler<ListLogGroupsRequest,ListLogGroupsResponse> handler)

Description copied from interface: LoggingManagementAsync

Lists all log groups for the specified compartment or tenancy.

Specified by:

listLogGroups in interface LoggingManagementAsync

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.

listLogSavedSearches

public Future<ListLogSavedSearchesResponse> listLogSavedSearches(ListLogSavedSearchesRequest request,
                                                                 AsyncHandler<ListLogSavedSearchesRequest,ListLogSavedSearchesResponse> handler)

Description copied from interface: LoggingManagementAsync

Lists LogSavedSearches for this compartment.

Specified by:

listLogSavedSearches in interface LoggingManagementAsync

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.

listLogs

public Future<ListLogsResponse> listLogs(ListLogsRequest request,
                                         AsyncHandler<ListLogsRequest,ListLogsResponse> handler)

Description copied from interface: LoggingManagementAsync

Lists the specified log group’s log objects.

Specified by:

listLogs in interface LoggingManagementAsync

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.

listServices

public Future<ListServicesResponse> listServices(ListServicesRequest request,
                                                 AsyncHandler<ListServicesRequest,ListServicesResponse> handler)

Description copied from interface: LoggingManagementAsync

Lists all services that support logging.

Specified by:

listServices in interface LoggingManagementAsync

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.

listUnifiedAgentConfigurations

public Future<ListUnifiedAgentConfigurationsResponse> listUnifiedAgentConfigurations(ListUnifiedAgentConfigurationsRequest request,
                                                                                     AsyncHandler<ListUnifiedAgentConfigurationsRequest,ListUnifiedAgentConfigurationsResponse> handler)

Description copied from interface: LoggingManagementAsync

Lists all unified agent configurations in the specified compartment.

Specified by:

listUnifiedAgentConfigurations in interface LoggingManagementAsync

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.

listWorkRequestErrors

public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request,
                                                                   AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)

Description copied from interface: LoggingManagementAsync

Return a list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface LoggingManagementAsync

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.

listWorkRequestLogs

public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request,
                                                               AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)

Description copied from interface: LoggingManagementAsync

Return a list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface LoggingManagementAsync

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.

listWorkRequests

public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request,
                                                         AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)

Description copied from interface: LoggingManagementAsync

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface LoggingManagementAsync

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.

updateLog

public Future<UpdateLogResponse> updateLog(UpdateLogRequest request,
                                           AsyncHandler<UpdateLogRequest,UpdateLogResponse> handler)

Description copied from interface: LoggingManagementAsync

Updates the existing log object with the associated configuration. This call fails if the log object does not exist.

Specified by:

updateLog in interface LoggingManagementAsync

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.

updateLogGroup

public Future<UpdateLogGroupResponse> updateLogGroup(UpdateLogGroupRequest request,
                                                     AsyncHandler<UpdateLogGroupRequest,UpdateLogGroupResponse> handler)

Description copied from interface: LoggingManagementAsync

Updates the existing log group with the associated configuration. This call fails if the log group does not exist.

Specified by:

updateLogGroup in interface LoggingManagementAsync

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.

updateLogSavedSearch

public Future<UpdateLogSavedSearchResponse> updateLogSavedSearch(UpdateLogSavedSearchRequest request,
                                                                 AsyncHandler<UpdateLogSavedSearchRequest,UpdateLogSavedSearchResponse> handler)

Description copied from interface: LoggingManagementAsync

Updates an existing LogSavedSearch.

Specified by:

updateLogSavedSearch in interface LoggingManagementAsync

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.

updateUnifiedAgentConfiguration

public Future<UpdateUnifiedAgentConfigurationResponse> updateUnifiedAgentConfiguration(UpdateUnifiedAgentConfigurationRequest request,
                                                                                       AsyncHandler<UpdateUnifiedAgentConfigurationRequest,UpdateUnifiedAgentConfigurationResponse> handler)

Description copied from interface: LoggingManagementAsync

Update an existing unified agent configuration. This call fails if the log group does not exist.

Specified by:

updateUnifiedAgentConfiguration in interface LoggingManagementAsync

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)