Class DashxApisClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseSyncClient
-
- com.oracle.bmc.managementdashboard.DashxApisClient
-
- All Implemented Interfaces:
DashxApis
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20200901") public class DashxApisClient extends BaseSyncClient implements DashxApis
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
DashxApisClient.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 DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.DashxApisClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.DashxApisClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.DashxApisClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DashxApisClient.Builder
builder()
Create a builder for this client.ChangeManagementDashboardsCompartmentResponse
changeManagementDashboardsCompartment(ChangeManagementDashboardsCompartmentRequest request)
Moves the dashboard from the existing compartment to a new compartment.ChangeManagementSavedSearchesCompartmentResponse
changeManagementSavedSearchesCompartment(ChangeManagementSavedSearchesCompartmentRequest request)
Moves the saved search from the existing compartment to a new compartment.void
close()
CreateManagementDashboardResponse
createManagementDashboard(CreateManagementDashboardRequest request)
Creates a new dashboard.CreateManagementSavedSearchResponse
createManagementSavedSearch(CreateManagementSavedSearchRequest request)
Creates a new saved search.DeleteManagementDashboardResponse
deleteManagementDashboard(DeleteManagementDashboardRequest request)
Deletes a Dashboard by ID.DeleteManagementSavedSearchResponse
deleteManagementSavedSearch(DeleteManagementSavedSearchRequest request)
Deletes a saved search by ID.ExportDashboardResponse
exportDashboard(ExportDashboardRequest request)
Exports an array of dashboards and their saved searches.String
getClientCommonLibraryVersion()
protected ClientConfigurator
getDefaultConfigurator()
String
getEndpoint()
GetManagementDashboardResponse
getManagementDashboard(GetManagementDashboardRequest request)
Gets a dashboard and its saved searches by ID.GetManagementSavedSearchResponse
getManagementSavedSearch(GetManagementSavedSearchRequest request)
Gets a saved search by ID.Optional<String>
getMinimumClientCommonLibraryVersionFromClient()
DashxApisPaginators
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.DashxApisWaiters
getWaiters()
Gets the pre-configured waiters available for resources for this service.ImportDashboardResponse
importDashboard(ImportDashboardRequest request)
Imports an array of dashboards and their saved searches.ListManagementDashboardsResponse
listManagementDashboards(ListManagementDashboardsRequest request)
Gets the list of dashboards in a compartment with pagination.ListManagementSavedSearchesResponse
listManagementSavedSearches(ListManagementSavedSearchesRequest request)
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 backingHttpClient
.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.UpdateManagementDashboardResponse
updateManagementDashboard(UpdateManagementDashboardRequest request)
Updates an existing dashboard identified by ID path parameter.UpdateManagementSavedSearchResponse
updateManagementSavedSearch(UpdateManagementSavedSearchRequest request)
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 com.oracle.bmc.http.internal.BaseSyncClient
clientCall
-
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.DashxApis
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
DashxApisClient
@Deprecated public DashxApisClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDashxApisClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
DashxApisClient
@Deprecated public DashxApisClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDashxApisClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
DashxApisClient
@Deprecated public DashxApisClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDashxApisClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
DashxApisClient
@Deprecated public DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDashxApisClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
DashxApisClient
@Deprecated public DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDashxApisClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
DashxApisClient
@Deprecated public DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDashxApisClient.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)
-
DashxApisClient
@Deprecated public DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDashxApisClient.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
-
DashxApisClient
@Deprecated public DashxApisClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeDashxApisClient.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
executorService
-DashxApisClient.Builder.executorService
-
-
Method Detail
-
builder
public static DashxApisClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:DashxApis
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.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:DashxApis
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 callsetEndpoint
.
-
changeManagementDashboardsCompartment
public ChangeManagementDashboardsCompartmentResponse changeManagementDashboardsCompartment(ChangeManagementDashboardsCompartmentRequest request)
Description copied from interface:DashxApis
Moves the dashboard from the existing compartment to a new compartment.- Specified by:
changeManagementDashboardsCompartment
in interfaceDashxApis
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
changeManagementSavedSearchesCompartment
public ChangeManagementSavedSearchesCompartmentResponse changeManagementSavedSearchesCompartment(ChangeManagementSavedSearchesCompartmentRequest request)
Description copied from interface:DashxApis
Moves the saved search from the existing compartment to a new compartment.- Specified by:
changeManagementSavedSearchesCompartment
in interfaceDashxApis
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createManagementDashboard
public CreateManagementDashboardResponse createManagementDashboard(CreateManagementDashboardRequest request)
Description copied from interface:DashxApis
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 theid
attribute and making other required changes, and use theoci management-dashboard dashboard create
command.- Specified by:
createManagementDashboard
in interfaceDashxApis
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
createManagementSavedSearch
public CreateManagementSavedSearchResponse createManagementSavedSearch(CreateManagementSavedSearchRequest request)
Description copied from interface:DashxApis
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 theid
attribute and making other required changes, and use theoci management-dashboard saved-search create
command.- Specified by:
createManagementSavedSearch
in interfaceDashxApis
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteManagementDashboard
public DeleteManagementDashboardResponse deleteManagementDashboard(DeleteManagementDashboardRequest request)
Description copied from interface:DashxApis
Deletes a Dashboard by ID.- Specified by:
deleteManagementDashboard
in interfaceDashxApis
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
deleteManagementSavedSearch
public DeleteManagementSavedSearchResponse deleteManagementSavedSearch(DeleteManagementSavedSearchRequest request)
Description copied from interface:DashxApis
Deletes a saved search by ID.- Specified by:
deleteManagementSavedSearch
in interfaceDashxApis
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
exportDashboard
public ExportDashboardResponse exportDashboard(ExportDashboardRequest request)
Description copied from interface:DashxApis
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 interfaceDashxApis
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getManagementDashboard
public GetManagementDashboardResponse getManagementDashboard(GetManagementDashboardRequest request)
Description copied from interface:DashxApis
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 interfaceDashxApis
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getManagementSavedSearch
public GetManagementSavedSearchResponse getManagementSavedSearch(GetManagementSavedSearchRequest request)
Description copied from interface:DashxApis
Gets a saved search by ID.- Specified by:
getManagementSavedSearch
in interfaceDashxApis
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
importDashboard
public ImportDashboardResponse importDashboard(ImportDashboardRequest request)
Description copied from interface:DashxApis
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 interfaceDashxApis
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listManagementDashboards
public ListManagementDashboardsResponse listManagementDashboards(ListManagementDashboardsRequest request)
Description copied from interface:DashxApis
Gets the list of dashboards in a compartment with pagination.Returned properties are the summary.
- Specified by:
listManagementDashboards
in interfaceDashxApis
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
listManagementSavedSearches
public ListManagementSavedSearchesResponse listManagementSavedSearches(ListManagementSavedSearchesRequest request)
Description copied from interface:DashxApis
Gets the list of saved searches in a compartment with pagination.Returned properties are the summary.
- Specified by:
listManagementSavedSearches
in interfaceDashxApis
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateManagementDashboard
public UpdateManagementDashboardResponse updateManagementDashboard(UpdateManagementDashboardRequest request)
Description copied from interface:DashxApis
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 interfaceDashxApis
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
updateManagementSavedSearch
public UpdateManagementSavedSearchResponse updateManagementSavedSearch(UpdateManagementSavedSearchRequest request)
Description copied from interface:DashxApis
Updates an existing saved search identified by ID path parameter.CompartmentId can be modified only by the changeCompartment API.
- Specified by:
updateManagementSavedSearch
in interfaceDashxApis
- Parameters:
request
- The request object containing the details to send- Returns:
- A response object containing details about the completed operation
-
getWaiters
public DashxApisWaiters getWaiters()
Description copied from interface:DashxApis
Gets the pre-configured waiters available for resources for this service.- Specified by:
getWaiters
in interfaceDashxApis
- Returns:
- The service waiters.
-
getPaginators
public DashxApisPaginators getPaginators()
Description copied from interface:DashxApis
Gets 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.- Specified by:
getPaginators
in interfaceDashxApis
- Returns:
- The service paginators.
-
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 userequiredParametersMap
- 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 backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
-