| Package | Description |
|---|---|
| org.odpi.egeria.connectors.ibm.igc.clientlibrary |
Implements a client library for integrating with IBM Information Governance Catalog through its REST API.
|
| org.odpi.egeria.connectors.ibm.igc.clientlibrary.model.common |
Defines data constructs representing general IGC object metadata.
|
| Modifier and Type | Method and Description |
|---|---|
void |
IGCRestClient.cacheTypeDetails(String typeName)
Cache detailed information about the IGC object type.
|
String |
IGCRestClient.create(IGCCreate igcCreate)
Create the object described by the provided create object.
|
boolean |
IGCRestClient.delete(String rid)
Delete the object specified by the provided RID.
|
boolean |
IGCRestClient.deleteOpenIgcAsset(String assetXML)
Delete using the provided OpenIGC asset XML: deleting the asset(s) specified within it.
|
boolean |
IGCRestClient.detectLineage(String jobRid)
Run lineage detection against the provided job (by RID).
|
void |
IGCRestClient.disconnect()
Disconnect from IGC REST API and invalidate the session.
|
<T extends Reference> |
IGCRestClient.getAllPages(String propertyName,
ItemList<T> list)
Retrieve all pages of results from a set of Paging details and items, or if there is no next page return the
items provided.
|
List<String> |
IGCRestClient.getAllPropertiesForType(String typeName)
Retrieve the names of all properties for the provided IGC object type, or null if the type is unknown.
|
List<String> |
IGCRestClient.getAllStringPropertiesForType(String typeName)
Retrieve the names of all string properties for the provided IGC object type, or null if the type is unknown.
|
Reference |
IGCRestClient.getAssetById(String rid)
Retrieve all information about an asset from IGC.
|
Reference |
IGCRestClient.getAssetById(String rid,
ObjectCache cache)
Retrieve all information about an asset from IGC.
|
Reference |
IGCRestClient.getAssetRefById(String rid)
Retrieve only the minimal unique properties of an asset from IGC.
|
<T extends Reference> |
IGCRestClient.getAssetWithSubsetOfProperties(String rid,
String assetType,
List<String> properties)
This will generally be the most performant method by which to retrieve asset information, when only
some subset of properties is required
|
<T extends Reference> |
IGCRestClient.getAssetWithSubsetOfProperties(String rid,
String assetType,
List<String> properties,
int pageSize)
This will generally be the most performant method by which to retrieve asset information, when only
some subset of properties is required
|
<T extends Reference> |
IGCRestClient.getAssetWithSubsetOfProperties(String rid,
String assetType,
String[] properties)
This will generally be the most performant method by which to retrieve asset information, when only
some subset of properties is required
|
<T extends Reference> |
IGCRestClient.getAssetWithSubsetOfProperties(String rid,
String assetType,
String[] properties,
int pageSize)
This will generally be the most performant method by which to retrieve asset information, when only
some subset of properties is required
|
String |
IGCRestClient.getDisplayNameForType(String typeName)
Retrieve the display name of this IGC object type.
|
<T extends Reference> |
IGCRestClient.getModificationDetails(T object,
ObjectCache cache)
Ensures that the modification details of the asset are populated (takes no action if already populated or
the asset does not support them).
|
<T extends Reference> |
IGCRestClient.getNextPage(String propertyName,
ItemList<T> list)
Retrieve the next page of results for the provided parameters.
|
List<String> |
IGCRestClient.getNonRelationshipPropertiesForType(String typeName)
Retrieve the names of all non-relationship properties for the provided IGC object type, or null if the type is
unknown.
|
List<String> |
IGCRestClient.getOpenIgcBundles()
Retrieve the set of OpenIGC bundles already defined in the environment.
|
List<String> |
IGCRestClient.getPagedRelationshipPropertiesForType(String typeName)
Retrieve the names of all paged relationship properties for the provided IGC object type, or null if the type is
unknown.
|
TypeDetails |
IGCRestClient.getTypeDetails(String typeName)
Retrieves the type details (all properties and their details) for the provided type name in IGC.
|
TypeDetails |
IGCRestClient.getTypeDetails(String typeName,
boolean view,
boolean create,
boolean edit)
Retrieves the type details (requested properties and their details) for the provided type name in IGC.
|
List<TypeHeader> |
IGCRestClient.getTypes(com.fasterxml.jackson.databind.ObjectMapper objectMapper)
Retrieves the list of metadata types supported by IGC.
|
boolean |
IGCRestClient.hasModificationDetails(String typeName)
Indicates whether assets of this type include modification details (true) or not (false).
|
boolean |
IGCRestClient.isCreatable(String typeName)
Indicates whether the IGC object type can be created (true) or not (false).
|
String |
IGCRestClient.makeCreateRequest(String endpoint,
org.springframework.http.HttpMethod method,
org.springframework.http.MediaType contentType,
String payload)
General utility for making creation requests.
|
String |
IGCRestClient.makeRequest(String endpoint,
org.springframework.http.HttpMethod method,
org.springframework.http.MediaType contentType,
String payload)
General utility for making requests.
|
<T extends Reference> |
IGCRestClient.search(IGCSearch igcSearch)
Retrieve all assets that match the provided search criteria from IGC.
|
boolean |
IGCRestClient.start()
Start the client by trying to connect based on the configured parameters.
|
boolean |
IGCRestClient.update(IGCUpdate igcUpdate)
Apply the update described by the provided update object.
|
boolean |
IGCRestClient.uploadFile(String endpoint,
org.springframework.http.HttpMethod method,
org.springframework.core.io.AbstractResource file)
General utility for uploading binary files.
|
String |
IGCRestClient.upsertOpenIgcAsset(String assetXML)
Upload the provided OpenIGC asset XML: creating the asset(s) if they do not exist, updating if they do.
|
boolean |
IGCRestClient.upsertOpenIgcBundle(String name,
org.springframework.core.io.AbstractResource file)
Upload the specified bundle, creating it if it does not already exist or updating it if it does.
|
| Constructor and Description |
|---|
IGCRestClient(String baseURL,
String authorization)
Creates a new session on the server and retains the cookies to re-use the same session for the life
of the client (or until the session times out); whichever occurs first.
|
IGCRestClient(String baseURL,
String user,
String password)
Creates a new session on the server and retains the cookies to re-use the same session for the life
of the client (or until the session times out); whichever occurs first.
|
IGCRestClient(String host,
String port,
String user,
String password)
Default constructor used by the IGCRestClient.
|
| Modifier and Type | Method and Description |
|---|---|
Identity |
Reference.getIdentity(IGCRestClient igcrest,
ObjectCache cache)
Retrieves the semantic identity of the asset.
|
Copyright © 2018–2021 ODPi. All rights reserved.