com.oracle.bmc.stackmonitoring

Class StackMonitoringAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.stackmonitoring.StackMonitoringAsyncClient

All Implemented Interfaces:

StackMonitoringAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210330")
public class StackMonitoringAsyncClient
extends BaseAsyncClient
implements StackMonitoringAsync

Async client implementation for StackMonitoring 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	StackMonitoringAsyncClient.Builder Builder class for this client.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Future<AssociateMonitoredResourcesResponse>	associateMonitoredResources(AssociateMonitoredResourcesRequest request, AsyncHandler<AssociateMonitoredResourcesRequest,AssociateMonitoredResourcesResponse> handler) Create an association between two monitored resources.
static StackMonitoringAsyncClient.Builder	builder() Create a builder for this client.
Future<ChangeMonitoredResourceCompartmentResponse>	changeMonitoredResourceCompartment(ChangeMonitoredResourceCompartmentRequest request, AsyncHandler<ChangeMonitoredResourceCompartmentRequest,ChangeMonitoredResourceCompartmentResponse> handler) Moves a monitored resource from one compartment to another.
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<CreateDiscoveryJobResponse>	createDiscoveryJob(CreateDiscoveryJobRequest request, AsyncHandler<CreateDiscoveryJobRequest,CreateDiscoveryJobResponse> handler) API to create discovery Job and submit discovery Details to agent.
Future<CreateMonitoredResourceResponse>	createMonitoredResource(CreateMonitoredResourceRequest request, AsyncHandler<CreateMonitoredResourceRequest,CreateMonitoredResourceResponse> handler) Creates a new monitored resource for the given resource type with the details and submits a work request for promoting the resource to agent.
Future<DeleteDiscoveryJobResponse>	deleteDiscoveryJob(DeleteDiscoveryJobRequest request, AsyncHandler<DeleteDiscoveryJobRequest,DeleteDiscoveryJobResponse> handler) Deletes a DiscoveryJob by identifier
Future<DeleteMonitoredResourceResponse>	deleteMonitoredResource(DeleteMonitoredResourceRequest request, AsyncHandler<DeleteMonitoredResourceRequest,DeleteMonitoredResourceResponse> handler) Delete monitored resource by the given identifier OCID.
Future<DisableExternalDatabaseResponse>	disableExternalDatabase(DisableExternalDatabaseRequest request, AsyncHandler<DisableExternalDatabaseRequest,DisableExternalDatabaseResponse> handler) Disable external database resource monitoring.
Future<DisassociateMonitoredResourcesResponse>	disassociateMonitoredResources(DisassociateMonitoredResourcesRequest request, AsyncHandler<DisassociateMonitoredResourcesRequest,DisassociateMonitoredResourcesResponse> handler) Removes associations between two monitored resources.
protected ClientConfigurator	getDefaultConfigurator()
Future<GetDiscoveryJobResponse>	getDiscoveryJob(GetDiscoveryJobRequest request, AsyncHandler<GetDiscoveryJobRequest,GetDiscoveryJobResponse> handler) API to get the details of discovery Job by identifier.
String	getEndpoint()
Future<GetMonitoredResourceResponse>	getMonitoredResource(GetMonitoredResourceRequest request, AsyncHandler<GetMonitoredResourceRequest,GetMonitoredResourceResponse> handler) Get monitored resource for the given identifier OCID.
Future<GetWorkRequestResponse>	getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler) Gets the status of the work request with the given ID.
Future<ListDiscoveryJobLogsResponse>	listDiscoveryJobLogs(ListDiscoveryJobLogsRequest request, AsyncHandler<ListDiscoveryJobLogsRequest,ListDiscoveryJobLogsResponse> handler) API to get all the logs of a Discovery Job.
Future<ListDiscoveryJobsResponse>	listDiscoveryJobs(ListDiscoveryJobsRequest request, AsyncHandler<ListDiscoveryJobsRequest,ListDiscoveryJobsResponse> handler) API to get the details of all Discovery Jobs.
Future<ListWorkRequestErrorsResponse>	listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler) Return a (paginated) list of errors for a given work request.
Future<ListWorkRequestLogsResponse>	listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler) Return a (paginated) 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.
Future<SearchAssociatedResourcesResponse>	searchAssociatedResources(SearchAssociatedResourcesRequest request, AsyncHandler<SearchAssociatedResourcesRequest,SearchAssociatedResourcesResponse> handler) List all associated resources recursively up-to a specified level, for the monitored resources of type specified.
Future<SearchMonitoredResourceAssociationsResponse>	searchMonitoredResourceAssociations(SearchMonitoredResourceAssociationsRequest request, AsyncHandler<SearchMonitoredResourceAssociationsRequest,SearchMonitoredResourceAssociationsResponse> handler) Search associations in the given compartment based on the search criteria.
Future<SearchMonitoredResourceMembersResponse>	searchMonitoredResourceMembers(SearchMonitoredResourceMembersRequest request, AsyncHandler<SearchMonitoredResourceMembersRequest,SearchMonitoredResourceMembersResponse> handler) List the member resources for the given monitored resource identifier OCID.
Future<SearchMonitoredResourcesResponse>	searchMonitoredResources(SearchMonitoredResourcesRequest request, AsyncHandler<SearchMonitoredResourcesRequest,SearchMonitoredResourcesResponse> handler) Gets a list of all monitored resources in a compartment for the given search criteria.
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’).
Future<UpdateAndPropagateTagsResponse>	updateAndPropagateTags(UpdateAndPropagateTagsRequest request, AsyncHandler<UpdateAndPropagateTagsRequest,UpdateAndPropagateTagsResponse> handler) Provided tags will be added or updated in the existing list of tags for the affected resources.
void	updateBaseEndpoint(String endpoint) This method should be used for parameterized endpoint templates only.
Future<UpdateMonitoredResourceResponse>	updateMonitoredResource(UpdateMonitoredResourceRequest request, AsyncHandler<UpdateMonitoredResourceRequest,UpdateMonitoredResourceResponse> handler) Update monitored resource by the given identifier OCID.
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.stackmonitoring.StackMonitoringAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE

public static final Service SERVICE

Service instance for StackMonitoring.

Constructor Detail

StackMonitoringAsyncClient

@Deprecated
public StackMonitoringAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

StackMonitoringAsyncClient

@Deprecated
public StackMonitoringAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                                              ClientConfiguration configuration)

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

StackMonitoringAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

StackMonitoringAsyncClient

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

Deprecated. Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

StackMonitoringAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

StackMonitoringAsyncClient

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

StackMonitoringAsyncClient

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

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: StackMonitoringAsync

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 StackMonitoringAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: StackMonitoringAsync

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 StackMonitoringAsync

Parameters:

regionId - The public region ID.

associateMonitoredResources

public Future<AssociateMonitoredResourcesResponse> associateMonitoredResources(AssociateMonitoredResourcesRequest request,
                                                                               AsyncHandler<AssociateMonitoredResourcesRequest,AssociateMonitoredResourcesResponse> handler)

Description copied from interface: StackMonitoringAsync

Create an association between two monitored resources. Associations can be created between resources from different compartments as long they are in same tenancy. User should have required access in both the compartments.

Specified by:

associateMonitoredResources in interface StackMonitoringAsync

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.

changeMonitoredResourceCompartment

public Future<ChangeMonitoredResourceCompartmentResponse> changeMonitoredResourceCompartment(ChangeMonitoredResourceCompartmentRequest request,
                                                                                             AsyncHandler<ChangeMonitoredResourceCompartmentRequest,ChangeMonitoredResourceCompartmentResponse> handler)

Description copied from interface: StackMonitoringAsync

Moves a monitored resource from one compartment to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeMonitoredResourceCompartment in interface StackMonitoringAsync

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.

createDiscoveryJob

public Future<CreateDiscoveryJobResponse> createDiscoveryJob(CreateDiscoveryJobRequest request,
                                                             AsyncHandler<CreateDiscoveryJobRequest,CreateDiscoveryJobResponse> handler)

Description copied from interface: StackMonitoringAsync

API to create discovery Job and submit discovery Details to agent.

Specified by:

createDiscoveryJob in interface StackMonitoringAsync

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.

createMonitoredResource

public Future<CreateMonitoredResourceResponse> createMonitoredResource(CreateMonitoredResourceRequest request,
                                                                       AsyncHandler<CreateMonitoredResourceRequest,CreateMonitoredResourceResponse> handler)

Description copied from interface: StackMonitoringAsync

Creates a new monitored resource for the given resource type with the details and submits a work request for promoting the resource to agent. Once the resource is successfully added to agent, resource state will be marked active.

Specified by:

createMonitoredResource in interface StackMonitoringAsync

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.

deleteDiscoveryJob

public Future<DeleteDiscoveryJobResponse> deleteDiscoveryJob(DeleteDiscoveryJobRequest request,
                                                             AsyncHandler<DeleteDiscoveryJobRequest,DeleteDiscoveryJobResponse> handler)

Description copied from interface: StackMonitoringAsync

Deletes a DiscoveryJob by identifier

Specified by:

deleteDiscoveryJob in interface StackMonitoringAsync

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.

deleteMonitoredResource

public Future<DeleteMonitoredResourceResponse> deleteMonitoredResource(DeleteMonitoredResourceRequest request,
                                                                       AsyncHandler<DeleteMonitoredResourceRequest,DeleteMonitoredResourceResponse> handler)

Description copied from interface: StackMonitoringAsync

Delete monitored resource by the given identifier OCID. By default, only the specified resource is deleted. If the parameter ‘isDeleteMembers’ is set to true, then the member resources will be deleted too. If the operation fails partially, the deleted entries will not be rolled back.

Specified by:

deleteMonitoredResource in interface StackMonitoringAsync

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.

disableExternalDatabase

public Future<DisableExternalDatabaseResponse> disableExternalDatabase(DisableExternalDatabaseRequest request,
                                                                       AsyncHandler<DisableExternalDatabaseRequest,DisableExternalDatabaseResponse> handler)

Description copied from interface: StackMonitoringAsync

Disable external database resource monitoring. All the references in DBaaS, DBM and resource service will be deleted as part of this operation.

Specified by:

disableExternalDatabase in interface StackMonitoringAsync

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.

disassociateMonitoredResources

public Future<DisassociateMonitoredResourcesResponse> disassociateMonitoredResources(DisassociateMonitoredResourcesRequest request,
                                                                                     AsyncHandler<DisassociateMonitoredResourcesRequest,DisassociateMonitoredResourcesResponse> handler)

Description copied from interface: StackMonitoringAsync

Removes associations between two monitored resources.

Specified by:

disassociateMonitoredResources in interface StackMonitoringAsync

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.

getDiscoveryJob

public Future<GetDiscoveryJobResponse> getDiscoveryJob(GetDiscoveryJobRequest request,
                                                       AsyncHandler<GetDiscoveryJobRequest,GetDiscoveryJobResponse> handler)

Description copied from interface: StackMonitoringAsync

API to get the details of discovery Job by identifier.

Specified by:

getDiscoveryJob in interface StackMonitoringAsync

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.

getMonitoredResource

public Future<GetMonitoredResourceResponse> getMonitoredResource(GetMonitoredResourceRequest request,
                                                                 AsyncHandler<GetMonitoredResourceRequest,GetMonitoredResourceResponse> handler)

Description copied from interface: StackMonitoringAsync

Get monitored resource for the given identifier OCID.

Specified by:

getMonitoredResource in interface StackMonitoringAsync

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

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

Specified by:

getWorkRequest in interface StackMonitoringAsync

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.

listDiscoveryJobLogs

public Future<ListDiscoveryJobLogsResponse> listDiscoveryJobLogs(ListDiscoveryJobLogsRequest request,
                                                                 AsyncHandler<ListDiscoveryJobLogsRequest,ListDiscoveryJobLogsResponse> handler)

Description copied from interface: StackMonitoringAsync

API to get all the logs of a Discovery Job.

Specified by:

listDiscoveryJobLogs in interface StackMonitoringAsync

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.

listDiscoveryJobs

public Future<ListDiscoveryJobsResponse> listDiscoveryJobs(ListDiscoveryJobsRequest request,
                                                           AsyncHandler<ListDiscoveryJobsRequest,ListDiscoveryJobsResponse> handler)

Description copied from interface: StackMonitoringAsync

API to get the details of all Discovery Jobs.

Specified by:

listDiscoveryJobs in interface StackMonitoringAsync

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

Return a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface StackMonitoringAsync

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

Return a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface StackMonitoringAsync

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

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface StackMonitoringAsync

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.

searchAssociatedResources

public Future<SearchAssociatedResourcesResponse> searchAssociatedResources(SearchAssociatedResourcesRequest request,
                                                                           AsyncHandler<SearchAssociatedResourcesRequest,SearchAssociatedResourcesResponse> handler)

Description copied from interface: StackMonitoringAsync

List all associated resources recursively up-to a specified level, for the monitored resources of type specified.

Specified by:

searchAssociatedResources in interface StackMonitoringAsync

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.

searchMonitoredResourceAssociations

public Future<SearchMonitoredResourceAssociationsResponse> searchMonitoredResourceAssociations(SearchMonitoredResourceAssociationsRequest request,
                                                                                               AsyncHandler<SearchMonitoredResourceAssociationsRequest,SearchMonitoredResourceAssociationsResponse> handler)

Description copied from interface: StackMonitoringAsync

Search associations in the given compartment based on the search criteria.

Specified by:

searchMonitoredResourceAssociations in interface StackMonitoringAsync

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.

searchMonitoredResourceMembers

public Future<SearchMonitoredResourceMembersResponse> searchMonitoredResourceMembers(SearchMonitoredResourceMembersRequest request,
                                                                                     AsyncHandler<SearchMonitoredResourceMembersRequest,SearchMonitoredResourceMembersResponse> handler)

Description copied from interface: StackMonitoringAsync

List the member resources for the given monitored resource identifier OCID.

Specified by:

searchMonitoredResourceMembers in interface StackMonitoringAsync

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.

searchMonitoredResources

public Future<SearchMonitoredResourcesResponse> searchMonitoredResources(SearchMonitoredResourcesRequest request,
                                                                         AsyncHandler<SearchMonitoredResourcesRequest,SearchMonitoredResourcesResponse> handler)

Description copied from interface: StackMonitoringAsync

Gets a list of all monitored resources in a compartment for the given search criteria.

Specified by:

searchMonitoredResources in interface StackMonitoringAsync

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.

updateAndPropagateTags

public Future<UpdateAndPropagateTagsResponse> updateAndPropagateTags(UpdateAndPropagateTagsRequest request,
                                                                     AsyncHandler<UpdateAndPropagateTagsRequest,UpdateAndPropagateTagsResponse> handler)

Description copied from interface: StackMonitoringAsync

Provided tags will be added or updated in the existing list of tags for the affected resources. Resources to be updated are identified based on association types specified. If association types not specified, then tags will be updated only for the resource identified by the given monitored resource identifier OCID.

Specified by:

updateAndPropagateTags in interface StackMonitoringAsync

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.

updateMonitoredResource

public Future<UpdateMonitoredResourceResponse> updateMonitoredResource(UpdateMonitoredResourceRequest request,
                                                                       AsyncHandler<UpdateMonitoredResourceRequest,UpdateMonitoredResourceResponse> handler)

Description copied from interface: StackMonitoringAsync

Update monitored resource by the given identifier OCID. Note that "properties" object, if specified, will entirely replace the existing object, as part this operation.

Specified by:

updateMonitoredResource in interface StackMonitoringAsync

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

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)