Package com.oracle.bmc.dashboardservice

Class DashboardClient

java.lang.Object

com.oracle.bmc.http.internal.BaseSyncClient

com.oracle.bmc.dashboardservice.DashboardClient

All Implemented Interfaces:

Dashboard, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210731")
public class DashboardClient
extends BaseSyncClient
implements Dashboard

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DashboardClient.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 Dashboard.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static DashboardClient.Builder	builder()	Create a builder for this client.
ChangeDashboardGroupResponse	changeDashboardGroup(ChangeDashboardGroupRequest request)	Moves a Dashboard resource from one dashboardGroup identifier to another.
void	close()
CreateDashboardResponse	createDashboard(CreateDashboardRequest request)	Creates a new dashboard in the dashboard group’s compartment using the details provided in request body.
DeleteDashboardResponse	deleteDashboard(DeleteDashboardRequest request)	Deletes the specified dashboard.
void	enableDualStackEndpoints(boolean enableDualStackEndpoints)	This method should be used to enable or disable the use of dual-stack endpoints.
String	getClientCommonLibraryVersion()
GetDashboardResponse	getDashboard(GetDashboardRequest request)	Gets the specified dashboard’s information.
protected ClientConfigurator	getDefaultConfigurator()
String	getEndpoint()	Get the endpoint of the client.
Optional<String>	getMinimumClientCommonLibraryVersionFromClient()
Map<String,Boolean>	getOptionsMap()	Return an immutable snapshot representing the current options set for this client.
DashboardPaginators	getPaginators()	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
String	getResolvedEndpoint(Map<String,Object> requiredParametersMap)	Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.
DashboardWaiters	getWaiters()	Gets the pre-configured waiters available for resources for this service.
ListDashboardsResponse	listDashboards(ListDashboardsRequest request)	Returns a list of dashboards with a specific dashboard group ID.
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’).
UpdateDashboardResponse	updateDashboard(UpdateDashboardRequest request)	Updates the specified dashboard.
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.dashboardservice.Dashboard

getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

Field Detail

SERVICE

public static final Service SERVICE

Service instance for Dashboard.

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

DashboardClient

@Deprecated
public DashboardClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

DashboardClient

@Deprecated
public DashboardClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

DashboardClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

DashboardClient

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

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

DashboardClient

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

configuration - ClientBuilderBase.configuration

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

defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory

additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators

DashboardClient

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

DashboardClient

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

DashboardClient

@Deprecated
public DashboardClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                       ClientConfiguration configuration,
                       ClientConfigurator clientConfigurator,
                       RequestSignerFactory defaultRequestSignerFactory,
                       Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                       List<ClientConfigurator> additionalClientConfigurators,
                       String endpoint,
                       ExecutorService executorService)

Deprecated.

Use the builder instead.

Create a new client instance.

Parameters:

authenticationDetailsProvider - The authentication details (see DashboardClient.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 - DashboardClient.Builder.executorService

Method Detail

builder

public static DashboardClient.Builder builder()

Create a builder for this client.

Returns:

builder

setRegion

public void setRegion(Region region)

Description copied from interface: Dashboard

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 Dashboard

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: Dashboard

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 Dashboard

Parameters:

regionId - The public region ID.

changeDashboardGroup

public ChangeDashboardGroupResponse changeDashboardGroup(ChangeDashboardGroupRequest request)

Description copied from interface: Dashboard

Moves a Dashboard resource from one dashboardGroup identifier to another.

When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeDashboardGroup in interface Dashboard

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createDashboard

public CreateDashboardResponse createDashboard(CreateDashboardRequest request)

Description copied from interface: Dashboard

Creates a new dashboard in the dashboard group’s compartment using the details provided in request body.

*Caution:** Resources for the Dashboard service are created in the tenacy's home region. Although it is possible to create dashboard resource in regions other than the home region, you won't be able to view those resources in the Console. Therefore, creating resources outside of the home region is not recommended.

Specified by:

createDashboard in interface Dashboard

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteDashboard

public DeleteDashboardResponse deleteDashboard(DeleteDashboardRequest request)

Description copied from interface: Dashboard

Deletes the specified dashboard.

Uses the dashboard’s OCID to determine which dashboard to delete.

Specified by:

deleteDashboard in interface Dashboard

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getDashboard

public GetDashboardResponse getDashboard(GetDashboardRequest request)

Description copied from interface: Dashboard

Gets the specified dashboard’s information.

Uses the dashboard’s OCID to determine which dashboard to retrieve.

Specified by:

getDashboard in interface Dashboard

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listDashboards

public ListDashboardsResponse listDashboards(ListDashboardsRequest request)

Description copied from interface: Dashboard

Returns a list of dashboards with a specific dashboard group ID.

Specified by:

listDashboards in interface Dashboard

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateDashboard

public UpdateDashboardResponse updateDashboard(UpdateDashboardRequest request)

Description copied from interface: Dashboard

Updates the specified dashboard.

Uses the dashboard’s OCID to determine which dashboard to update.

Specified by:

updateDashboard in interface Dashboard

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public DashboardWaiters getWaiters()

Description copied from interface: Dashboard

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface Dashboard

Returns:

The service waiters.

getPaginators

public DashboardPaginators getPaginators()

Description copied from interface: Dashboard

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 interface Dashboard

Returns:

The service paginators.

getDefaultConfigurator

protected ClientConfigurator getDefaultConfigurator()

enableDualStackEndpoints

public void enableDualStackEndpoints(boolean enableDualStackEndpoints)

This method should be used to enable or disable the use of dual-stack endpoints.

The default value is false i.e. dual-stack endpoints are disabled by default.

Parameters:

enableDualStackEndpoints - This flag can be set to true or false to enable or disable the use of dual-stack endpoints respectively

getOptionsMap

public Map<String,Boolean> getOptionsMap()

Return an immutable snapshot representing the current options set for this client.

Returns:

immutable snapshot representing the current options set for this client

getResolvedEndpoint

public String getResolvedEndpoint(Map<String,Object> requiredParametersMap)

Returns the endpoint after filling in the current options, as determined by BaseClient.getOptionsMap(), and then filling in the required parameters in requiredParametersMap into the placeholders in the endpoint.

Parameters:

requiredParametersMap - the map from required parameter name to their values

Returns:

resolved endpoint, with all options and placeholders filled in

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

setEndpoint

public final void setEndpoint(String endpoint)

getEndpoint

public final String getEndpoint()

Get the endpoint of the client.

Note that the endpoint may be parameterized and contain placeholders and options. The region subdomain and realm domain will have been properly replaced already if the endpoint was selected using a Region.

Examples of endpoints this may return:

• Unparameterized endpoints

               https://identity.us-phoenix-1.oci.oraclecloud.com
               https://identity.us-ashburn-1.oci.oraclecloud.com
               https://test-namespace.objectstorage.us-ashburn-1.oci.customer-oci.com
           

• Parameterized endpoints with placeholders

               https://{namespaceName+Dot}objectstorage.us-phoenix-1.oci.customer-oci.com
               https://{namespaceName+Dot}objectstorage.us-ashburn-1.oci.customer-oci.com
           

• Parameterized endpoints with options

               https://{dualStack?ds.:}identity.us-phoenix-1.oci.oraclecloud.com
               https://{dualStack?ds.:}identity.us-ashburn-1.oci.oraclecloud.com
           

• Parameterized endpoints with placeholders and options

               https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-phoenix-1.oci.customer-oci.com
               https://{namespaceName+Dot}{dualStack?ds.:}objectstorage.us-ashburn-1.oci.customer-oci.com
           

To get the actual endpoint for a parameterized request, you can use BaseClient.getResolvedEndpoint(Map) or ParameterizedEndpointUtil.getEndpointWithPopulatedServiceParameters(String, Map, Map).

Returns:

the endpoint being used by the client

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()