@Generated(value="OracleSDKGenerator", comments="API Version: 20200901") public class DashxApisAsyncClient extends Object implements DashxApisAsync
Async client implementation for DashxApis service.
There are two ways to use async client:
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. | Modifier and Type | Class and Description |
|---|---|
static class |
DashxApisAsyncClient.Builder
Builder class for this client.
|
| Modifier and Type | Field and Description |
|---|---|
static Service |
SERVICE
Service instance for DashxApis.
|
| Constructor and Description |
|---|
DashxApisAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
DashxApisAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
DashxApisAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
DashxApisAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Creates a new service instance using the given authentication provider and client configuration.
|
DashxApisAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
DashxApisAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
DashxApisAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
DashxApisAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration.
|
public static final Service SERVICE
Service instance for DashxApis.
public DashxApisAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider - The authentication details provider, required.public DashxApisAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.public DashxApisAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.public DashxApisAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.public DashxApisAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.public DashxApisAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.additionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public DashxApisAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)public DashxApisAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)restClientFactoryBuilder - the builder for the RestClientFactorypublic static DashxApisAsyncClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
DashxApisAsyncSets the endpoint to call (ex, https://www.example.com).
setEndpoint in interface DashxApisAsyncendpoint - The endpoint of the serice.public String getEndpoint()
DashxApisAsyncGets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint in interface DashxApisAsyncpublic void setRegion(Region region)
DashxApisAsyncSets 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.
setRegion in interface DashxApisAsyncregion - The region of the service.public void setRegion(String regionId)
DashxApisAsyncSets 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.
setRegion in interface DashxApisAsyncregionId - The public region ID.public void close()
close in interface AutoCloseablepublic Future<ChangeManagementDashboardsCompartmentResponse> changeManagementDashboardsCompartment(ChangeManagementDashboardsCompartmentRequest request, AsyncHandler<ChangeManagementDashboardsCompartmentRequest,ChangeManagementDashboardsCompartmentResponse> handler)
DashxApisAsyncMoves the dashboard from the existing compartment to a new compartment.
changeManagementDashboardsCompartment in interface DashxApisAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ChangeManagementSavedSearchesCompartmentResponse> changeManagementSavedSearchesCompartment(ChangeManagementSavedSearchesCompartmentRequest request, AsyncHandler<ChangeManagementSavedSearchesCompartmentRequest,ChangeManagementSavedSearchesCompartmentResponse> handler)
DashxApisAsyncMoves the saved search from the existing compartment to a new compartment.
changeManagementSavedSearchesCompartment in interface DashxApisAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateManagementDashboardResponse> createManagementDashboard(CreateManagementDashboardRequest request, AsyncHandler<CreateManagementDashboardRequest,CreateManagementDashboardResponse> handler)
DashxApisAsyncCreates 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.
createManagementDashboard in interface DashxApisAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<CreateManagementSavedSearchResponse> createManagementSavedSearch(CreateManagementSavedSearchRequest request, AsyncHandler<CreateManagementSavedSearchRequest,CreateManagementSavedSearchResponse> handler)
DashxApisAsyncCreates 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.
createManagementSavedSearch in interface DashxApisAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteManagementDashboardResponse> deleteManagementDashboard(DeleteManagementDashboardRequest request, AsyncHandler<DeleteManagementDashboardRequest,DeleteManagementDashboardResponse> handler)
DashxApisAsyncDeletes a Dashboard by ID.
deleteManagementDashboard in interface DashxApisAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<DeleteManagementSavedSearchResponse> deleteManagementSavedSearch(DeleteManagementSavedSearchRequest request, AsyncHandler<DeleteManagementSavedSearchRequest,DeleteManagementSavedSearchResponse> handler)
DashxApisAsyncDeletes a saved search by ID.
deleteManagementSavedSearch in interface DashxApisAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ExportDashboardResponse> exportDashboard(ExportDashboardRequest request, AsyncHandler<ExportDashboardRequest,ExportDashboardResponse> handler)
DashxApisAsyncExports 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
exportDashboard in interface DashxApisAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetManagementDashboardResponse> getManagementDashboard(GetManagementDashboardRequest request, AsyncHandler<GetManagementDashboardRequest,GetManagementDashboardResponse> handler)
DashxApisAsyncGets a dashboard and its saved searches by ID. Deleted or unauthorized saved searches are marked by tile’s state property.
getManagementDashboard in interface DashxApisAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<GetManagementSavedSearchResponse> getManagementSavedSearch(GetManagementSavedSearchRequest request, AsyncHandler<GetManagementSavedSearchRequest,GetManagementSavedSearchResponse> handler)
DashxApisAsyncGets a saved search by ID.
getManagementSavedSearch in interface DashxApisAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ImportDashboardResponse> importDashboard(ImportDashboardRequest request, AsyncHandler<ImportDashboardRequest,ImportDashboardResponse> handler)
DashxApisAsyncImports 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
importDashboard in interface DashxApisAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListManagementDashboardsResponse> listManagementDashboards(ListManagementDashboardsRequest request, AsyncHandler<ListManagementDashboardsRequest,ListManagementDashboardsResponse> handler)
DashxApisAsyncGets the list of dashboards in a compartment with pagination. Returned properties are the summary.
listManagementDashboards in interface DashxApisAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<ListManagementSavedSearchesResponse> listManagementSavedSearches(ListManagementSavedSearchesRequest request, AsyncHandler<ListManagementSavedSearchesRequest,ListManagementSavedSearchesResponse> handler)
DashxApisAsyncGets the list of saved searches in a compartment with pagination. Returned properties are the summary.
listManagementSavedSearches in interface DashxApisAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateManagementDashboardResponse> updateManagementDashboard(UpdateManagementDashboardRequest request, AsyncHandler<UpdateManagementDashboardRequest,UpdateManagementDashboardResponse> handler)
DashxApisAsyncUpdates 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.
updateManagementDashboard in interface DashxApisAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.public Future<UpdateManagementSavedSearchResponse> updateManagementSavedSearch(UpdateManagementSavedSearchRequest request, AsyncHandler<UpdateManagementSavedSearchRequest,UpdateManagementSavedSearchResponse> handler)
DashxApisAsyncUpdates an existing saved search identified by ID path parameter. CompartmentId can be modified only by the changeCompartment API.
updateManagementSavedSearch in interface DashxApisAsyncrequest - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Copyright © 2016–2022. All rights reserved.