@Generated(value="OracleSDKGenerator", comments="API Version: 20200901") public class DashxApisClient extends Object implements DashxApis
| Modifier and Type | Class and Description |
|---|---|
static class |
DashxApisClient.Builder
Builder class for this client.
|
| Modifier and Type | Field and Description |
|---|---|
static Service |
SERVICE
Service instance for DashxApis.
|
| Modifier | Constructor and Description |
|---|---|
|
DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DashxApisClient(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.
|
|
DashxApisClient(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.
|
|
DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Creates a new service instance using the given authentication provider and client configuration.
|
protected |
DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService,
RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DashxApisClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
|
|
DashxApisClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Creates a new service instance using the given authentication provider and client configuration.
|
|
DashxApisClient(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 DashxApisClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Creates a new service instance using the given authentication provider.
authenticationDetailsProvider - The authentication details provider, required.public DashxApisClient(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 DashxApisClient(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 DashxApisClient(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 DashxApisClient(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 DashxApisClient(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 DashxApisClient(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 DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
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)executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorprotected DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder)
Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.
This is an advanced constructor for clients that want to take control over how requests are signed.
Use the DashxApisClient.Builder to get access to all these parameters.
authenticationDetailsProvider - The authentication details provider, required.configuration - The client configuration, optional.clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signeradditionalClientConfigurators - Additional client configurators to be run after the primary configurator.endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutorrestClientFactoryBuilder - the builder for the RestClientFactorypublic static DashxApisClient.Builder builder()
Create a builder for this client.
public void setEndpoint(String endpoint)
DashxApisSets the endpoint to call (ex, https://www.example.com).
setEndpoint in interface DashxApisendpoint - The endpoint of the service.public String getEndpoint()
DashxApisGets the set endpoint for REST call (ex, https://www.example.com)
getEndpoint in interface DashxApispublic void setRegion(Region region)
DashxApisSets 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.
public void setRegion(String regionId)
DashxApisSets 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.
public void close()
close in interface AutoCloseablepublic ChangeManagementDashboardsCompartmentResponse changeManagementDashboardsCompartment(ChangeManagementDashboardsCompartmentRequest request)
DashxApisMoves the dashboard from the existing compartment to a new compartment.
changeManagementDashboardsCompartment in interface DashxApisrequest - The request object containing the details to sendpublic ChangeManagementSavedSearchesCompartmentResponse changeManagementSavedSearchesCompartment(ChangeManagementSavedSearchesCompartmentRequest request)
DashxApisMoves the saved search from the existing compartment to a new compartment.
changeManagementSavedSearchesCompartment in interface DashxApisrequest - The request object containing the details to sendpublic CreateManagementDashboardResponse createManagementDashboard(CreateManagementDashboardRequest request)
DashxApisCreates 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 DashxApisrequest - The request object containing the details to sendpublic CreateManagementSavedSearchResponse createManagementSavedSearch(CreateManagementSavedSearchRequest request)
DashxApisCreates 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 DashxApisrequest - The request object containing the details to sendpublic DeleteManagementDashboardResponse deleteManagementDashboard(DeleteManagementDashboardRequest request)
DashxApisDeletes a Dashboard by ID.
deleteManagementDashboard in interface DashxApisrequest - The request object containing the details to sendpublic DeleteManagementSavedSearchResponse deleteManagementSavedSearch(DeleteManagementSavedSearchRequest request)
DashxApisDeletes a saved search by ID.
deleteManagementSavedSearch in interface DashxApisrequest - The request object containing the details to sendpublic ExportDashboardResponse exportDashboard(ExportDashboardRequest request)
DashxApisExports 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 DashxApisrequest - The request object containing the details to sendpublic GetManagementDashboardResponse getManagementDashboard(GetManagementDashboardRequest request)
DashxApisGets a dashboard and its saved searches by ID. Deleted or unauthorized saved searches are marked by tile’s state property.
getManagementDashboard in interface DashxApisrequest - The request object containing the details to sendpublic GetManagementSavedSearchResponse getManagementSavedSearch(GetManagementSavedSearchRequest request)
DashxApisGets a saved search by ID.
getManagementSavedSearch in interface DashxApisrequest - The request object containing the details to sendpublic ImportDashboardResponse importDashboard(ImportDashboardRequest request)
DashxApisImports 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 DashxApisrequest - The request object containing the details to sendpublic ListManagementDashboardsResponse listManagementDashboards(ListManagementDashboardsRequest request)
DashxApisGets the list of dashboards in a compartment with pagination. Returned properties are the summary.
listManagementDashboards in interface DashxApisrequest - The request object containing the details to sendpublic ListManagementSavedSearchesResponse listManagementSavedSearches(ListManagementSavedSearchesRequest request)
DashxApisGets the list of saved searches in a compartment with pagination. Returned properties are the summary.
listManagementSavedSearches in interface DashxApisrequest - The request object containing the details to sendpublic UpdateManagementDashboardResponse updateManagementDashboard(UpdateManagementDashboardRequest request)
DashxApisUpdates 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 DashxApisrequest - The request object containing the details to sendpublic UpdateManagementSavedSearchResponse updateManagementSavedSearch(UpdateManagementSavedSearchRequest request)
DashxApisUpdates an existing saved search identified by ID path parameter. CompartmentId can be modified only by the changeCompartment API.
updateManagementSavedSearch in interface DashxApisrequest - The request object containing the details to sendpublic DashxApisWaiters getWaiters()
DashxApisGets the pre-configured waiters available for resources for this service.
getWaiters in interface DashxApispublic DashxApisPaginators getPaginators()
DashxApisGets the pre-configured paginators available for list operations in this service which may return multiple
pages of data. These paginators provide an Iterable interface so that service responses, or
resources/records, can be iterated through without having to manually deal with pagination and page tokens.
getPaginators in interface DashxApisCopyright © 2016–2022. All rights reserved.