com.ibm.cloud.data_virtualization.v1

Class DataVirtualization

java.lang.Object

com.ibm.cloud.sdk.core.service.BaseService

com.ibm.cloud.data_virtualization.v1.DataVirtualization

public class DataVirtualization
extends com.ibm.cloud.sdk.core.service.BaseService

The Data Virtualization REST API connects to your service, so you can manage your virtual data, data sources, and user roles. API Version: 1.6.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_NAME

Fields inherited from class com.ibm.cloud.sdk.core.service.BaseService

PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_ENABLE_RETRIES, PROPNAME_MAX_RETRIES, PROPNAME_RETRY_INTERVAL, PROPNAME_URL

Constructor Summary

Constructors

Constructor and Description
DataVirtualization(String serviceName, com.ibm.cloud.sdk.core.security.Authenticator authenticator) Constructs an instance of the `DataVirtualization` client.

Method Summary

Modifier and Type	Method and Description
com.ibm.cloud.sdk.core.http.ServiceCall<PostDatasourceConnection>	addDatasourceConnection(AddDatasourceConnectionOptions addDatasourceConnectionOptions) Add data source connection.
com.ibm.cloud.sdk.core.http.ServiceCall<CheckPolicyStatusV2Response>	checkPolicyStatusV2() Get policy enforcement status.
com.ibm.cloud.sdk.core.http.ServiceCall<CheckPolicyStatusV2Response>	checkPolicyStatusV2(CheckPolicyStatusV2Options checkPolicyStatusV2Options) Get policy enforcement status.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteDatasourceConnection(DeleteDatasourceConnectionOptions deleteDatasourceConnectionOptions) Delete data source connection.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deletePrimaryCatalog(DeletePrimaryCatalogOptions deletePrimaryCatalogOptions) Delete primary catalog.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	deleteTable(DeleteTableOptions deleteTableOptions) Delete virtualized table.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	dvaasRevokeRoleFromTable(DvaasRevokeRoleFromTableOptions dvaasRevokeRoleFromTableOptions) Delete role.
com.ibm.cloud.sdk.core.http.ServiceCall<VirtualizeTableResponse>	dvaasVirtualizeTable(DvaasVirtualizeTableOptions dvaasVirtualizeTableOptions) Virtualize table.
com.ibm.cloud.sdk.core.http.ServiceCall<CacheResponse>	getCache(GetCacheOptions getCacheOptions) List a cache.
com.ibm.cloud.sdk.core.http.ServiceCall<CacheListResponse>	getCachesList() List caches.
com.ibm.cloud.sdk.core.http.ServiceCall<CacheListResponse>	getCachesList(GetCachesListOptions getCachesListOptions) List caches.
com.ibm.cloud.sdk.core.http.ServiceCall<StorageDetails>	getCacheStorageDetail() Fetch the cache storage.
com.ibm.cloud.sdk.core.http.ServiceCall<StorageDetails>	getCacheStorageDetail(GetCacheStorageDetailOptions getCacheStorageDetailOptions) Fetch the cache storage.
com.ibm.cloud.sdk.core.http.ServiceCall<ObjStoreConnectionResponseV2>	getObjectStoreConnectionsV2() Gets object store connection details.
com.ibm.cloud.sdk.core.http.ServiceCall<ObjStoreConnectionResponseV2>	getObjectStoreConnectionsV2(GetObjectStoreConnectionsV2Options getObjectStoreConnectionsV2Options) Gets object store connection details.
com.ibm.cloud.sdk.core.http.ServiceCall<PrimaryCatalogInfo>	getPrimaryCatalog() Get primary catalog ID.
com.ibm.cloud.sdk.core.http.ServiceCall<PrimaryCatalogInfo>	getPrimaryCatalog(GetPrimaryCatalogOptions getPrimaryCatalogOptions) Get primary catalog ID.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	grantRolesToVirtualizedTable(GrantRolesToVirtualizedTableOptions grantRolesToVirtualizedTableOptions) Grant user role.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	grantUserToVirtualTable(GrantUserToVirtualTableOptions grantUserToVirtualTableOptions) Grant user access.
com.ibm.cloud.sdk.core.http.ServiceCall<DatasourceConnectionsList>	listDatasourceConnections() Get data source connections.
com.ibm.cloud.sdk.core.http.ServiceCall<DatasourceConnectionsList>	listDatasourceConnections(ListDatasourceConnectionsOptions listDatasourceConnectionsOptions) Get data source connections.
com.ibm.cloud.sdk.core.http.ServiceCall<TablesForRoleResponse>	listTablesForRole(ListTablesForRoleOptions listTablesForRoleOptions) Get virtualized tables by role.
static DataVirtualization	newInstance() Class method which constructs an instance of the `DataVirtualization` client.
static DataVirtualization	newInstance(String serviceName) Class method which constructs an instance of the `DataVirtualization` client.
com.ibm.cloud.sdk.core.http.ServiceCall<PostPrimaryCatalog>	postPrimaryCatalog(PostPrimaryCatalogOptions postPrimaryCatalogOptions) Add primary catalog.
com.ibm.cloud.sdk.core.http.ServiceCall<CatalogPublishResponse>	publishAssets(PublishAssetsOptions publishAssetsOptions) Publish virtual tables to a catalog.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	revokeUserFromObject(RevokeUserFromObjectOptions revokeUserFromObjectOptions) Revoke user acccess.
com.ibm.cloud.sdk.core.http.ServiceCall<TurnOnPolicyV2Response>	turnOnPolicyV2(TurnOnPolicyV2Options turnOnPolicyV2Options) Turn policy enforcement status on or off.
com.ibm.cloud.sdk.core.http.ServiceCall<SuccessResponse>	virtualizeCosV2(VirtualizeCosV2Options virtualizeCosV2Options) Create a remote table for the ORC or Parquet file on a cloud object store (COS).

Methods inherited from class com.ibm.cloud.sdk.core.service.BaseService

configureClient, configureService, constructServiceUrl, constructServiceURL, disableRetries, enableGzipCompression, enableRetries, getAuthenticator, getClient, getEndPoint, getName, getServiceUrl, isJsonMimeType, isJsonPatchMimeType, setClient, setDefaultHeaders, setEndPoint, setServiceUrl, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SERVICE_NAME

public static final String DEFAULT_SERVICE_NAME

See Also:

Constant Field Values

Constructor Detail

DataVirtualization

public DataVirtualization(String serviceName,
                          com.ibm.cloud.sdk.core.security.Authenticator authenticator)

Constructs an instance of the `DataVirtualization` client. The specified service name and authenticator are used to configure the client instance.

Parameters:

serviceName - the service name to be used when configuring the client instance

authenticator - the Authenticator instance to be configured for this client

Method Detail

newInstance

public static DataVirtualization newInstance()

Class method which constructs an instance of the `DataVirtualization` client. The default service name is used to configure the client instance.

Returns:

an instance of the `DataVirtualization` client using external configuration

newInstance

public static DataVirtualization newInstance(String serviceName)

Class method which constructs an instance of the `DataVirtualization` client. The specified service name is used to configure the client instance.

Parameters:

serviceName - the service name to be used when configuring the client instance

Returns:

an instance of the `DataVirtualization` client using external configuration

listDatasourceConnections

public com.ibm.cloud.sdk.core.http.ServiceCall<DatasourceConnectionsList> listDatasourceConnections(ListDatasourceConnectionsOptions listDatasourceConnectionsOptions)

Get data source connections. Gets all data source connections that are connected to the service.

Parameters:

listDatasourceConnectionsOptions - the ListDatasourceConnectionsOptions containing the options for the call

Returns:

a ServiceCall with a result of type DatasourceConnectionsList

listDatasourceConnections

public com.ibm.cloud.sdk.core.http.ServiceCall<DatasourceConnectionsList> listDatasourceConnections()

Get data source connections. Gets all data source connections that are connected to the service.

Returns:

a ServiceCall with a result of type DatasourceConnectionsList

addDatasourceConnection

public com.ibm.cloud.sdk.core.http.ServiceCall<PostDatasourceConnection> addDatasourceConnection(AddDatasourceConnectionOptions addDatasourceConnectionOptions)

Add data source connection. Adds a data source connection to the Data Virtualization service.

Parameters:

addDatasourceConnectionOptions - the AddDatasourceConnectionOptions containing the options for the call

Returns:

a ServiceCall with a result of type PostDatasourceConnection

deleteDatasourceConnection

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteDatasourceConnection(DeleteDatasourceConnectionOptions deleteDatasourceConnectionOptions)

Delete data source connection. Deletes a data source connection from the Data Virtualization service.

Parameters:

deleteDatasourceConnectionOptions - the DeleteDatasourceConnectionOptions containing the options for the call

Returns:

a ServiceCall with a void result

getObjectStoreConnectionsV2

public com.ibm.cloud.sdk.core.http.ServiceCall<ObjStoreConnectionResponseV2> getObjectStoreConnectionsV2(GetObjectStoreConnectionsV2Options getObjectStoreConnectionsV2Options)

Gets object store connection details.

Parameters:

getObjectStoreConnectionsV2Options - the GetObjectStoreConnectionsV2Options containing the options for the call

Returns:

a ServiceCall with a result of type ObjStoreConnectionResponseV2

getObjectStoreConnectionsV2

public com.ibm.cloud.sdk.core.http.ServiceCall<ObjStoreConnectionResponseV2> getObjectStoreConnectionsV2()

Gets object store connection details.

Returns:

a ServiceCall with a result of type ObjStoreConnectionResponseV2

grantUserToVirtualTable

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> grantUserToVirtualTable(GrantUserToVirtualTableOptions grantUserToVirtualTableOptions)

Grant user access. Grants a user access to a specific virtualized table.

Parameters:

grantUserToVirtualTableOptions - the GrantUserToVirtualTableOptions containing the options for the call

Returns:

a ServiceCall with a void result

revokeUserFromObject

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> revokeUserFromObject(RevokeUserFromObjectOptions revokeUserFromObjectOptions)

Revoke user acccess. Revokes user access to the virtualized table.

Parameters:

revokeUserFromObjectOptions - the RevokeUserFromObjectOptions containing the options for the call

Returns:

a ServiceCall with a void result

grantRolesToVirtualizedTable

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> grantRolesToVirtualizedTable(GrantRolesToVirtualizedTableOptions grantRolesToVirtualizedTableOptions)

Grant user role. Grants a user role access to a specific virtualized table.

Parameters:

grantRolesToVirtualizedTableOptions - the GrantRolesToVirtualizedTableOptions containing the options for the call

Returns:

a ServiceCall with a void result

dvaasRevokeRoleFromTable

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> dvaasRevokeRoleFromTable(DvaasRevokeRoleFromTableOptions dvaasRevokeRoleFromTableOptions)

Delete role. Revokes roles for a virtualized table.

Parameters:

dvaasRevokeRoleFromTableOptions - the DvaasRevokeRoleFromTableOptions containing the options for the call

Returns:

a ServiceCall with a void result

listTablesForRole

public com.ibm.cloud.sdk.core.http.ServiceCall<TablesForRoleResponse> listTablesForRole(ListTablesForRoleOptions listTablesForRoleOptions)

Get virtualized tables by role. Retrieves the list of virtualized tables that have a specific role.

Parameters:

listTablesForRoleOptions - the ListTablesForRoleOptions containing the options for the call

Returns:

a ServiceCall with a result of type TablesForRoleResponse

turnOnPolicyV2

public com.ibm.cloud.sdk.core.http.ServiceCall<TurnOnPolicyV2Response> turnOnPolicyV2(TurnOnPolicyV2Options turnOnPolicyV2Options)

Turn policy enforcement status on or off. Turns policy enforcement status on or off.

Parameters:

turnOnPolicyV2Options - the TurnOnPolicyV2Options containing the options for the call

Returns:

a ServiceCall with a result of type TurnOnPolicyV2Response

checkPolicyStatusV2

public com.ibm.cloud.sdk.core.http.ServiceCall<CheckPolicyStatusV2Response> checkPolicyStatusV2(CheckPolicyStatusV2Options checkPolicyStatusV2Options)

Get policy enforcement status. Get policy enforcement status, return enabled or disabled.

Parameters:

checkPolicyStatusV2Options - the CheckPolicyStatusV2Options containing the options for the call

Returns:

a ServiceCall with a result of type CheckPolicyStatusV2Response

checkPolicyStatusV2

public com.ibm.cloud.sdk.core.http.ServiceCall<CheckPolicyStatusV2Response> checkPolicyStatusV2()

Get policy enforcement status. Get policy enforcement status, return enabled or disabled.

Returns:

a ServiceCall with a result of type CheckPolicyStatusV2Response

dvaasVirtualizeTable

public com.ibm.cloud.sdk.core.http.ServiceCall<VirtualizeTableResponse> dvaasVirtualizeTable(DvaasVirtualizeTableOptions dvaasVirtualizeTableOptions)

Virtualize table. Transforms a given data source table into a virtualized table.

Parameters:

dvaasVirtualizeTableOptions - the DvaasVirtualizeTableOptions containing the options for the call

Returns:

a ServiceCall with a result of type VirtualizeTableResponse

deleteTable

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deleteTable(DeleteTableOptions deleteTableOptions)

Delete virtualized table. Removes the specified virtualized table. You must specify the schema and table name.

Parameters:

deleteTableOptions - the DeleteTableOptions containing the options for the call

Returns:

a ServiceCall with a void result

virtualizeCosV2

public com.ibm.cloud.sdk.core.http.ServiceCall<SuccessResponse> virtualizeCosV2(VirtualizeCosV2Options virtualizeCosV2Options)

Create a remote table for the ORC or Parquet file on a cloud object store (COS). Create a remote table for the ORC or Parquet file on a cloud object store (COS).

Parameters:

virtualizeCosV2Options - the VirtualizeCosV2Options containing the options for the call

Returns:

a ServiceCall with a result of type SuccessResponse

getPrimaryCatalog

public com.ibm.cloud.sdk.core.http.ServiceCall<PrimaryCatalogInfo> getPrimaryCatalog(GetPrimaryCatalogOptions getPrimaryCatalogOptions)

Get primary catalog ID. Gets the primary catalog ID from the DVSYS.INSTANCE_INFO table.

Parameters:

getPrimaryCatalogOptions - the GetPrimaryCatalogOptions containing the options for the call

Returns:

a ServiceCall with a result of type PrimaryCatalogInfo

getPrimaryCatalog

public com.ibm.cloud.sdk.core.http.ServiceCall<PrimaryCatalogInfo> getPrimaryCatalog()

Get primary catalog ID. Gets the primary catalog ID from the DVSYS.INSTANCE_INFO table.

Returns:

a ServiceCall with a result of type PrimaryCatalogInfo

postPrimaryCatalog

public com.ibm.cloud.sdk.core.http.ServiceCall<PostPrimaryCatalog> postPrimaryCatalog(PostPrimaryCatalogOptions postPrimaryCatalogOptions)

Add primary catalog. Inserts primary catalog ID into table DVSYS.INSTANCE_INFO.

Parameters:

postPrimaryCatalogOptions - the PostPrimaryCatalogOptions containing the options for the call

Returns:

a ServiceCall with a result of type PostPrimaryCatalog

deletePrimaryCatalog

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> deletePrimaryCatalog(DeletePrimaryCatalogOptions deletePrimaryCatalogOptions)

Delete primary catalog. Delete primary catalog item in the DVSYS.INSTANCE_INFO table.

Parameters:

deletePrimaryCatalogOptions - the DeletePrimaryCatalogOptions containing the options for the call

Returns:

a ServiceCall with a void result

publishAssets

public com.ibm.cloud.sdk.core.http.ServiceCall<CatalogPublishResponse> publishAssets(PublishAssetsOptions publishAssetsOptions)

Publish virtual tables to a catalog. Publishes virtual tables to a catalog.

Parameters:

publishAssetsOptions - the PublishAssetsOptions containing the options for the call

Returns:

a ServiceCall with a result of type CatalogPublishResponse

getCachesList

public com.ibm.cloud.sdk.core.http.ServiceCall<CacheListResponse> getCachesList(GetCachesListOptions getCachesListOptions)

List caches. List all active, inactive and deleted caches in Data Virtualization.

Parameters:

getCachesListOptions - the GetCachesListOptions containing the options for the call

Returns:

a ServiceCall with a result of type CacheListResponse

getCachesList

public com.ibm.cloud.sdk.core.http.ServiceCall<CacheListResponse> getCachesList()

List caches. List all active, inactive and deleted caches in Data Virtualization.

Returns:

a ServiceCall with a result of type CacheListResponse

getCache

public com.ibm.cloud.sdk.core.http.ServiceCall<CacheResponse> getCache(GetCacheOptions getCacheOptions)

List a cache. List a specific cache in Data Virtualization.

Parameters:

getCacheOptions - the GetCacheOptions containing the options for the call

Returns:

a ServiceCall with a result of type CacheResponse

getCacheStorageDetail

public com.ibm.cloud.sdk.core.http.ServiceCall<StorageDetails> getCacheStorageDetail(GetCacheStorageDetailOptions getCacheStorageDetailOptions)

Fetch the cache storage. Fetch the total cache storage and used capacities for active and inactive caches in Data Virtualization.

Parameters:

getCacheStorageDetailOptions - the GetCacheStorageDetailOptions containing the options for the call

Returns:

a ServiceCall with a result of type StorageDetails

getCacheStorageDetail

public com.ibm.cloud.sdk.core.http.ServiceCall<StorageDetails> getCacheStorageDetail()

Fetch the cache storage. Fetch the total cache storage and used capacities for active and inactive caches in Data Virtualization.

Returns:

a ServiceCall with a result of type StorageDetails