Package io.revealbi.core.data
Class RVAzureCosmosDBDataSource
java.lang.Object
io.revealbi.core.data.RVDashboardDataSource
io.revealbi.core.data.RVAzureCosmosDBDataSource
- All Implemented Interfaces:
IProcessDataOnServerDataSource
public class RVAzureCosmosDBDataSource
extends RVDashboardDataSource
implements IProcessDataOnServerDataSource
Azure CosmosDB data source.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanWhen set to true, the HTTP client accepts any server certificate without validation.Gets or sets the URI of the Azure CosmosDB account endpoint (e.g.Gets or sets the preferred Azure region for read and write operations.Gets or sets the connection mode used to communicate with the CosmosDB service.Gets or sets the name of the database to connect to.booleanGets the default value for "Process Data on Server" option for this data source.booleanWhen true, the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.voidsetAcceptAnyServerCertificate(boolean acceptAnyServerCertificate) When set to true, the HTTP client accepts any server certificate without validation.voidsetAccountEndpoint(String accountEndpoint) Gets or sets the URI of the Azure CosmosDB account endpoint (e.g.voidsetApplicationRegion(String applicationRegion) Gets or sets the preferred Azure region for read and write operations.voidsetConnectionMode(RVAzureCosmosDBConnectionMode connectionMode) Gets or sets the connection mode used to communicate with the CosmosDB service.voidsetDatabase(String database) Gets or sets the name of the database to connect to.voidsetProcessDataOnServerDefaultValue(boolean processDataOnServerDefaultValue) Sets the default value for "Process Data on Server" option for this data source.voidsetProcessDataOnServerReadOnly(boolean processDataOnServerReadOnly) When set to true, the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.Methods inherited from class io.revealbi.core.data.RVDashboardDataSource
getDefaultRefreshRate, getId, getSubtitle, getTitle, setDefaultRefreshRate, setId, setSubtitle, setTitle
-
Field Details
-
PROVIDER_KEY
- See Also:
-
-
Constructor Details
-
RVAzureCosmosDBDataSource
public RVAzureCosmosDBDataSource()
-
-
Method Details
-
getAccountEndpoint
Gets or sets the URI of the Azure CosmosDB account endpoint (e.g. https://myaccount.documents.azure.com:443/).- Returns:
- the account endpoint URI
-
setAccountEndpoint
Gets or sets the URI of the Azure CosmosDB account endpoint (e.g. https://myaccount.documents.azure.com:443/).- Parameters:
accountEndpoint- the account endpoint URI
-
getApplicationRegion
Gets or sets the preferred Azure region for read and write operations. Leave null to use the account default.- Returns:
- the preferred application region, or null to use the account default
-
setApplicationRegion
Gets or sets the preferred Azure region for read and write operations. Leave null to use the account default.- Parameters:
applicationRegion- the preferred application region
-
getConnectionMode
Gets or sets the connection mode used to communicate with the CosmosDB service. Defaults toRVAzureCosmosDBConnectionMode.GATEWAY.- Returns:
- the connection mode
-
setConnectionMode
Gets or sets the connection mode used to communicate with the CosmosDB service. Defaults toRVAzureCosmosDBConnectionMode.GATEWAY.- Parameters:
connectionMode- the connection mode
-
getAcceptAnyServerCertificate
public boolean getAcceptAnyServerCertificate()When set to true, the HTTP client accepts any server certificate without validation. Useful in development or test environments with self-signed certificates. Do not use in production.- Returns:
- true if any server certificate is accepted
-
setAcceptAnyServerCertificate
public void setAcceptAnyServerCertificate(boolean acceptAnyServerCertificate) When set to true, the HTTP client accepts any server certificate without validation. Useful in development or test environments with self-signed certificates. Do not use in production.- Parameters:
acceptAnyServerCertificate- true to accept any server certificate
-
getDatabase
Gets or sets the name of the database to connect to.- Returns:
- the database name
-
setDatabase
Gets or sets the name of the database to connect to.- Parameters:
database- the database name
-
getProcessDataOnServerDefaultValue
public boolean getProcessDataOnServerDefaultValue()Gets the default value for "Process Data on Server" option for this data source. The end user can still change the value, unlessgetProcessDataOnServerReadOnly()is true.- Specified by:
getProcessDataOnServerDefaultValuein interfaceIProcessDataOnServerDataSource- Returns:
- the default value for the "Process Data on Server" option
-
setProcessDataOnServerDefaultValue
public void setProcessDataOnServerDefaultValue(boolean processDataOnServerDefaultValue) Sets the default value for "Process Data on Server" option for this data source. The end user can still change the value, unlesssetProcessDataOnServerReadOnly(boolean)is true.- Specified by:
setProcessDataOnServerDefaultValuein interfaceIProcessDataOnServerDataSource- Parameters:
processDataOnServerDefaultValue- the default value
-
getProcessDataOnServerReadOnly
public boolean getProcessDataOnServerReadOnly()When true, the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.- Specified by:
getProcessDataOnServerReadOnlyin interfaceIProcessDataOnServerDataSource- Returns:
- true if the option is read-only
-
setProcessDataOnServerReadOnly
public void setProcessDataOnServerReadOnly(boolean processDataOnServerReadOnly) When set to true, the user will not be allowed to change the value for "Process Data on Server" option and the default value will be used.- Specified by:
setProcessDataOnServerReadOnlyin interfaceIProcessDataOnServerDataSource- Parameters:
processDataOnServerReadOnly- true to make the option read-only
-
getProviderKey
- Specified by:
getProviderKeyin classRVDashboardDataSource
-