com.ibm.analytics.mdm.v0

Class Mdm

java.lang.Object

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

com.ibm.analytics.mdm.v0.Mdm

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

Discover REST APIs available within Master Data Management.

Version:

v0

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SERVICE_NAME
static String	DEFAULT_SERVICE_URL

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

PROPNAME_DISABLE_SSL, PROPNAME_ENABLE_GZIP, PROPNAME_URL

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,List<RulesResponseEntityRule>>>	addRule(AddRuleOptions addRuleOptions) Create or overwrite one or more manual linkage rules.
com.ibm.cloud.sdk.core.http.ServiceCall<ProcessStatus>	bulkLoad(BulkLoadOptions bulkLoadOptions) Bulk load project metadata assets.
com.ibm.cloud.sdk.core.http.ServiceCall<PostCloudJobResponse>	cloudDeriveJob(CloudDeriveJobOptions cloudDeriveJobOptions) Perform asynchronous processing of the derive job of a data file in IBM Cloud Storage.
com.ibm.cloud.sdk.core.http.ServiceCall<PostCloudJobResponse>	cloudMatchJob(CloudMatchJobOptions cloudMatchJobOptions) Perform asynchronous processing of the match job.
com.ibm.cloud.sdk.core.http.ServiceCall<PostCloudJobResponse>	cloudReportIndex(CloudReportIndexOptions cloudReportIndexOptions) Perform asynchronous reporting of index metrics.
com.ibm.cloud.sdk.core.http.ServiceCall<CompareResponse>	compareIndex(CompareIndexOptions compareIndexOptions) Compare source records.
com.ibm.cloud.sdk.core.http.ServiceCall<AssetMetadataResponse>	createConfigurationAsset(CreateConfigurationAssetOptions createConfigurationAssetOptions) Create configuration metadata asset.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	dataCleanUpJob(DataCleanUpJobOptions dataCleanUpJobOptions) Clean up job data.
com.ibm.cloud.sdk.core.http.ServiceCall<RecordResponse>	dataCreateRecord(DataCreateRecordOptions dataCreateRecordOptions) Create a new record.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	dataDeleteRecord(DataDeleteRecordOptions dataDeleteRecordOptions) Delete a record from the graph.
com.ibm.cloud.sdk.core.http.ServiceCall<BucketCredentialsResponse>	dataGenerateBucketCredentials() Generate bucket credentials.
com.ibm.cloud.sdk.core.http.ServiceCall<BucketCredentialsResponse>	dataGenerateBucketCredentials(DataGenerateBucketCredentialsOptions dataGenerateBucketCredentialsOptions) Generate bucket credentials.
com.ibm.cloud.sdk.core.http.ServiceCall<EntitiesResponse>	dataGetEntitiesForRecord(DataGetEntitiesForRecordOptions dataGetEntitiesForRecordOptions) Get a list of entities for a given record.
com.ibm.cloud.sdk.core.http.ServiceCall<EntityResponse>	dataGetEntity(DataGetEntityOptions dataGetEntityOptions) Get the composite view for an entity.
com.ibm.cloud.sdk.core.http.ServiceCall<ExportResponse>	dataGetExport(DataGetExportOptions dataGetExportOptions) Get information for a given export.
com.ibm.cloud.sdk.core.http.ServiceCall<InputStream>	dataGetExportDownload(DataGetExportDownloadOptions dataGetExportDownloadOptions) Get the export download.
com.ibm.cloud.sdk.core.http.ServiceCall<ExportsResponse>	dataGetExports() Get a list of exports.
com.ibm.cloud.sdk.core.http.ServiceCall<ExportsResponse>	dataGetExports(DataGetExportsOptions dataGetExportsOptions) Get a list of exports.
com.ibm.cloud.sdk.core.http.ServiceCall<StatisticsResultResponse>	dataGetGraphStatistics() Fetch graph statistics.
com.ibm.cloud.sdk.core.http.ServiceCall<StatisticsResultResponse>	dataGetGraphStatistics(DataGetGraphStatisticsOptions dataGetGraphStatisticsOptions) Fetch graph statistics.
com.ibm.cloud.sdk.core.http.ServiceCall<JobResponse>	dataGetJob(DataGetJobOptions dataGetJobOptions) Get information for a given job.
com.ibm.cloud.sdk.core.http.ServiceCall<JobsResponse>	dataGetJobs() List all jobs.
com.ibm.cloud.sdk.core.http.ServiceCall<JobsResponse>	dataGetJobs(DataGetJobsOptions dataGetJobsOptions) List all jobs.
com.ibm.cloud.sdk.core.http.ServiceCall<RecordResponse>	dataGetRecord(DataGetRecordOptions dataGetRecordOptions) Get a single record.
com.ibm.cloud.sdk.core.http.ServiceCall<RecordsResponse>	dataGetRecords() List all records.
com.ibm.cloud.sdk.core.http.ServiceCall<RecordsResponse>	dataGetRecords(DataGetRecordsOptions dataGetRecordsOptions) List all records.
com.ibm.cloud.sdk.core.http.ServiceCall<RecordsResponse>	dataGetRecordsForEntity(DataGetRecordsForEntityOptions dataGetRecordsForEntityOptions) Get all records associated with an entity.
com.ibm.cloud.sdk.core.http.ServiceCall<RelatedRecordsResponse>	dataGetRelatedRecordsForEntity(DataGetRelatedRecordsForEntityOptions dataGetRelatedRecordsForEntityOptions) Get all related records associated with an entity.
com.ibm.cloud.sdk.core.http.ServiceCall<RelatedRecordsResponse>	dataGetRelatedRecordsForRecord(DataGetRelatedRecordsForRecordOptions dataGetRelatedRecordsForRecordOptions) Retrieves related records for a given record.
com.ibm.cloud.sdk.core.http.ServiceCall<RelationshipResponse>	dataGetRelationshipForRecord(DataGetRelationshipForRecordOptions dataGetRelationshipForRecordOptions) Get a single given relationship for a given record.
com.ibm.cloud.sdk.core.http.ServiceCall<RelationshipsResponse>	dataGetRelationshipsForRecord(DataGetRelationshipsForRecordOptions dataGetRelationshipsForRecordOptions) List the relationships for a single given record.
com.ibm.cloud.sdk.core.http.ServiceCall<SubgraphResponse>	dataGetSubgraph() Get surrounding vertices and edges for a set of vertices.
com.ibm.cloud.sdk.core.http.ServiceCall<SubgraphResponse>	dataGetSubgraph(DataGetSubgraphOptions dataGetSubgraphOptions) Get surrounding vertices and edges for a set of vertices.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	dataRevokeBucketCredentials() Revoke a bucket API key.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	dataRevokeBucketCredentials(DataRevokeBucketCredentialsOptions dataRevokeBucketCredentialsOptions) Revoke a bucket API key.
com.ibm.cloud.sdk.core.http.ServiceCall<BulkLoadResponse>	dataRunBulkLoad() Start an operation to bulk load data into the graph.
com.ibm.cloud.sdk.core.http.ServiceCall<BulkLoadResponse>	dataRunBulkLoad(DataRunBulkLoadOptions dataRunBulkLoadOptions) Start an operation to bulk load data into the graph.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	dataRunBulkUpdate() Start an operation to perform a bulk update to the graph.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	dataRunBulkUpdate(DataRunBulkUpdateOptions dataRunBulkUpdateOptions) Start an operation to perform a bulk update to the graph.
com.ibm.cloud.sdk.core.http.ServiceCall<ExportResponse>	dataRunExport() Run a full text or property query search and export the results to a csv, tsv, or psv file.
com.ibm.cloud.sdk.core.http.ServiceCall<ExportResponse>	dataRunExport(DataRunExportOptions dataRunExportOptions) Run a full text or property query search and export the results to a csv, tsv, or psv file.
com.ibm.cloud.sdk.core.http.ServiceCall<SearchResultResponse>	dataSearch(DataSearchOptions dataSearchOptions) Run a full text or property query search.
com.ibm.cloud.sdk.core.http.ServiceCall<JobResponse>	dataStopJob(DataStopJobOptions dataStopJobOptions) Stop a given job.
com.ibm.cloud.sdk.core.http.ServiceCall<RecordResponse>	dataUpdateRecord(DataUpdateRecordOptions dataUpdateRecordOptions) Update record information for an existing record.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	dataUpdateSchema() Start an operation to update schema when model changes.
com.ibm.cloud.sdk.core.http.ServiceCall<Void>	dataUpdateSchema(DataUpdateSchemaOptions dataUpdateSchemaOptions) Start an operation to update schema when model changes.
com.ibm.cloud.sdk.core.http.ServiceCall<PutIndexResponse>	deleteIndex(DeleteIndexOptions deleteIndexOptions) Remove the derived matching data for given source record keys.
com.ibm.cloud.sdk.core.http.ServiceCall<PostDeriveResponse>	deriveIndex(DeriveIndexOptions deriveIndexOptions) Preview the derived matching data for given source records.
com.ibm.cloud.sdk.core.http.ServiceCall<ProcessListResponse>	getAllProcesses(GetAllProcessesOptions getAllProcessesOptions) Gets the process details.
com.ibm.cloud.sdk.core.http.ServiceCall<GetCloudJobSummaryResponse>	getCloudJobSummary(GetCloudJobSummaryOptions getCloudJobSummaryOptions) Retrieve the summary of a processed job.
com.ibm.cloud.sdk.core.http.ServiceCall<ConfigDataModel>	getConfigDataModel(GetConfigDataModelOptions getConfigDataModelOptions) Get config data model.
com.ibm.cloud.sdk.core.http.ServiceCall<ConfigDataModelAttributes>	getConfigDataModelAttributes(GetConfigDataModelAttributesOptions getConfigDataModelAttributesOptions) Get Config Data Model Record Type Attributes.
com.ibm.cloud.sdk.core.http.ServiceCall<ConfigurationMetadata>	getConfigurationMetadata(GetConfigurationMetadataOptions getConfigurationMetadataOptions) Get configuration metadata.
String	getCrn() Gets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<GetIndexResponse>	getIndex(GetIndexOptions getIndexOptions) Retrieve the derived matching data for given source record keys.
com.ibm.cloud.sdk.core.http.ServiceCall<MatchStatistics>	getMatchingStatistics(GetMatchingStatisticsOptions getMatchingStatisticsOptions) Get matching statistics.
com.ibm.cloud.sdk.core.http.ServiceCall<ProcessResponse>	getProcessByProcessName(GetProcessByProcessNameOptions getProcessByProcessNameOptions) Get process by process name.
com.ibm.cloud.sdk.core.http.ServiceCall<ProcessStatus>	getProcessStatus(GetProcessStatusOptions getProcessStatusOptions) Get process status.
com.ibm.cloud.sdk.core.http.ServiceCall<GetRecordKeys>	getRecords(GetRecordsOptions getRecordsOptions) Get record keys of a given entity_id.
com.ibm.cloud.sdk.core.http.ServiceCall<PostResetResponse>	indexServiceReset(IndexServiceResetOptions indexServiceResetOptions) Remove all the derived matching data for the supplied record type.
com.ibm.cloud.sdk.core.http.ServiceCall<GetSummaryResponse>	indexSummary(IndexSummaryOptions indexSummaryOptions) Retrieve a summary of derived matching data.
com.ibm.cloud.sdk.core.http.ServiceCall<MatchingStatus>	initiateMatching(InitiateMatchingOptions initiateMatchingOptions) Initiates matching for configuration.
com.ibm.cloud.sdk.core.http.ServiceCall<GetEntityIds>	listEntity(ListEntityOptions listEntityOptions) Get entity ids.
com.ibm.cloud.sdk.core.http.ServiceCall<PutIndexResponse>	matchIndex(MatchIndexOptions matchIndexOptions) Create or overwrite the derived matching data for a given source record.
com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,Object>>	modelDeleteFlow(ModelDeleteFlowOptions modelDeleteFlowOptions) Remove an idle workflow specified by the supplied flow_id.
com.ibm.cloud.sdk.core.http.ServiceCall<Algorithm>	modelGetAlgorithm(ModelGetAlgorithmOptions modelGetAlgorithmOptions) Retrieve the matching algorithm for a given record type.
com.ibm.cloud.sdk.core.http.ServiceCall<CompareSpecResource>	modelGetComparespecResource(ModelGetComparespecResourceOptions modelGetComparespecResourceOptions) Retrieve the comparison parameters, commonly used by matching algorithms.
com.ibm.cloud.sdk.core.http.ServiceCall<CompositeRules>	modelGetCompositeRules(ModelGetCompositeRulesOptions modelGetCompositeRulesOptions) Retrieve the survivorship rules applicable to entity types, as defined by matching algorithms.
com.ibm.cloud.sdk.core.http.ServiceCall<DataModel>	modelGetDataModel(ModelGetDataModelOptions modelGetDataModelOptions) Retrieve the data model for record types and relationship types.
com.ibm.cloud.sdk.core.http.ServiceCall<GetFlowResponse>	modelGetFlowById(ModelGetFlowByIdOptions modelGetFlowByIdOptions) Retrieve the latest workflow information of a previously requested change to data model or matching algorithm.
com.ibm.cloud.sdk.core.http.ServiceCall<InstanceMetadata>	modelGetInstanceMetadata(ModelGetInstanceMetadataOptions modelGetInstanceMetadataOptions) Retrieve the configured metadata for a provisioned instance of system.
com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,List<MapResourceEntry>>>	modelGetMapResource(ModelGetMapResourceOptions modelGetMapResourceOptions) Retrieve the configuration for the equivalent words, commonly used by matching algorithms.
com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,SetResourceEntry>>	modelGetSetResource(ModelGetSetResourceOptions modelGetSetResourceOptions) Retrieve the configuration for the anonymous set of words, commonly used by matching algorithms.
com.ibm.cloud.sdk.core.http.ServiceCall<CompareSpecResourceNames>	modelListComparespecResoures(ModelListComparespecResouresOptions modelListComparespecResouresOptions) Retrieve the list of existing comparison parameters.
com.ibm.cloud.sdk.core.http.ServiceCall<MapResourceNames>	modelListMapResources(ModelListMapResourcesOptions modelListMapResourcesOptions) Retrieve the list of existing configurations for the equivalent words.
com.ibm.cloud.sdk.core.http.ServiceCall<SetResourceNames>	modelListSetResources(ModelListSetResourcesOptions modelListSetResourcesOptions) Retrieve the list of existing configurations for the anonymous set of words.
com.ibm.cloud.sdk.core.http.ServiceCall<PutDataModelResponse>	modelModifyDataModel(ModelModifyDataModelOptions modelModifyDataModelOptions) Overwrite the data model for record types and relationship types.
com.ibm.cloud.sdk.core.http.ServiceCall<InstanceMetadata>	modelModifyInstanceMetadata(ModelModifyInstanceMetadataOptions modelModifyInstanceMetadataOptions) Overwrite the configured metadata for a provisioned instance of system.
com.ibm.cloud.sdk.core.http.ServiceCall<PutDataModelResponse>	modelPatchDataModel(ModelPatchDataModelOptions modelPatchDataModelOptions) Partially modify the data model for record types and relationship types.
com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,Object>>	modelPatchFlow(ModelPatchFlowOptions modelPatchFlowOptions) Approve/Reject an active workflow specified by the supplied flow_id.
com.ibm.cloud.sdk.core.http.ServiceCall<PutAlgorithmResponse>	modelReplaceAlgorithm(ModelReplaceAlgorithmOptions modelReplaceAlgorithmOptions) Overwrite the matching algorithm for a given record type.
com.ibm.cloud.sdk.core.http.ServiceCall<PutMapResourcesResponse>	modelReplaceMapResource(ModelReplaceMapResourceOptions modelReplaceMapResourceOptions) Overwrite the configuration for the equivalent words, commonly used by matching algorithms.
com.ibm.cloud.sdk.core.http.ServiceCall<PutSetResourcesResponse>	modelReplaceSetResource(ModelReplaceSetResourceOptions modelReplaceSetResourceOptions) Overwrite the configuration for the anonymous set of words, commonly used by matching algorithms.
com.ibm.cloud.sdk.core.http.ServiceCall<PutCompareSpecResourcesResponse>	modelReplaceSpecResource(ModelReplaceSpecResourceOptions modelReplaceSpecResourceOptions) Overwrite the comparison parameters, commonly used by matching algorithms.
com.ibm.cloud.sdk.core.http.ServiceCall<PutAlgorithmResponse>	modelUpdateAlgorithm(ModelUpdateAlgorithmOptions modelUpdateAlgorithmOptions) Partially modify the matching algorithm for a given record type.
com.ibm.cloud.sdk.core.http.ServiceCall<PutCompositeRulesResponse>	modelUpdateCompositeRules(ModelUpdateCompositeRulesOptions modelUpdateCompositeRulesOptions) Overwrite the survivorship rules applicable to entity types, as defined by matching algorithm.
static Mdm	newInstance(String crn) Class method which constructs an instance of the `Mdm` client.
static Mdm	newInstance(String crn, String serviceName) Class method which constructs an instance of the `Mdm` client.
com.ibm.cloud.sdk.core.http.ServiceCall<ConfigurationMetadata>	patchConfigurationMetadata(PatchConfigurationMetadataOptions patchConfigurationMetadataOptions) Patch configuration metadata.
com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,Map<String,List<String>>>>	previewRules(PreviewRulesOptions previewRulesOptions) Preview the impacted entities by hypothesizing one or more manual linkage rules.
com.ibm.cloud.sdk.core.http.ServiceCall<PublishModelStatus>	publishModel(PublishModelOptions publishModelOptions) Publish Model.
com.ibm.cloud.sdk.core.http.ServiceCall<ConfigDataModel>	putConfigDataModel(PutConfigDataModelOptions putConfigDataModelOptions) Store Config Data Model.
com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,List<RulesResponseEntityRule>>>	removeRule(RemoveRuleOptions removeRuleOptions) Remove one or more manual linkage rules.
com.ibm.cloud.sdk.core.http.ServiceCall<AssetMetadataResponse>	replaceConfigurationAsset(ReplaceConfigurationAssetOptions replaceConfigurationAssetOptions) Update configuration metadata asset.
com.ibm.cloud.sdk.core.http.ServiceCall<ConfigurationMetadata>	replaceConfigurationMetadata(ReplaceConfigurationMetadataOptions replaceConfigurationMetadataOptions) Update configuration metadata.
com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,List<RulesResponseEntityRule>>>	retrieveRules(RetrieveRulesOptions retrieveRulesOptions) Retrieve all manual linkage rules of an entity.
com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,List<RulesResponseEntityRule>>>	retrieveRulesFromRecid(RetrieveRulesFromRecidOptions retrieveRulesFromRecidOptions) Retrieve all manual linkage rules of a record number for a given entity type.
com.ibm.cloud.sdk.core.http.ServiceCall<PostSearchResponse>	searchIndex(SearchIndexOptions searchIndexOptions) Search the potential matches of a given search criteria.
void	setCrn(String crn) Sets the crn.
com.ibm.cloud.sdk.core.http.ServiceCall<SuggestedDataMappingResponse>	suggestDataMappings(SuggestDataMappingsOptions suggestDataMappingsOptions) Suggest data mappings.
com.ibm.cloud.sdk.core.http.ServiceCall<SuggestedMatchAttributesResponse>	suggestMatchingAttributes(SuggestMatchingAttributesOptions suggestMatchingAttributesOptions) Suggests matching attributes.

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

configureClient, configureService, enableGzipCompression, 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

DEFAULT_SERVICE_URL

public static final String DEFAULT_SERVICE_URL

See Also:

Constant Field Values

Constructor Detail

Mdm

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

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

Parameters:

crn - The cloud resource name of the service.

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 Mdm newInstance(String crn)

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

Parameters:

crn - The cloud resource name of the service.

Returns:

an instance of the `Mdm` client using external configuration

newInstance

public static Mdm newInstance(String crn,
                              String serviceName)

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

Parameters:

crn - The cloud resource name of the service.

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

Returns:

an instance of the `Mdm` client using external configuration

getCrn

public String getCrn()

Gets the crn. The cloud resource name of the service.

Returns:

the crn

setCrn

public void setCrn(String crn)

Sets the crn.

Parameters:

crn - the new crn

publishModel

public com.ibm.cloud.sdk.core.http.ServiceCall<PublishModelStatus> publishModel(PublishModelOptions publishModelOptions)

Publish Model. Publishes the data model present in configuration space. Refer to following api to know the status of this process: API: GET /configuration_metadata/processes/publish_model.

Parameters:

publishModelOptions - the PublishModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type PublishModelStatus

getConfigDataModel

public com.ibm.cloud.sdk.core.http.ServiceCall<ConfigDataModel> getConfigDataModel(GetConfigDataModelOptions getConfigDataModelOptions)

Get config data model. Gets the data model present in configuration space.

Parameters:

getConfigDataModelOptions - the GetConfigDataModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type ConfigDataModel

putConfigDataModel

public com.ibm.cloud.sdk.core.http.ServiceCall<ConfigDataModel> putConfigDataModel(PutConfigDataModelOptions putConfigDataModelOptions)

Store Config Data Model. Updates the data model present in configuration space.

Parameters:

putConfigDataModelOptions - the PutConfigDataModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type ConfigDataModel

getConfigDataModelAttributes

public com.ibm.cloud.sdk.core.http.ServiceCall<ConfigDataModelAttributes> getConfigDataModelAttributes(GetConfigDataModelAttributesOptions getConfigDataModelAttributesOptions)

Get Config Data Model Record Type Attributes. Gets all the attributes of a specific record type for the data model present in configuration space.

Parameters:

getConfigDataModelAttributesOptions - the GetConfigDataModelAttributesOptions containing the options for the call

Returns:

a ServiceCall with a result of type ConfigDataModelAttributes

getMatchingStatistics

public com.ibm.cloud.sdk.core.http.ServiceCall<MatchStatistics> getMatchingStatistics(GetMatchingStatisticsOptions getMatchingStatisticsOptions)

Get matching statistics. Gets the matching statistics(for example number of entities, entity size distributions etc) for the specified record type.

Parameters:

getMatchingStatisticsOptions - the GetMatchingStatisticsOptions containing the options for the call

Returns:

a ServiceCall with a result of type MatchStatistics

initiateMatching

public com.ibm.cloud.sdk.core.http.ServiceCall<MatchingStatus> initiateMatching(InitiateMatchingOptions initiateMatchingOptions)

Initiates matching for configuration. Initiates matching process for the data loaded into MDM for the provided entity type. Refer to the following api to know the status of this process: API: GET /configuration_metadata/processes/match Query Paramter: record_type, value: person/organization.

Parameters:

initiateMatchingOptions - the InitiateMatchingOptions containing the options for the call

Returns:

a ServiceCall with a result of type MatchingStatus

getProcessStatus

public com.ibm.cloud.sdk.core.http.ServiceCall<ProcessStatus> getProcessStatus(GetProcessStatusOptions getProcessStatusOptions)

Get process status. Gets status for the specified record type and status type.

Parameters:

getProcessStatusOptions - the GetProcessStatusOptions containing the options for the call

Returns:

a ServiceCall with a result of type ProcessStatus

getProcessByProcessName

public com.ibm.cloud.sdk.core.http.ServiceCall<ProcessResponse> getProcessByProcessName(GetProcessByProcessNameOptions getProcessByProcessNameOptions)

Get process by process name. Gets the process details for the specified process name.

Parameters:

getProcessByProcessNameOptions - the GetProcessByProcessNameOptions containing the options for the call

Returns:

a ServiceCall with a result of type ProcessResponse

getConfigurationMetadata

public com.ibm.cloud.sdk.core.http.ServiceCall<ConfigurationMetadata> getConfigurationMetadata(GetConfigurationMetadataOptions getConfigurationMetadataOptions)

Get configuration metadata. Gets the configuration metadata with all assets , their mappings, loading status, matching status etc.

Parameters:

getConfigurationMetadataOptions - the GetConfigurationMetadataOptions containing the options for the call

Returns:

a ServiceCall with a result of type ConfigurationMetadata

replaceConfigurationMetadata

public com.ibm.cloud.sdk.core.http.ServiceCall<ConfigurationMetadata> replaceConfigurationMetadata(ReplaceConfigurationMetadataOptions replaceConfigurationMetadataOptions)

Update configuration metadata. Updates the configuration metadata. It could be updating asset information or updating matching attributes etc.

Parameters:

replaceConfigurationMetadataOptions - the ReplaceConfigurationMetadataOptions containing the options for the call

Returns:

a ServiceCall with a result of type ConfigurationMetadata

patchConfigurationMetadata

public com.ibm.cloud.sdk.core.http.ServiceCall<ConfigurationMetadata> patchConfigurationMetadata(PatchConfigurationMetadataOptions patchConfigurationMetadataOptions)

Patch configuration metadata. Patches the configuration metadata only with the information provided in the request.

Parameters:

patchConfigurationMetadataOptions - the PatchConfigurationMetadataOptions containing the options for the call

Returns:

a ServiceCall with a result of type ConfigurationMetadata

replaceConfigurationAsset

public com.ibm.cloud.sdk.core.http.ServiceCall<AssetMetadataResponse> replaceConfigurationAsset(ReplaceConfigurationAssetOptions replaceConfigurationAssetOptions)

Update configuration metadata asset. Updates one asset information in the configuration. It could be changing mappings or changing asset status etc.

Parameters:

replaceConfigurationAssetOptions - the ReplaceConfigurationAssetOptions containing the options for the call

Returns:

a ServiceCall with a result of type AssetMetadataResponse

createConfigurationAsset

public com.ibm.cloud.sdk.core.http.ServiceCall<AssetMetadataResponse> createConfigurationAsset(CreateConfigurationAssetOptions createConfigurationAssetOptions)

Create configuration metadata asset. Creates a new asset in configuration metadata. This can be called when new asset is getting added into configuration space.

Parameters:

createConfigurationAssetOptions - the CreateConfigurationAssetOptions containing the options for the call

Returns:

a ServiceCall with a result of type AssetMetadataResponse

bulkLoad

public com.ibm.cloud.sdk.core.http.ServiceCall<ProcessStatus> bulkLoad(BulkLoadOptions bulkLoadOptions)

Bulk load project metadata assets. Starts process to Publish Data of Assets present in configuration and mapped to MDM model. Refer to the following api to know the status of this process: API: GET /configuration_metadata/processes/publish_data.

Parameters:

bulkLoadOptions - the BulkLoadOptions containing the options for the call

Returns:

a ServiceCall with a result of type ProcessStatus

getAllProcesses

public com.ibm.cloud.sdk.core.http.ServiceCall<ProcessListResponse> getAllProcesses(GetAllProcessesOptions getAllProcessesOptions)

Gets the process details. Gets the process details for all processes, optionally filtered by process status.

Parameters:

getAllProcessesOptions - the GetAllProcessesOptions containing the options for the call

Returns:

a ServiceCall with a result of type ProcessListResponse

suggestDataMappings

public com.ibm.cloud.sdk.core.http.ServiceCall<SuggestedDataMappingResponse> suggestDataMappings(SuggestDataMappingsOptions suggestDataMappingsOptions)

Suggest data mappings. Suggest data mappings from MDM data model based on the generic classes Knowledge catalog profiled with.

Parameters:

suggestDataMappingsOptions - the SuggestDataMappingsOptions containing the options for the call

Returns:

a ServiceCall with a result of type SuggestedDataMappingResponse

suggestMatchingAttributes

public com.ibm.cloud.sdk.core.http.ServiceCall<SuggestedMatchAttributesResponse> suggestMatchingAttributes(SuggestMatchingAttributesOptions suggestMatchingAttributesOptions)

Suggests matching attributes. Suggest matching attributes for a record type based on mappings of assets in that type and template algorithm.

Parameters:

suggestMatchingAttributesOptions - the SuggestMatchingAttributesOptions containing the options for the call

Returns:

a ServiceCall with a result of type SuggestedMatchAttributesResponse

dataRevokeBucketCredentials

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> dataRevokeBucketCredentials(DataRevokeBucketCredentialsOptions dataRevokeBucketCredentialsOptions)

Revoke a bucket API key. Requires the application role of 'Manager'.

Parameters:

dataRevokeBucketCredentialsOptions - the DataRevokeBucketCredentialsOptions containing the options for the call

Returns:

a ServiceCall with a void result

dataRevokeBucketCredentials

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> dataRevokeBucketCredentials()

Revoke a bucket API key. Requires the application role of 'Manager'.

Returns:

a ServiceCall with a void result

dataGenerateBucketCredentials

public com.ibm.cloud.sdk.core.http.ServiceCall<BucketCredentialsResponse> dataGenerateBucketCredentials(DataGenerateBucketCredentialsOptions dataGenerateBucketCredentialsOptions)

Generate bucket credentials. Requires the application role of 'Manager'.

Parameters:

dataGenerateBucketCredentialsOptions - the DataGenerateBucketCredentialsOptions containing the options for the call

Returns:

a ServiceCall with a result of type BucketCredentialsResponse

dataGenerateBucketCredentials

public com.ibm.cloud.sdk.core.http.ServiceCall<BucketCredentialsResponse> dataGenerateBucketCredentials()

Generate bucket credentials. Requires the application role of 'Manager'.

Returns:

a ServiceCall with a result of type BucketCredentialsResponse

dataRunBulkLoad

public com.ibm.cloud.sdk.core.http.ServiceCall<BulkLoadResponse> dataRunBulkLoad(DataRunBulkLoadOptions dataRunBulkLoadOptions)

Start an operation to bulk load data into the graph. Requires the application role of 'Writer'. * To run a sample bulk load, provide the type as 'sample' and the directory_ref identifying which sample data set to load. directory_path is not required when type is set to 'sample', if provided it will be ignored. * The available sample data sets are sample_contract_small, sample_consent_small, sample_contract, and sample_consent, these are the only acceptable values for 'directory_ref' * To run a dfs bulk load, provide the type as 'dfs' and the directory_path pointing to the location of the load data. 'directory_ref' is not required when type is set to 'dfs', if provided it will be ignored. Load data directories are expected to adhere to the following format: ``` record.properties relationship.properties record --[record data files] relationship --[relationship data files] ``` The job id will be a random universally unique identifier, which is also appended to each job driver pod.

Parameters:

dataRunBulkLoadOptions - the DataRunBulkLoadOptions containing the options for the call

Returns:

a ServiceCall with a result of type BulkLoadResponse

dataRunBulkLoad

public com.ibm.cloud.sdk.core.http.ServiceCall<BulkLoadResponse> dataRunBulkLoad()

Start an operation to bulk load data into the graph. Requires the application role of 'Writer'. * To run a sample bulk load, provide the type as 'sample' and the directory_ref identifying which sample data set to load. directory_path is not required when type is set to 'sample', if provided it will be ignored. * The available sample data sets are sample_contract_small, sample_consent_small, sample_contract, and sample_consent, these are the only acceptable values for 'directory_ref' * To run a dfs bulk load, provide the type as 'dfs' and the directory_path pointing to the location of the load data. 'directory_ref' is not required when type is set to 'dfs', if provided it will be ignored. Load data directories are expected to adhere to the following format: ``` record.properties relationship.properties record --[record data files] relationship --[relationship data files] ``` The job id will be a random universally unique identifier, which is also appended to each job driver pod.

Returns:

a ServiceCall with a result of type BulkLoadResponse

dataGetRecordsForEntity

public com.ibm.cloud.sdk.core.http.ServiceCall<RecordsResponse> dataGetRecordsForEntity(DataGetRecordsForEntityOptions dataGetRecordsForEntityOptions)

Get all records associated with an entity. Requires the application role of 'Reader'.

Parameters:

dataGetRecordsForEntityOptions - the DataGetRecordsForEntityOptions containing the options for the call

Returns:

a ServiceCall with a result of type RecordsResponse

dataGetRelatedRecordsForEntity

public com.ibm.cloud.sdk.core.http.ServiceCall<RelatedRecordsResponse> dataGetRelatedRecordsForEntity(DataGetRelatedRecordsForEntityOptions dataGetRelatedRecordsForEntityOptions)

Get all related records associated with an entity. Requires the application role of 'Reader'.

Parameters:

dataGetRelatedRecordsForEntityOptions - the DataGetRelatedRecordsForEntityOptions containing the options for the call

Returns:

a ServiceCall with a result of type RelatedRecordsResponse

dataGetEntity

public com.ibm.cloud.sdk.core.http.ServiceCall<EntityResponse> dataGetEntity(DataGetEntityOptions dataGetEntityOptions)

Get the composite view for an entity. Requires the application role of 'Reader'.

Parameters:

dataGetEntityOptions - the DataGetEntityOptions containing the options for the call

Returns:

a ServiceCall with a result of type EntityResponse

dataGetExport

public com.ibm.cloud.sdk.core.http.ServiceCall<ExportResponse> dataGetExport(DataGetExportOptions dataGetExportOptions)

Get information for a given export. Requires the application role of 'Reader'.

Parameters:

dataGetExportOptions - the DataGetExportOptions containing the options for the call

Returns:

a ServiceCall with a result of type ExportResponse

dataGetExportDownload

public com.ibm.cloud.sdk.core.http.ServiceCall<InputStream> dataGetExportDownload(DataGetExportDownloadOptions dataGetExportDownloadOptions)

Get the export download. Requires the application role of 'Reader'.

Parameters:

dataGetExportDownloadOptions - the DataGetExportDownloadOptions containing the options for the call

Returns:

a ServiceCall with a result of type InputStream

dataGetExports

public com.ibm.cloud.sdk.core.http.ServiceCall<ExportsResponse> dataGetExports(DataGetExportsOptions dataGetExportsOptions)

Get a list of exports. Requires the application role of 'Reader'.

Parameters:

dataGetExportsOptions - the DataGetExportsOptions containing the options for the call

Returns:

a ServiceCall with a result of type ExportsResponse

dataGetExports

public com.ibm.cloud.sdk.core.http.ServiceCall<ExportsResponse> dataGetExports()

Get a list of exports. Requires the application role of 'Reader'.

Returns:

a ServiceCall with a result of type ExportsResponse

dataRunExport

public com.ibm.cloud.sdk.core.http.ServiceCall<ExportResponse> dataRunExport(DataRunExportOptions dataRunExportOptions)

Run a full text or property query search and export the results to a csv, tsv, or psv file. Requires the application role of 'Reader'. Export format, search criteria, and file name are configurable in the message body. The file name must only contain alphanumeric characters and be 64 characters or less.

Parameters:

dataRunExportOptions - the DataRunExportOptions containing the options for the call

Returns:

a ServiceCall with a result of type ExportResponse

dataRunExport

public com.ibm.cloud.sdk.core.http.ServiceCall<ExportResponse> dataRunExport()

Run a full text or property query search and export the results to a csv, tsv, or psv file. Requires the application role of 'Reader'. Export format, search criteria, and file name are configurable in the message body. The file name must only contain alphanumeric characters and be 64 characters or less.

Returns:

a ServiceCall with a result of type ExportResponse

dataGetJob

public com.ibm.cloud.sdk.core.http.ServiceCall<JobResponse> dataGetJob(DataGetJobOptions dataGetJobOptions)

Get information for a given job. Requires the application role of 'Reader'.

Parameters:

dataGetJobOptions - the DataGetJobOptions containing the options for the call

Returns:

a ServiceCall with a result of type JobResponse

dataGetJobs

public com.ibm.cloud.sdk.core.http.ServiceCall<JobsResponse> dataGetJobs(DataGetJobsOptions dataGetJobsOptions)

List all jobs. Requires the application role of 'Reader'. Includes optional filters on job type and status.

Parameters:

dataGetJobsOptions - the DataGetJobsOptions containing the options for the call

Returns:

a ServiceCall with a result of type JobsResponse

dataGetJobs

public com.ibm.cloud.sdk.core.http.ServiceCall<JobsResponse> dataGetJobs()

List all jobs. Requires the application role of 'Reader'. Includes optional filters on job type and status.

Returns:

a ServiceCall with a result of type JobsResponse

dataStopJob

public com.ibm.cloud.sdk.core.http.ServiceCall<JobResponse> dataStopJob(DataStopJobOptions dataStopJobOptions)

Stop a given job. Requires the application role of 'Writer'. Stops a job if it is currently running. This does not rollback changes made by the job process prior to stopping the job. Full deletion of job resources may take up to a few minutes.

Parameters:

dataStopJobOptions - the DataStopJobOptions containing the options for the call

Returns:

a ServiceCall with a result of type JobResponse

dataCleanUpJob

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> dataCleanUpJob(DataCleanUpJobOptions dataCleanUpJobOptions)

Clean up job data. Requires the application role of 'Writer'.

Parameters:

dataCleanUpJobOptions - the DataCleanUpJobOptions containing the options for the call

Returns:

a ServiceCall with a void result

dataGetRecord

public com.ibm.cloud.sdk.core.http.ServiceCall<RecordResponse> dataGetRecord(DataGetRecordOptions dataGetRecordOptions)

Get a single record. Requires the application role of 'Reader'.

Parameters:

dataGetRecordOptions - the DataGetRecordOptions containing the options for the call

Returns:

a ServiceCall with a result of type RecordResponse

dataUpdateRecord

public com.ibm.cloud.sdk.core.http.ServiceCall<RecordResponse> dataUpdateRecord(DataUpdateRecordOptions dataUpdateRecordOptions)

Update record information for an existing record. Requires the application role of 'Writer'. Any editable record attributes not specified in the request will be removed from the record.

Parameters:

dataUpdateRecordOptions - the DataUpdateRecordOptions containing the options for the call

Returns:

a ServiceCall with a result of type RecordResponse

dataDeleteRecord

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> dataDeleteRecord(DataDeleteRecordOptions dataDeleteRecordOptions)

Delete a record from the graph. Requires the application role of 'Writer'.

Parameters:

dataDeleteRecordOptions - the DataDeleteRecordOptions containing the options for the call

Returns:

a ServiceCall with a void result

dataGetEntitiesForRecord

public com.ibm.cloud.sdk.core.http.ServiceCall<EntitiesResponse> dataGetEntitiesForRecord(DataGetEntitiesForRecordOptions dataGetEntitiesForRecordOptions)

Get a list of entities for a given record. Requires the application role of 'Reader'.

Parameters:

dataGetEntitiesForRecordOptions - the DataGetEntitiesForRecordOptions containing the options for the call

Returns:

a ServiceCall with a result of type EntitiesResponse

dataGetRecords

public com.ibm.cloud.sdk.core.http.ServiceCall<RecordsResponse> dataGetRecords(DataGetRecordsOptions dataGetRecordsOptions)

List all records. Requires the application role of 'Reader'.

Parameters:

dataGetRecordsOptions - the DataGetRecordsOptions containing the options for the call

Returns:

a ServiceCall with a result of type RecordsResponse

dataGetRecords

public com.ibm.cloud.sdk.core.http.ServiceCall<RecordsResponse> dataGetRecords()

List all records. Requires the application role of 'Reader'.

Returns:

a ServiceCall with a result of type RecordsResponse

dataCreateRecord

public com.ibm.cloud.sdk.core.http.ServiceCall<RecordResponse> dataCreateRecord(DataCreateRecordOptions dataCreateRecordOptions)

Create a new record. Requires the application role of 'Writer'.

Parameters:

dataCreateRecordOptions - the DataCreateRecordOptions containing the options for the call

Returns:

a ServiceCall with a result of type RecordResponse

dataGetRelationshipsForRecord

public com.ibm.cloud.sdk.core.http.ServiceCall<RelationshipsResponse> dataGetRelationshipsForRecord(DataGetRelationshipsForRecordOptions dataGetRelationshipsForRecordOptions)

List the relationships for a single given record. Requires the application role of 'Reader'. * Returns all relationships that exist between the given record and other records in the graph.

Parameters:

dataGetRelationshipsForRecordOptions - the DataGetRelationshipsForRecordOptions containing the options for the call

Returns:

a ServiceCall with a result of type RelationshipsResponse

dataGetRelationshipForRecord

public com.ibm.cloud.sdk.core.http.ServiceCall<RelationshipResponse> dataGetRelationshipForRecord(DataGetRelationshipForRecordOptions dataGetRelationshipForRecordOptions)

Get a single given relationship for a given record. Requires the application role of 'Reader'.

Parameters:

dataGetRelationshipForRecordOptions - the DataGetRelationshipForRecordOptions containing the options for the call

Returns:

a ServiceCall with a result of type RelationshipResponse

dataGetRelatedRecordsForRecord

public com.ibm.cloud.sdk.core.http.ServiceCall<RelatedRecordsResponse> dataGetRelatedRecordsForRecord(DataGetRelatedRecordsForRecordOptions dataGetRelatedRecordsForRecordOptions)

Retrieves related records for a given record. Requires the application role of 'Reader'.

Parameters:

dataGetRelatedRecordsForRecordOptions - the DataGetRelatedRecordsForRecordOptions containing the options for the call

Returns:

a ServiceCall with a result of type RelatedRecordsResponse

dataUpdateSchema

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> dataUpdateSchema(DataUpdateSchemaOptions dataUpdateSchemaOptions)

Start an operation to update schema when model changes. Requires the application role of 'Manager.

Parameters:

dataUpdateSchemaOptions - the DataUpdateSchemaOptions containing the options for the call

Returns:

a ServiceCall with a void result

dataUpdateSchema

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> dataUpdateSchema()

Start an operation to update schema when model changes. Requires the application role of 'Manager.

Returns:

a ServiceCall with a void result

dataSearch

public com.ibm.cloud.sdk.core.http.ServiceCall<SearchResultResponse> dataSearch(DataSearchOptions dataSearchOptions)

Run a full text or property query search. Requires the application role of 'Reader'. Search type is configurable in the message body, as well as the search terms and filters. Pagination is supported.

Parameters:

dataSearchOptions - the DataSearchOptions containing the options for the call

Returns:

a ServiceCall with a result of type SearchResultResponse

dataGetGraphStatistics

public com.ibm.cloud.sdk.core.http.ServiceCall<StatisticsResultResponse> dataGetGraphStatistics(DataGetGraphStatisticsOptions dataGetGraphStatisticsOptions)

Fetch graph statistics. Requires the application role of 'Reader'.

Parameters:

dataGetGraphStatisticsOptions - the DataGetGraphStatisticsOptions containing the options for the call

Returns:

a ServiceCall with a result of type StatisticsResultResponse

dataGetGraphStatistics

public com.ibm.cloud.sdk.core.http.ServiceCall<StatisticsResultResponse> dataGetGraphStatistics()

Fetch graph statistics. Requires the application role of 'Reader'.

Returns:

a ServiceCall with a result of type StatisticsResultResponse

dataGetSubgraph

public com.ibm.cloud.sdk.core.http.ServiceCall<SubgraphResponse> dataGetSubgraph(DataGetSubgraphOptions dataGetSubgraphOptions)

Get surrounding vertices and edges for a set of vertices. Requires the application role of 'Reader'. * Includes initial vertices in the result. * Returns a summary of graph elements. Does not include detailed information such as model attribute keys and values. * Ignores a vertex identifier if the vertex cannot be found. Returns an empty subgraph if no vertices are found. * Returns an edge in the resulting subgraph if its source vertex, target vertex and the edge itself can be reached within the specified number of hops from at least one initial vertex. * Includes edges between record and entity vertices.* No more than 3 hops and 50 input vertices are permitted. The number of edges per vertex is capped at 50. Note that the number of edges per vertex may be less than this limit due to shared edges.

Parameters:

dataGetSubgraphOptions - the DataGetSubgraphOptions containing the options for the call

Returns:

a ServiceCall with a result of type SubgraphResponse

dataGetSubgraph

public com.ibm.cloud.sdk.core.http.ServiceCall<SubgraphResponse> dataGetSubgraph()

Get surrounding vertices and edges for a set of vertices. Requires the application role of 'Reader'. * Includes initial vertices in the result. * Returns a summary of graph elements. Does not include detailed information such as model attribute keys and values. * Ignores a vertex identifier if the vertex cannot be found. Returns an empty subgraph if no vertices are found. * Returns an edge in the resulting subgraph if its source vertex, target vertex and the edge itself can be reached within the specified number of hops from at least one initial vertex. * Includes edges between record and entity vertices.* No more than 3 hops and 50 input vertices are permitted. The number of edges per vertex is capped at 50. Note that the number of edges per vertex may be less than this limit due to shared edges.

Returns:

a ServiceCall with a result of type SubgraphResponse

dataRunBulkUpdate

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> dataRunBulkUpdate(DataRunBulkUpdateOptions dataRunBulkUpdateOptions)

Start an operation to perform a bulk update to the graph. Requires the application role of 'Manager'. * Performs all relationship deletions first, then record deletions. * After the deletions are completed, all record insertions/updates are performed next, followed by relationship insertions/updates. * Any element found in both deletions and insertions/updates is treated as a deletion, and is removed from the insertions/updates list before processing. * Any other case of a duplicated element will cause the update to fail. * If the ignore_redundant_updates flag is set to 'true', any update with a timestamp that is not newer than the existing timestamp for that element will not be applied, but it will not cause the bulk update transaction to fail. If the flag is set to 'false', invalid timestamps will cause failure. * A failed update will cause all changes performed by the bulk update transaction to be reverted back to the original graph state.

Parameters:

dataRunBulkUpdateOptions - the DataRunBulkUpdateOptions containing the options for the call

Returns:

a ServiceCall with a void result

dataRunBulkUpdate

public com.ibm.cloud.sdk.core.http.ServiceCall<Void> dataRunBulkUpdate()

Start an operation to perform a bulk update to the graph. Requires the application role of 'Manager'. * Performs all relationship deletions first, then record deletions. * After the deletions are completed, all record insertions/updates are performed next, followed by relationship insertions/updates. * Any element found in both deletions and insertions/updates is treated as a deletion, and is removed from the insertions/updates list before processing. * Any other case of a duplicated element will cause the update to fail. * If the ignore_redundant_updates flag is set to 'true', any update with a timestamp that is not newer than the existing timestamp for that element will not be applied, but it will not cause the bulk update transaction to fail. If the flag is set to 'false', invalid timestamps will cause failure. * A failed update will cause all changes performed by the bulk update transaction to be reverted back to the original graph state.

Returns:

a ServiceCall with a void result

getCloudJobSummary

public com.ibm.cloud.sdk.core.http.ServiceCall<GetCloudJobSummaryResponse> getCloudJobSummary(GetCloudJobSummaryOptions getCloudJobSummaryOptions)

Retrieve the summary of a processed job. Requires the application role of 'MatchingReader'.

Parameters:

getCloudJobSummaryOptions - the GetCloudJobSummaryOptions containing the options for the call

Returns:

a ServiceCall with a result of type GetCloudJobSummaryResponse

cloudDeriveJob

public com.ibm.cloud.sdk.core.http.ServiceCall<PostCloudJobResponse> cloudDeriveJob(CloudDeriveJobOptions cloudDeriveJobOptions)

Perform asynchronous processing of the derive job of a data file in IBM Cloud Storage. Requires the application role of 'MatchingManager'.

Parameters:

cloudDeriveJobOptions - the CloudDeriveJobOptions containing the options for the call

Returns:

a ServiceCall with a result of type PostCloudJobResponse

cloudReportIndex

public com.ibm.cloud.sdk.core.http.ServiceCall<PostCloudJobResponse> cloudReportIndex(CloudReportIndexOptions cloudReportIndexOptions)

Perform asynchronous reporting of index metrics. Requires the application role of 'MatchingManager'.

Parameters:

cloudReportIndexOptions - the CloudReportIndexOptions containing the options for the call

Returns:

a ServiceCall with a result of type PostCloudJobResponse

cloudMatchJob

public com.ibm.cloud.sdk.core.http.ServiceCall<PostCloudJobResponse> cloudMatchJob(CloudMatchJobOptions cloudMatchJobOptions)

Perform asynchronous processing of the match job. Requires the application role of 'MatchingManager'.

Parameters:

cloudMatchJobOptions - the CloudMatchJobOptions containing the options for the call

Returns:

a ServiceCall with a result of type PostCloudJobResponse

listEntity

public com.ibm.cloud.sdk.core.http.ServiceCall<GetEntityIds> listEntity(ListEntityOptions listEntityOptions)

Get entity ids. Requires the application role of 'MatchingReader'.

Parameters:

listEntityOptions - the ListEntityOptions containing the options for the call

Returns:

a ServiceCall with a result of type GetEntityIds

getRecords

public com.ibm.cloud.sdk.core.http.ServiceCall<GetRecordKeys> getRecords(GetRecordsOptions getRecordsOptions)

Get record keys of a given entity_id. Requires the application role of 'MatchingReader'.

Parameters:

getRecordsOptions - the GetRecordsOptions containing the options for the call

Returns:

a ServiceCall with a result of type GetRecordKeys

previewRules

public com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,Map<String,List<String>>>> previewRules(PreviewRulesOptions previewRulesOptions)

Preview the impacted entities by hypothesizing one or more manual linkage rules. Requires the application role of 'MatchingReader'.

Parameters:

previewRulesOptions - the PreviewRulesOptions containing the options for the call

Returns:

a ServiceCall with a result of type Map

addRule

public com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,List<RulesResponseEntityRule>>> addRule(AddRuleOptions addRuleOptions)

Create or overwrite one or more manual linkage rules. Requires the application role of 'MatchingWriter'.

Parameters:

addRuleOptions - the AddRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type Map

removeRule

public com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,List<RulesResponseEntityRule>>> removeRule(RemoveRuleOptions removeRuleOptions)

Remove one or more manual linkage rules. Requires the application role of 'MatchingWriter'.

Parameters:

removeRuleOptions - the RemoveRuleOptions containing the options for the call

Returns:

a ServiceCall with a result of type Map

retrieveRules

public com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,List<RulesResponseEntityRule>>> retrieveRules(RetrieveRulesOptions retrieveRulesOptions)

Retrieve all manual linkage rules of an entity. Requires the application role of 'MatchingReader'.

Parameters:

retrieveRulesOptions - the RetrieveRulesOptions containing the options for the call

Returns:

a ServiceCall with a result of type Map

retrieveRulesFromRecid

public com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,List<RulesResponseEntityRule>>> retrieveRulesFromRecid(RetrieveRulesFromRecidOptions retrieveRulesFromRecidOptions)

Retrieve all manual linkage rules of a record number for a given entity type. Requires the application role of 'MatchingReader'.

Parameters:

retrieveRulesFromRecidOptions - the RetrieveRulesFromRecidOptions containing the options for the call

Returns:

a ServiceCall with a result of type Map

deriveIndex

public com.ibm.cloud.sdk.core.http.ServiceCall<PostDeriveResponse> deriveIndex(DeriveIndexOptions deriveIndexOptions)

Preview the derived matching data for given source records. Requires the application role of 'MatchingReader'.

Parameters:

deriveIndexOptions - the DeriveIndexOptions containing the options for the call

Returns:

a ServiceCall with a result of type PostDeriveResponse

indexSummary

public com.ibm.cloud.sdk.core.http.ServiceCall<GetSummaryResponse> indexSummary(IndexSummaryOptions indexSummaryOptions)

Retrieve a summary of derived matching data. Requires the application role of 'MatchingReader'.

Parameters:

indexSummaryOptions - the IndexSummaryOptions containing the options for the call

Returns:

a ServiceCall with a result of type GetSummaryResponse

getIndex

public com.ibm.cloud.sdk.core.http.ServiceCall<GetIndexResponse> getIndex(GetIndexOptions getIndexOptions)

Retrieve the derived matching data for given source record keys. Requires the application role of 'MatchingReader'.

Parameters:

getIndexOptions - the GetIndexOptions containing the options for the call

Returns:

a ServiceCall with a result of type GetIndexResponse

matchIndex

public com.ibm.cloud.sdk.core.http.ServiceCall<PutIndexResponse> matchIndex(MatchIndexOptions matchIndexOptions)

Create or overwrite the derived matching data for a given source record. Requires the application role of 'MatchingWriter'.

Parameters:

matchIndexOptions - the MatchIndexOptions containing the options for the call

Returns:

a ServiceCall with a result of type PutIndexResponse

deleteIndex

public com.ibm.cloud.sdk.core.http.ServiceCall<PutIndexResponse> deleteIndex(DeleteIndexOptions deleteIndexOptions)

Remove the derived matching data for given source record keys. Requires the application role of 'MatchingWriter'.

Parameters:

deleteIndexOptions - the DeleteIndexOptions containing the options for the call

Returns:

a ServiceCall with a result of type PutIndexResponse

compareIndex

public com.ibm.cloud.sdk.core.http.ServiceCall<CompareResponse> compareIndex(CompareIndexOptions compareIndexOptions)

Compare source records. Requires the application role of 'MatchingReader'.

Parameters:

compareIndexOptions - the CompareIndexOptions containing the options for the call

Returns:

a ServiceCall with a result of type CompareResponse

indexServiceReset

public com.ibm.cloud.sdk.core.http.ServiceCall<PostResetResponse> indexServiceReset(IndexServiceResetOptions indexServiceResetOptions)

Remove all the derived matching data for the supplied record type. Requires the application role of 'MatchingManager'.

Parameters:

indexServiceResetOptions - the IndexServiceResetOptions containing the options for the call

Returns:

a ServiceCall with a result of type PostResetResponse

searchIndex

public com.ibm.cloud.sdk.core.http.ServiceCall<PostSearchResponse> searchIndex(SearchIndexOptions searchIndexOptions)

Search the potential matches of a given search criteria. Requires the application role of 'MatchingReader'.

Parameters:

searchIndexOptions - the SearchIndexOptions containing the options for the call

Returns:

a ServiceCall with a result of type PostSearchResponse

modelGetAlgorithm

public com.ibm.cloud.sdk.core.http.ServiceCall<Algorithm> modelGetAlgorithm(ModelGetAlgorithmOptions modelGetAlgorithmOptions)

Retrieve the matching algorithm for a given record type. Requires the application role of 'ModelReader'.

Parameters:

modelGetAlgorithmOptions - the ModelGetAlgorithmOptions containing the options for the call

Returns:

a ServiceCall with a result of type Algorithm

modelReplaceAlgorithm

public com.ibm.cloud.sdk.core.http.ServiceCall<PutAlgorithmResponse> modelReplaceAlgorithm(ModelReplaceAlgorithmOptions modelReplaceAlgorithmOptions)

Overwrite the matching algorithm for a given record type. Requires the application role of 'ModelWriter'.

Parameters:

modelReplaceAlgorithmOptions - the ModelReplaceAlgorithmOptions containing the options for the call

Returns:

a ServiceCall with a result of type PutAlgorithmResponse

modelUpdateAlgorithm

public com.ibm.cloud.sdk.core.http.ServiceCall<PutAlgorithmResponse> modelUpdateAlgorithm(ModelUpdateAlgorithmOptions modelUpdateAlgorithmOptions)

Partially modify the matching algorithm for a given record type. Requires the application role of 'ModelWriter'.

Parameters:

modelUpdateAlgorithmOptions - the ModelUpdateAlgorithmOptions containing the options for the call

Returns:

a ServiceCall with a result of type PutAlgorithmResponse

modelListComparespecResoures

public com.ibm.cloud.sdk.core.http.ServiceCall<CompareSpecResourceNames> modelListComparespecResoures(ModelListComparespecResouresOptions modelListComparespecResouresOptions)

Retrieve the list of existing comparison parameters. Requires the application role of 'ModelReader'.

Parameters:

modelListComparespecResouresOptions - the ModelListComparespecResouresOptions containing the options for the call

Returns:

a ServiceCall with a result of type CompareSpecResourceNames

modelGetComparespecResource

public com.ibm.cloud.sdk.core.http.ServiceCall<CompareSpecResource> modelGetComparespecResource(ModelGetComparespecResourceOptions modelGetComparespecResourceOptions)

Retrieve the comparison parameters, commonly used by matching algorithms. Requires the application role of 'ModelReader'.

Parameters:

modelGetComparespecResourceOptions - the ModelGetComparespecResourceOptions containing the options for the call

Returns:

a ServiceCall with a result of type CompareSpecResource

modelReplaceSpecResource

public com.ibm.cloud.sdk.core.http.ServiceCall<PutCompareSpecResourcesResponse> modelReplaceSpecResource(ModelReplaceSpecResourceOptions modelReplaceSpecResourceOptions)

Overwrite the comparison parameters, commonly used by matching algorithms. Requires the application role of 'ModelWriter'.

Parameters:

modelReplaceSpecResourceOptions - the ModelReplaceSpecResourceOptions containing the options for the call

Returns:

a ServiceCall with a result of type PutCompareSpecResourcesResponse

modelGetCompositeRules

public com.ibm.cloud.sdk.core.http.ServiceCall<CompositeRules> modelGetCompositeRules(ModelGetCompositeRulesOptions modelGetCompositeRulesOptions)

Retrieve the survivorship rules applicable to entity types, as defined by matching algorithms. Requires the application role of 'ModelReader'.

Parameters:

modelGetCompositeRulesOptions - the ModelGetCompositeRulesOptions containing the options for the call

Returns:

a ServiceCall with a result of type CompositeRules

modelUpdateCompositeRules

public com.ibm.cloud.sdk.core.http.ServiceCall<PutCompositeRulesResponse> modelUpdateCompositeRules(ModelUpdateCompositeRulesOptions modelUpdateCompositeRulesOptions)

Overwrite the survivorship rules applicable to entity types, as defined by matching algorithm. Requires the application role of 'ModelWriter'.

Parameters:

modelUpdateCompositeRulesOptions - the ModelUpdateCompositeRulesOptions containing the options for the call

Returns:

a ServiceCall with a result of type PutCompositeRulesResponse

modelGetDataModel

public com.ibm.cloud.sdk.core.http.ServiceCall<DataModel> modelGetDataModel(ModelGetDataModelOptions modelGetDataModelOptions)

Retrieve the data model for record types and relationship types. Requires the application role of 'ModelReader'.

Parameters:

modelGetDataModelOptions - the ModelGetDataModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type DataModel

modelModifyDataModel

public com.ibm.cloud.sdk.core.http.ServiceCall<PutDataModelResponse> modelModifyDataModel(ModelModifyDataModelOptions modelModifyDataModelOptions)

Overwrite the data model for record types and relationship types. Requires the application role of 'ModelWriter'.

Parameters:

modelModifyDataModelOptions - the ModelModifyDataModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type PutDataModelResponse

modelPatchDataModel

public com.ibm.cloud.sdk.core.http.ServiceCall<PutDataModelResponse> modelPatchDataModel(ModelPatchDataModelOptions modelPatchDataModelOptions)

Partially modify the data model for record types and relationship types. Requires the application role of 'ModelWriter'.

Parameters:

modelPatchDataModelOptions - the ModelPatchDataModelOptions containing the options for the call

Returns:

a ServiceCall with a result of type PutDataModelResponse

modelGetFlowById

public com.ibm.cloud.sdk.core.http.ServiceCall<GetFlowResponse> modelGetFlowById(ModelGetFlowByIdOptions modelGetFlowByIdOptions)

Retrieve the latest workflow information of a previously requested change to data model or matching algorithm. Requires the application role of 'ModelReader'.

Parameters:

modelGetFlowByIdOptions - the ModelGetFlowByIdOptions containing the options for the call

Returns:

a ServiceCall with a result of type GetFlowResponse

modelDeleteFlow

public com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,Object>> modelDeleteFlow(ModelDeleteFlowOptions modelDeleteFlowOptions)

Remove an idle workflow specified by the supplied flow_id. Requires the application role of 'ModelManager'.

Parameters:

modelDeleteFlowOptions - the ModelDeleteFlowOptions containing the options for the call

Returns:

a ServiceCall with a result of type Map

modelPatchFlow

public com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,Object>> modelPatchFlow(ModelPatchFlowOptions modelPatchFlowOptions)

Approve/Reject an active workflow specified by the supplied flow_id. Requires the application role of 'ModelWriter'.

Parameters:

modelPatchFlowOptions - the ModelPatchFlowOptions containing the options for the call

Returns:

a ServiceCall with a result of type Map

modelGetInstanceMetadata

public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceMetadata> modelGetInstanceMetadata(ModelGetInstanceMetadataOptions modelGetInstanceMetadataOptions)

Retrieve the configured metadata for a provisioned instance of system. Requires the application role of 'ModelReader'.

Parameters:

modelGetInstanceMetadataOptions - the ModelGetInstanceMetadataOptions containing the options for the call

Returns:

a ServiceCall with a result of type InstanceMetadata

modelModifyInstanceMetadata

public com.ibm.cloud.sdk.core.http.ServiceCall<InstanceMetadata> modelModifyInstanceMetadata(ModelModifyInstanceMetadataOptions modelModifyInstanceMetadataOptions)

Overwrite the configured metadata for a provisioned instance of system. Requires the application role of 'ModelWriter'.

Parameters:

modelModifyInstanceMetadataOptions - the ModelModifyInstanceMetadataOptions containing the options for the call

Returns:

a ServiceCall with a result of type InstanceMetadata

modelGetMapResource

public com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,List<MapResourceEntry>>> modelGetMapResource(ModelGetMapResourceOptions modelGetMapResourceOptions)

Retrieve the configuration for the equivalent words, commonly used by matching algorithms. Requires the application role of 'ModelReader'.

Parameters:

modelGetMapResourceOptions - the ModelGetMapResourceOptions containing the options for the call

Returns:

a ServiceCall with a result of type Map

modelReplaceMapResource

public com.ibm.cloud.sdk.core.http.ServiceCall<PutMapResourcesResponse> modelReplaceMapResource(ModelReplaceMapResourceOptions modelReplaceMapResourceOptions)

Overwrite the configuration for the equivalent words, commonly used by matching algorithms. Requires the application role of 'ModelWriter'.

Parameters:

modelReplaceMapResourceOptions - the ModelReplaceMapResourceOptions containing the options for the call

Returns:

a ServiceCall with a result of type PutMapResourcesResponse

modelListMapResources

public com.ibm.cloud.sdk.core.http.ServiceCall<MapResourceNames> modelListMapResources(ModelListMapResourcesOptions modelListMapResourcesOptions)

Retrieve the list of existing configurations for the equivalent words. Requires the application role of 'ModelReader'.

Parameters:

modelListMapResourcesOptions - the ModelListMapResourcesOptions containing the options for the call

Returns:

a ServiceCall with a result of type MapResourceNames

modelGetSetResource

public com.ibm.cloud.sdk.core.http.ServiceCall<Map<String,SetResourceEntry>> modelGetSetResource(ModelGetSetResourceOptions modelGetSetResourceOptions)

Retrieve the configuration for the anonymous set of words, commonly used by matching algorithms. Requires the application role of 'ModelReader'.

Parameters:

modelGetSetResourceOptions - the ModelGetSetResourceOptions containing the options for the call

Returns:

a ServiceCall with a result of type Map

modelReplaceSetResource

public com.ibm.cloud.sdk.core.http.ServiceCall<PutSetResourcesResponse> modelReplaceSetResource(ModelReplaceSetResourceOptions modelReplaceSetResourceOptions)

Overwrite the configuration for the anonymous set of words, commonly used by matching algorithms. Requires the application role of 'ModelWriter'.

Parameters:

modelReplaceSetResourceOptions - the ModelReplaceSetResourceOptions containing the options for the call

Returns:

a ServiceCall with a result of type PutSetResourcesResponse

modelListSetResources

public com.ibm.cloud.sdk.core.http.ServiceCall<SetResourceNames> modelListSetResources(ModelListSetResourcesOptions modelListSetResourcesOptions)

Retrieve the list of existing configurations for the anonymous set of words. Requires the application role of 'ModelReader'.

Parameters:

modelListSetResourcesOptions - the ModelListSetResourcesOptions containing the options for the call

Returns:

a ServiceCall with a result of type SetResourceNames