com.oracle.bmc.managementdashboard.DashxApis Maven / Gradle / Ivy
Show all versions of oci-java-sdk-shaded-full Show documentation
/**
* Copyright (c) 2016, 2024, Oracle and/or its affiliates. All rights reserved.
* This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
*/
package com.oracle.bmc.managementdashboard;
import com.oracle.bmc.managementdashboard.requests.*;
import com.oracle.bmc.managementdashboard.responses.*;
/**
* API for the Management Dashboard micro-service. Use this API for dashboard and saved search
* metadata preservation and to perform tasks such as creating a dashboard, creating a saved search,
* and obtaining a list of dashboards and saved searches in a compartment.
*
* This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by
* default if no circuit breaker configuration is defined by the user.
*/
@jakarta.annotation.Generated(value = "OracleSDKGenerator", comments = "API Version: 20200901")
public interface DashxApis extends AutoCloseable {
/** Rebuilds the client from scratch. Useful to refresh certificates. */
void refreshClient();
/**
* Sets the endpoint to call (ex, https://www.example.com).
*
* @param endpoint The endpoint of the service.
*/
void setEndpoint(String endpoint);
/** Gets the set endpoint for REST call (ex, https://www.example.com) */
String getEndpoint();
/**
* Sets the region to call (ex, Region.US_PHOENIX_1).
*
*
Note, this will call {@link #setEndpoint(String) setEndpoint} after resolving the
* endpoint. If the service is not available in this Region, however, an
* IllegalArgumentException will be raised.
*
* @param region The region of the service.
*/
void setRegion(com.oracle.bmc.Region region);
/**
* 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 {@link
* #setRegion(Region) setRegion}.
*
*
If no known Region could be determined, it will create an endpoint based on the default
* endpoint format ({@link com.oracle.bmc.Region#formatDefaultRegionEndpoint(Service, String)}
* and then call {@link #setEndpoint(String) setEndpoint}.
*
* @param regionId The public region ID.
*/
void setRegion(String regionId);
/**
* Determines whether realm specific endpoint should be used or not. Set
* realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm
* specific endpoint template, otherwise set it to "false"
*
* @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint
* template
*/
void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled);
/**
* Moves the dashboard from the existing compartment to a new compartment.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs. This operation will not retry by default, users
* can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
* enable retries for it. The specifics of the default retry strategy are described here
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
*
Example: Click here to see how to use
* ChangeManagementDashboardsCompartment API.
*/
ChangeManagementDashboardsCompartmentResponse changeManagementDashboardsCompartment(
ChangeManagementDashboardsCompartmentRequest request);
/**
* Moves the saved search from the existing compartment to a new compartment.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs. This operation will not retry by default, users
* can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
* enable retries for it. The specifics of the default retry strategy are described here
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
*
Example: Click here to see how to use
* ChangeManagementSavedSearchesCompartment API.
*/
ChangeManagementSavedSearchesCompartmentResponse changeManagementSavedSearchesCompartment(
ChangeManagementSavedSearchesCompartmentRequest request);
/**
* 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.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs. This operation will not retry by default, users
* can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
* enable retries for it. The specifics of the default retry strategy are described here
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
*
Example: Click here to see how to use
* CreateManagementDashboard API.
*/
CreateManagementDashboardResponse createManagementDashboard(
CreateManagementDashboardRequest request);
/**
* 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.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs. This operation will not retry by default, users
* can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
* enable retries for it. The specifics of the default retry strategy are described here
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
*
Example: Click here to see how to use
* CreateManagementSavedSearch API.
*/
CreateManagementSavedSearchResponse createManagementSavedSearch(
CreateManagementSavedSearchRequest request);
/**
* Deletes a Dashboard by ID.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs. This operation will not retry by default, users
* can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
* enable retries for it. The specifics of the default retry strategy are described here
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
*
Example: Click here to see how to use
* DeleteManagementDashboard API.
*/
DeleteManagementDashboardResponse deleteManagementDashboard(
DeleteManagementDashboardRequest request);
/**
* Deletes a saved search by ID.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs. This operation will not retry by default, users
* can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
* enable retries for it. The specifics of the default retry strategy are described here
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
*
Example: Click here to see how to use
* DeleteManagementSavedSearch API.
*/
DeleteManagementSavedSearchResponse deleteManagementSavedSearch(
DeleteManagementSavedSearchRequest request);
/**
* 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`
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs. This operation will not retry by default, users
* can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
* enable retries for it. The specifics of the default retry strategy are described here
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
*
Example: Click here to see how to use ExportDashboard
* API.
*/
ExportDashboardResponse exportDashboard(ExportDashboardRequest request);
/**
* Gets a dashboard and its saved searches by ID. Deleted or unauthorized saved searches are
* marked by tile's state property.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs. This operation will not retry by default, users
* can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
* enable retries for it. The specifics of the default retry strategy are described here
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
*
Example: Click here to see how to use
* GetManagementDashboard API.
*/
GetManagementDashboardResponse getManagementDashboard(GetManagementDashboardRequest request);
/**
* Gets a saved search by ID.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs. This operation will not retry by default, users
* can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
* enable retries for it. The specifics of the default retry strategy are described here
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
*
Example: Click here to see how to use
* GetManagementSavedSearch API.
*/
GetManagementSavedSearchResponse getManagementSavedSearch(
GetManagementSavedSearchRequest request);
/**
* 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`
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs. This operation will not retry by default, users
* can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
* enable retries for it. The specifics of the default retry strategy are described here
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
*
Example: Click here to see how to use ImportDashboard
* API.
*/
ImportDashboardResponse importDashboard(ImportDashboardRequest request);
/**
* Gets the list of dashboards in a compartment with pagination. Returned properties are the
* summary.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs. This operation will not retry by default, users
* can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
* enable retries for it. The specifics of the default retry strategy are described here
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
*
Example: Click here to see how to use
* ListManagementDashboards API.
*/
ListManagementDashboardsResponse listManagementDashboards(
ListManagementDashboardsRequest request);
/**
* Gets the list of saved searches in a compartment with pagination. Returned properties are the
* summary.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs. This operation will not retry by default, users
* can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
* enable retries for it. The specifics of the default retry strategy are described here
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
*
Example: Click here to see how to use
* ListManagementSavedSearches API.
*/
ListManagementSavedSearchesResponse listManagementSavedSearches(
ListManagementSavedSearchesRequest request);
/**
* 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.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs. This operation will not retry by default, users
* can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
* enable retries for it. The specifics of the default retry strategy are described here
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
*
Example: Click here to see how to use
* UpdateManagementDashboard API.
*/
UpdateManagementDashboardResponse updateManagementDashboard(
UpdateManagementDashboardRequest request);
/**
* Updates an existing saved search identified by ID path parameter. CompartmentId can be
* modified only by the changeCompartment API.
*
* @param request The request object containing the details to send
* @return A response object containing details about the completed operation
* @throws BmcException when an error occurs. This operation will not retry by default, users
* can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to
* enable retries for it. The specifics of the default retry strategy are described here
* https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
*
Example: Click here to see how to use
* UpdateManagementSavedSearch API.
*/
UpdateManagementSavedSearchResponse updateManagementSavedSearch(
UpdateManagementSavedSearchRequest request);
/**
* Gets the pre-configured waiters available for resources for this service.
*
* @return The service waiters.
*/
DashxApisWaiters getWaiters();
/**
* Gets the pre-configured paginators available for list operations in this service which may
* return multiple pages of data. These paginators provide an {@link java.lang.Iterable}
* interface so that service responses, or resources/records, can be iterated through without
* having to manually deal with pagination and page tokens.
*
* @return The service paginators.
*/
DashxApisPaginators getPaginators();
}