Package com.oracle.bmc.managementdashboard

Class DashxApisAsyncClient

java.lang.Object

com.oracle.bmc.http.internal.BaseAsyncClient

com.oracle.bmc.managementdashboard.DashxApisAsyncClient

All Implemented Interfaces:

DashxApisAsync, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200901")
public class DashxApisAsyncClient
extends BaseAsyncClient
implements DashxApisAsync

Async client implementation for DashxApis 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	Description
static class	DashxApisAsyncClient.Builder	Builder class for this client.

Field Summary

Fields

Modifier and Type	Field	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 DashxApis.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static DashxApisAsyncClient.Builder	builder()	Create a builder for this client.
Future<ChangeManagementDashboardsCompartmentResponse>	changeManagementDashboardsCompartment(ChangeManagementDashboardsCompartmentRequest request, AsyncHandler<ChangeManagementDashboardsCompartmentRequest,ChangeManagementDashboardsCompartmentResponse> handler)	Moves the dashboard from the existing compartment to a new compartment.
Future<ChangeManagementSavedSearchesCompartmentResponse>	changeManagementSavedSearchesCompartment(ChangeManagementSavedSearchesCompartmentRequest request, AsyncHandler<ChangeManagementSavedSearchesCompartmentRequest,ChangeManagementSavedSearchesCompartmentResponse> handler)	Moves the saved search from the existing compartment to a new compartment.
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<CreateManagementDashboardResponse>	createManagementDashboard(CreateManagementDashboardRequest request, AsyncHandler<CreateManagementDashboardRequest,CreateManagementDashboardResponse> handler)	Creates a new dashboard.
Future<CreateManagementSavedSearchResponse>	createManagementSavedSearch(CreateManagementSavedSearchRequest request, AsyncHandler<CreateManagementSavedSearchRequest,CreateManagementSavedSearchResponse> handler)	Creates a new saved search.
Future<DeleteManagementDashboardResponse>	deleteManagementDashboard(DeleteManagementDashboardRequest request, AsyncHandler<DeleteManagementDashboardRequest,DeleteManagementDashboardResponse> handler)	Deletes a Dashboard by ID.
Future<DeleteManagementSavedSearchResponse>	deleteManagementSavedSearch(DeleteManagementSavedSearchRequest request, AsyncHandler<DeleteManagementSavedSearchRequest,DeleteManagementSavedSearchResponse> handler)	Deletes a saved search by ID.
Future<ExportDashboardResponse>	exportDashboard(ExportDashboardRequest request, AsyncHandler<ExportDashboardRequest,ExportDashboardResponse> handler)	Exports an array of dashboards and their saved searches.
String	getClientCommonLibraryVersion()
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()
Future<GetManagementDashboardResponse>	getManagementDashboard(GetManagementDashboardRequest request, AsyncHandler<GetManagementDashboardRequest,GetManagementDashboardResponse> handler)	Gets a dashboard and its saved searches by ID.
Future<GetManagementSavedSearchResponse>	getManagementSavedSearch(GetManagementSavedSearchRequest request, AsyncHandler<GetManagementSavedSearchRequest,GetManagementSavedSearchResponse> handler)	Gets a saved search by ID.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Future<ImportDashboardResponse>	importDashboard(ImportDashboardRequest request, AsyncHandler<ImportDashboardRequest,ImportDashboardResponse> handler)	Imports an array of dashboards and their saved searches.
Future<ListManagementDashboardsResponse>	listManagementDashboards(ListManagementDashboardsRequest request, AsyncHandler<ListManagementDashboardsRequest,ListManagementDashboardsResponse> handler)	Gets the list of dashboards in a compartment with pagination.
Future<ListManagementSavedSearchesResponse>	listManagementSavedSearches(ListManagementSavedSearchesRequest request, AsyncHandler<ListManagementSavedSearchesRequest,ListManagementSavedSearchesResponse> handler)	Gets the list of saved searches in a compartment with pagination.
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<UpdateManagementDashboardResponse>	updateManagementDashboard(UpdateManagementDashboardRequest request, AsyncHandler<UpdateManagementDashboardRequest,UpdateManagementDashboardResponse> handler)	Updates an existing dashboard identified by ID path parameter.
Future<UpdateManagementSavedSearchResponse>	updateManagementSavedSearch(UpdateManagementSavedSearchRequest request, AsyncHandler<UpdateManagementSavedSearchRequest,UpdateManagementSavedSearchResponse> handler)	Updates an existing saved search identified by ID path parameter.
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 java.lang.AutoCloseable

close

Methods inherited from interface com.oracle.bmc.managementdashboard.DashxApisAsync

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for DashxApis.

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

DashxApisAsyncClient

@Deprecated
public DashxApisAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

DashxApisAsyncClient

@Deprecated
public DashxApisAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                            ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DashxApisAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DashxApisAsyncClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DashxApisAsyncClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DashxApisAsyncClient

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

DashxApisAsyncClient

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

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: DashxApisAsync

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 DashxApisAsync

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: DashxApisAsync

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 DashxApisAsync

Parameters:

regionId - The public region ID.

changeManagementDashboardsCompartment

public Future<ChangeManagementDashboardsCompartmentResponse> changeManagementDashboardsCompartment(ChangeManagementDashboardsCompartmentRequest request,
                                                                                                   AsyncHandler<ChangeManagementDashboardsCompartmentRequest,ChangeManagementDashboardsCompartmentResponse> handler)

Description copied from interface: DashxApisAsync

Moves the dashboard from the existing compartment to a new compartment.

Specified by:

changeManagementDashboardsCompartment in interface DashxApisAsync

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.

changeManagementSavedSearchesCompartment

public Future<ChangeManagementSavedSearchesCompartmentResponse> changeManagementSavedSearchesCompartment(ChangeManagementSavedSearchesCompartmentRequest request,
                                                                                                         AsyncHandler<ChangeManagementSavedSearchesCompartmentRequest,ChangeManagementSavedSearchesCompartmentResponse> handler)

Description copied from interface: DashxApisAsync

Moves the saved search from the existing compartment to a new compartment.

Specified by:

changeManagementSavedSearchesCompartment in interface DashxApisAsync

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.

createManagementDashboard

public Future<CreateManagementDashboardResponse> createManagementDashboard(CreateManagementDashboardRequest request,
                                                                           AsyncHandler<CreateManagementDashboardRequest,CreateManagementDashboardResponse> handler)

Description copied from interface: DashxApisAsync

Creates a new dashboard.

Limit for number of saved searches in a dashboard is 20. Here’s an example of how you can use CLI to create a dashboard. For information on the details that must be passed to CREATE, you can use the GET API to obtain the Create.json file: oci management-dashboard dashboard get --management-dashboard-id \"ocid1.managementdashboard.oc1..dashboardId1\" --query data > Create.json. You can then modify the Create.json file by removing the id attribute and making other required changes, and use the oci management-dashboard dashboard create command.

Specified by:

createManagementDashboard in interface DashxApisAsync

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.

createManagementSavedSearch

public Future<CreateManagementSavedSearchResponse> createManagementSavedSearch(CreateManagementSavedSearchRequest request,
                                                                               AsyncHandler<CreateManagementSavedSearchRequest,CreateManagementSavedSearchResponse> handler)

Description copied from interface: DashxApisAsync

Creates a new saved search.

Here’s an example of how you can use CLI to create a saved search. For information on the details that must be passed to CREATE, you can use the GET API to obtain the Create.json file: oci management-dashboard saved-search get --management-saved-search-id ocid1.managementsavedsearch.oc1..savedsearchId1 --query data > Create.json. You can then modify the Create.json file by removing the id attribute and making other required changes, and use the oci management-dashboard saved-search create command.

Specified by:

createManagementSavedSearch in interface DashxApisAsync

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.

deleteManagementDashboard

public Future<DeleteManagementDashboardResponse> deleteManagementDashboard(DeleteManagementDashboardRequest request,
                                                                           AsyncHandler<DeleteManagementDashboardRequest,DeleteManagementDashboardResponse> handler)

Description copied from interface: DashxApisAsync

Deletes a Dashboard by ID.

Specified by:

deleteManagementDashboard in interface DashxApisAsync

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.

deleteManagementSavedSearch

public Future<DeleteManagementSavedSearchResponse> deleteManagementSavedSearch(DeleteManagementSavedSearchRequest request,
                                                                               AsyncHandler<DeleteManagementSavedSearchRequest,DeleteManagementSavedSearchResponse> handler)

Description copied from interface: DashxApisAsync

Deletes a saved search by ID.

Specified by:

deleteManagementSavedSearch in interface DashxApisAsync

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.

exportDashboard

public Future<ExportDashboardResponse> exportDashboard(ExportDashboardRequest request,
                                                       AsyncHandler<ExportDashboardRequest,ExportDashboardResponse> handler)

Description copied from interface: DashxApisAsync

Exports an array of dashboards and their saved searches.

Export is designed to work with importDashboard. Here’s an example of how you can use CLI to export a dashboard: $oci management-dashboard dashboard export --query data --export-dashboard-id \"{\\\"dashboardIds\\\":[\\\"ocid1.managementdashboard.oc1..dashboardId1\\\"]}\" > dashboards.json

Specified by:

exportDashboard in interface DashxApisAsync

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.

getManagementDashboard

public Future<GetManagementDashboardResponse> getManagementDashboard(GetManagementDashboardRequest request,
                                                                     AsyncHandler<GetManagementDashboardRequest,GetManagementDashboardResponse> handler)

Description copied from interface: DashxApisAsync

Gets a dashboard and its saved searches by ID.

Deleted or unauthorized saved searches are marked by tile’s state property.

Specified by:

getManagementDashboard in interface DashxApisAsync

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.

getManagementSavedSearch

public Future<GetManagementSavedSearchResponse> getManagementSavedSearch(GetManagementSavedSearchRequest request,
                                                                         AsyncHandler<GetManagementSavedSearchRequest,GetManagementSavedSearchResponse> handler)

Description copied from interface: DashxApisAsync

Gets a saved search by ID.

Specified by:

getManagementSavedSearch in interface DashxApisAsync

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.

importDashboard

public Future<ImportDashboardResponse> importDashboard(ImportDashboardRequest request,
                                                       AsyncHandler<ImportDashboardRequest,ImportDashboardResponse> handler)

Description copied from interface: DashxApisAsync

Imports an array of dashboards and their saved searches.

Here’s an example of how you can use CLI to import a dashboard. For information on the details that must be passed to IMPORT, you can use the EXPORT API to obtain the Import.json file: oci management-dashboard dashboard export --query data --export-dashboard-id \"{\\\"dashboardIds\\\":[\\\"ocid1.managementdashboard.oc1..dashboardId1\\\"]}\" > Import.json. Note that import API updates the resource if it already exists, and creates a new resource if it does not exist. To import to a different compartment, edit and change the compartmentId to the desired compartment OCID. Here’s an example of how you can use CLI to import: oci management-dashboard dashboard import --from-json file://Import.json

Specified by:

importDashboard in interface DashxApisAsync

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.

listManagementDashboards

public Future<ListManagementDashboardsResponse> listManagementDashboards(ListManagementDashboardsRequest request,
                                                                         AsyncHandler<ListManagementDashboardsRequest,ListManagementDashboardsResponse> handler)

Description copied from interface: DashxApisAsync

Gets the list of dashboards in a compartment with pagination.

Returned properties are the summary.

Specified by:

listManagementDashboards in interface DashxApisAsync

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.

listManagementSavedSearches

public Future<ListManagementSavedSearchesResponse> listManagementSavedSearches(ListManagementSavedSearchesRequest request,
                                                                               AsyncHandler<ListManagementSavedSearchesRequest,ListManagementSavedSearchesResponse> handler)

Description copied from interface: DashxApisAsync

Gets the list of saved searches in a compartment with pagination.

Returned properties are the summary.

Specified by:

listManagementSavedSearches in interface DashxApisAsync

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.

updateManagementDashboard

public Future<UpdateManagementDashboardResponse> updateManagementDashboard(UpdateManagementDashboardRequest request,
                                                                           AsyncHandler<UpdateManagementDashboardRequest,UpdateManagementDashboardResponse> handler)

Description copied from interface: DashxApisAsync

Updates an existing dashboard identified by ID path parameter.

CompartmentId can be modified only by the changeCompartment API. Limit for number of saved searches in a dashboard is 20.

Specified by:

updateManagementDashboard in interface DashxApisAsync

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.

updateManagementSavedSearch

public Future<UpdateManagementSavedSearchResponse> updateManagementSavedSearch(UpdateManagementSavedSearchRequest request,
                                                                               AsyncHandler<UpdateManagementSavedSearchRequest,UpdateManagementSavedSearchResponse> handler)

Description copied from interface: DashxApisAsync

Updates an existing saved search identified by ID path parameter.

CompartmentId can be modified only by the changeCompartment API.

Specified by:

updateManagementSavedSearch in interface DashxApisAsync

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)