Managing Providers
The services for provider management are available in the TW.AnalysisServices.ProviderManagementServicesAPI resource.
The following table provides information about the purpose, input parameters, and the result of each service:
|
Service Name and Purpose
|
Input Parameters
|
Result
|
||||
|---|---|---|---|---|---|---|
|
Parameter Name
|
Base Type
|
Description
|
||||
|
CreateProvider — Creates an analysis provider.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns the ID of the provider. Throws an exception if there are any errors, such as invalid provider name, connector already used by another provider, and so on.
|
||
|
description
|
String
|
Specifies the provider description.
|
||||
|
connectorName
|
Thingname
|
Specifies the name of the connector thing.
|
||||
|
isIdentityAutoGenerated
|
Boolean
|
Set to true so that the analysis provider generates the job IDs. By default, this is set to false. In this case, the Analytics Manager framework generates the job IDs.
|
||||
|
writeIOToFile
|
Boolean
|
Set to true if the job inputs and results are to be written to the file and referenced from the job. The default value is false.
|
||||
|
compressIOFiles
|
Boolean
|
Set this to true only if the writeIOToFile parameter is set to true. If this is set to true, the inputs and results are written in compressed form to files. The default value is false.
|
||||
|
purgeJobsAge
|
Integer
|
Specifies the job age in hours after which they should be purged.
|
||||
|
minCPU
|
Number
|
Specifies the value of the minimum CPU that is required to scale up or start a new provider.
|
||||
|
minMem
|
Integer
|
Specifies the minimum memory in MB required to scale up or start a new provider.
|
||||
|
minDisk
|
Integer
|
Specifies the minimum disk space in MB required to scale up or start a new provider.
|
||||
|
allowMultipleInstancesOfAnalysis
|
Boolean
|
Set to true if multiple executions of the same analysis are to be permitted for the provider. The default value is false.
|
||||
|
customData
|
Infotable
|
Specifies any additional information that is customer-specific about a provider.
|
||||
|
DeleteProvider — Deletes the analysis provider.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns a message that states the successful completion or errors that occur during the execution of the service.
|
||
|
EditProvider — Edits an analysis provider.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns the ID of the provider. Throws an exception if there are any errors.
|
||
|
description
|
String
|
Specifies the provider description.
|
||||
|
isIdentityAutoGenerated
|
Boolean
|
Set to true so that the analysis provider generates the job IDs. By default, this is set to false. In this case, the Analytics Manager framework generates the job IDs.
|
||||
|
writeIOToFile
|
Boolean
|
Set to true if the job inputs and results are to be written to the file and referenced from the job. The default value is false.
|
||||
|
compressIOFiles
|
Boolean
|
Set this to true only if the writeIOToFile parameter is set to true. If this is set to true, the inputs and results are written in compressed form to files. The default value is false.
|
||||
|
purgeJobsAge
|
Integer
|
Specifies the job age in hours after which they should be purged.
|
||||
|
minCPU
|
Number
|
Specifies the value of the minimum CPU that is required to scale up or start a new provider.
|
||||
|
minMem
|
Integer
|
Specifies the minimum memory in MB required to scale up or start a new provider.
|
||||
|
minDisk
|
Integer
|
Specifies the minimum disk space in MB required to scale up or start a new provider.
|
||||
|
allowMultipleInstancesOfAnalysis
|
Boolean
|
Set to true if multiple executions of the same analysis are to be permitted for the provider. The default value is false.
|
||||
|
customData
|
Infotable
|
Specifies any additional information that is customer-specific about a provider.
|
||||
|
GetAllAgentsForProvider — Obtains information about the active and inactive agents for the specified provider.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns information about all the agents in the form of an infotable.
Throws an exception in case of any errors while providing input parameters.
|
||
|
includeInactiveAgents
|
Boolean
|
Set to true to include inactive agents for the specified provider. The default value is false.
|
||||
|
GetProvider — Obtains information about the analysis provider.
|
providerName
|
String
|
Specifies the name of the provider.
|
Returns information about the analysis provider in the form of an infotable that has the TW.AnalysisServices.ProviderConfigDataShape data shape.
|
||
|
QueryProviders — Returns provider information based on the query.
|
values
|
Infotable
|
Specifies the attributes of the provider in the form of a collection of multiple value rows.
|
Returns information about the analysis provider in the form of an infotable that has the TW.AnalysisServices.ProviderConfigDataShape data shape.
|
||
|
query
|
Query
|
Specifies the query that includes what information is required about a particular provider.
|
||||
