Class | Description |
---|---|
AddGlobalLogEntry |
Add a new entry to the global log.
|
ApplyConfiguration |
Application and rollback
Apply a given configuration. For each store entry, the latest available version will be used unless it is overriden by an entry in StoreEntryList. |
ApplyConfigurationResponse |
Response to a @see ApplyConfiguration or @see RollbackConfigurationStoreAndApply request
|
ApplyConfigurationResponse.ApplyPostActions | |
ApplyConfigurationResponse.ApplyPostRestartProcesses | |
ApplyConfigurationResponse.ApplyPreActions | |
ApplyConfigurationResponse.ApplyRestartProcesses | |
ApplyConfigurationResponse.ManualActions | |
ApplyConfigurationResponse.Warnings | |
ApplyStatus |
No documentation for this element.
|
AttachHost |
Attach a host so the master configuration is replicated
|
AuthenticateUser |
Operations
Authenticates a user. |
AuthenticateUserParams |
No documentation for this element.
|
AuthenticateUserParams.OptParams | |
AuthenticateUserWithConfig |
Operations
Authenticates a user with a specific config for a given source. |
AuthenticationResult |
No documentation for this element.
|
AuthenticationSource |
No documentation for this element.
|
AuthorizationSource |
No documentation for this element.
|
CalendarConfig |
Base class for calendar configuration.
|
CheckComponentConfig |
No documentation for this element.
|
ClearGlobalLogEntryStore |
Clears the global log entry store.
|
CommentVersion |
Modify comment describing a given applied version
|
ComponentConfigCheckError |
Error encountered while checking the configuration of a component.
|
ComponentConfigCheckErrors |
List of errors encountered while checking the configurations of components.
|
ComponentDescription |
No documentation for this element.
|
ComponentInfo |
No documentation for this element.
|
ComponentInfo.DefaultConfig | |
ComponentIntrospectionQuery |
No documentation for this element.
|
ComponentIntrospectionQuery.DefaultConfig | |
ComponentsList |
No documentation for this element.
|
ConfigBuilderConfig |
A config builder config.
|
ConfigBuilderConfigList |
A list of config builders config.
|
CountGlobalLogEntries |
Counts the number of global log entries.
|
CronCalendarConfig |
Set to exclude a time range defined with a Quartz Cron expression.
|
CronTriggerConfig |
Cron based trigger
The following values for
misfireInstruction are available:
do_nothing: nothing is done when a trigger has been misfired.
fire_once_now: the trigger is immediately executed when it has been misfired.
If misfireInstruction is set to null, when the trigger couldn't be fired, the following scheme applies:
The instruction will be interpreted as fire_once_now.
|
CustomConfig |
Data model
A custom configuration entry. Contains the custom configuration entries in a set of @c KeyValue. |
CustomConfigList |
A list of custom configuration entries.
|
CustomValidator |
No documentation for this element.
|
DailyCalendarConfig |
Used to exclude a time range from a day.
|
DeleteVersion |
Cleanup methods
Deletes a given applied configuration version. |
DeleteVersionsBefore |
Deletes every applied configuration version before a given
version (included). |
DetachHost |
Detach a host so the master configuration is replicated
|
Diagnose |
No documentation for this element.
|
Diagnostic |
Result of the analysis
|
DiagnosticConfig |
Deprecated
|
DiagnosticList |
List of diagnostics
|
DispatchJobConfig |
Generic job used to dispath a message to a service
|
DSLSStatus |
No documentation for this element.
|
Error |
Error while diagnosing
|
FeatureVersion |
Feature versions.
|
FlushGlobalLogEntryStore |
Flushs the global log entry store to persistent storage.
|
Freeze |
Freezes and unfreezes operations
Freezes the product so that it can be safely backed up.
|
GCTFile |
No documentation for this element.
|
GCTFiles |
No documentation for this element.
|
GetAppliedVersion |
Gets the currently applied version.
|
GetApplyStatus |
No documentation for this element.
|
GetComponentConfigDescriptor |
No documentation for this element.
|
GetComponentDefaultConfig | Deprecated |
GetComponentInfo |
No documentation for this element.
|
GetConfigurationTree |
Get the current GCT (restricted to host install if not null)
Warning: internal only, not published in the directory |
GetConfigurationVersion |
Inspection methods
Get the current applied configuration version. Warning: internal only, not published in the directory |
GetCustomConfigList |
Gets custom configuration entry.
|
GetCustomConfigListByVersion |
Gets custom configuration list by version
|
GetGCTFiles |
No documentation for this element.
|
GetGlobalLogEntryList |
Get a list of global log entries.
May fail if the global log entries store was not initialized. |
GetLastLogs |
Gets the last logs from the global log (return the last log entries, limited by max size of the logs RAM buffer set in the GlobalLoggerConfig).
|
GetLicensingStatus |
No documentation for this element.
|
GetLoggingConfig |
Gets the logging configuration.
|
GetLoggingConfigByVersion |
Gets the logging configuration for a stored version.
|
GetProductInformation |
Gets information on your product.
|
GetProductSecurity |
Get ProductSecurity.
|
GetProductSecurityByVersion |
Interface for every action specific to a given applied configuration version
|
GetPublicKey | |
GetSchedulingConfig |
Gets the scheduling configuration.
|
GetSchedulingConfigByVersion |
Interface for every action specific to a given applied configuration version
|
GetSecuritySourceInfo |
Gets runtime information about the security source.
Can be used to check configuration parameters. Check your security source documentation to know which information is available. |
GetSecuritySourceList |
Messages
Lists security sources. |
GetSecuritySourceListByVersion |
Interface for every action specific to a given applied configuration version
|
GetSecuritySourcesStatus |
Gets the status of security sources
|
GetSecuritySourceTypeList |
Gets the list of available security source types.
|
GetValidatorConfig |
Get list of all validators on the instance.
|
GetValidatorConfigByVersion |
Interface for every action specific to a given applied configuration version
|
GlobalLogEntry |
A global log entry.
|
GlobalLogEntryList |
A list of global log entries.
|
GlobalLoggerConfig |
Global logger module configuration.
|
HostSpecific |
Commands related to a remote host
|
HotfixVersion |
No documentation for this element.
|
IdentityProviderConfig |
Definition of an identity provider.
Used, for example, by the admin ui components to define a common login API. |
IndexingAuthorization |
No documentation for this element.
|
IndexingTokensStatus |
No documentation for this element.
|
IndexingTokensStatus.DocumentTypeCosts | |
IndexingTokensStatus.DocumentTypeMax | |
IndexingTokensStatus.DocumentTypes | |
InternalPutMashupUsers |
No documentation for this element.
|
InternalPutSourcesCounts |
No documentation for this element.
|
IPRule | Deprecated |
IsDetached |
Returns if the specified host is attached or not
|
JobConfig |
Base class for a job
|
JobConfigGroup |
Configuration for a group of jobs.
|
LicenseServerStatus |
No documentation for this element.
|
LicenseValidityStatus |
No documentation for this element.
|
LicensingStatus |
No documentation for this element.
|
LicensingStatus.AllowedConnectorNames | |
LicensingStatus.ForbiddenConnectorClassIds | |
ListAvailableVersions |
List available applied versions.
|
ListComponents |
No documentation for this element.
|
ListLastAvailableVersions |
Lists the last available versions decreasing.
|
ListPlugins |
No documentation for this element.
|
LoggingConfig |
Data model
General Logging configuration, for generic process logs. Specific system (crawler, query) have their specific log policy. |
LoggingLevel |
Logging level configuration.
|
MAMIConfig |
A MAMI configuration manager.
|
MAMIConfigList |
A list of MAMI config entries.
|
MAMISecurity |
Management APIs security (gateway).
|
MetaSecuritySource |
Meta security source configuration
|
MetaSubSource |
No documentation for this element.
|
MonthlyCalendarConfig |
Used to exclude a set of days from a month.
Contains the range of days to exclude (1-31) |
ObjectFactory | |
Plugin |
No documentation for this element.
|
PluginList |
List of plugins.
|
ProductInformation |
Data model
Some raw information on the product. |
ProductSecurity |
Defines the product security.
|
ProductSecurity.TrustedHost | |
ProductVersion |
Product version.
|
PublicAPISecurity |
Base class for public API security.
|
PublicKey |
Contains base64 value of public key
|
PurgeLog |
Purge log files based on size and date rules
|
PushAPISecurity |
PushAPI Security
Warning on contrary to MAMI Security and Search API Security, the login and password are configured at the connector config level. |
PutGCTFiles |
No documentation for this element.
|
ReloadSecuritySource |
Reloads cache for a specific security source
|
ReloadSecuritySources |
Reloads security sources cache
|
RemoteHttpConfig |
Security source config.
The list of uri used by RemoteHttpSource |
RemoteHttpSource |
Remote Http security source configuration
|
RemovePlugin |
Class for removing a plugin
|
RollbackConfigurationStoreAndApply |
Rollback to a previously applied configuration store and apply.
Same as Rollback but it also overrides the corresponding configuration files. |
RotateLog |
Rotates log files.
|
RotateLogIfSize |
Rotates log files if they exceed the size defined in maxSizeKB
|
RotateReportingStore |
No documentation for this element.
|
RunAllValidators |
Runs all the validators.
|
RunValidator |
Run a specific validator
|
RunValidatorGroup |
Run a group of validators
|
SchedulingConfig |
Scheduled jobs configuration.
|
SDKVersion |
SDK versions.
|
SearchAPISecurity |
Class used for search API security (search, fetch).
|
SearchQueriesStateForType |
Current state and allowed limit for a given type of query.
|
SearchUsersStateForType |
Current state and allowed limit for a given type of user.
|
SecuritySource |
Security source configuration
|
SecuritySource.Config | |
SecuritySourceBase |
Object model
Common attributes to classic, meta and remote security sources |
SecuritySourceInfo |
No documentation for this element.
|
SecuritySourceList |
List of security sources
|
SecuritySourcesStatus |
Inspection
A set of security sources status |
SecuritySourceStatus |
Status of a given security source.
|
SecuritySourceType |
Security source type
|
SecuritySourceTypeList |
List of security source types
|
SetCustomConfigList |
Operations
Sets custom configuration entries |
SetLoggingConfig |
Operations
Sets the logging configuration. |
SetLoggingLevel |
Dynamically updates the logging level of a given process.
|
SetProductSecurity |
Set ProductSecurity.
|
SetSchedulingConfig |
Operations
Sets the scheduling configuration. |
SetSecuritySourceList |
Sets security sources list.
|
SetValidatorConfig |
Set list validators for the instance.
|
SimpleTriggerConfig |
Simple trigger
The following values for
misfireInstruction are available:
fire_now: immediately fires the trigger
reschedule_next_with_existing_count: reschedule to next execution with repeatCount left unchanged.
reschedule_next_with_remaining_count: reschedule to next execution with repeat count set to what it would be if it had not missed any firings.
reschedule_now_with_existing_repeat_count: reschedule now with repeatCount left unchanged.
reschedule_now_with_remaining_repeat_count: reschedule now with repeat count set to what it would be if it had not missed any firings.
If misfireInstruction is set to null, when the trigger couldn't be fired, the following scheme applies
If repeatCount is set to 0, the instruction will be interpreted as fire_now
If {link repeatCount} is set to <0, the instruction will be interpreted as reschedule_next_with_remaining_count
If {link repeatCount} is set to >0, the instruction will be interpreted as reschedule_now_with_existing_repeat_count
|
SourceCounts |
No documentation for this element.
|
StoreEntry |
No documentation for this element.
|
StoreEntryList |
No documentation for this element.
|
Symptom |
Information on a possible problem
|
SymptomAnalysisConfig |
Information on a possible problem
|
SymptomAnalysisConfigBase |
Generic symptom related to the AnalysisConfig
|
SymptomAnalysisPipeline |
Abstract class for symptoms representing issues affecting analysis pipelines.
|
SymptomAnalysisPipelineBase |
Abstract class for symptoms representing issues affecting analysis pipelines.
|
SymptomBase |
Information on a possible problem
|
SymptomDataModel |
Information on a possible problem
|
SymptomDataModelSearchLogic |
Symptom concerning a data model and a search logic.
|
SymptomDataModelSearchLogicBase |
Symptom concerning a data model and a search logic.
|
SymptomDocumentProcessor |
A DocumentProcessor-based symptom.
|
SymptomFacet |
Symptom concerning a data model, a search logic and a facet.
|
SymptomHitMeta |
Information on a possible problem
|
SymptomIndex |
Symptom concerning an index.
|
SymptomIndexing |
Information on a possible problem
|
SymptomLoggers |
Raises a symptom when logging level is above info
|
SymptomSearchLogic |
Information on a possible problem
|
SymptomSearchServer |
Symptom concerning a data model, a search logic and a search server.
|
SymptomSecuritySource |
Information on a possible problem
|
SymptomSemanticModule |
Information on a possible problem
|
SymptomSemanticProcessor |
Abstract class for symptoms representing issues affecting analysis pipelines.
|
SymptomSlot |
Information on a possible problem
|
SymptomSource |
Symptom concerning a data model and a search logic.
|
SymptomSuggest |
Information on a possible problem
|
SymptomTuning |
A specific Symptom for describing the issues related to tuning
|
TriggerConfig |
Base class for a trigger.
|
TriggerConfigGroup |
Configuration for a group of triggers
|
Unfreeze |
Unfreezes the product state.
|
UploadLicenseFileBytes |
Upload a new version of the CloudView license file - referenced by the CVLICENSE environment variable, as base64-encoded bytes.
|
UploadLocalLicenseFile |
Upload a new version of the CloudView license file - referenced by the CVLICENSE environment variable, from a given path.
|
Validator |
No documentation for this element.
|
ValidatorConfig |
No documentation for this element.
|
ValidatorGroup |
List of Validators that have the same runtime or target the same configuration.
|
Version |
Description of a given version.
|
VersionList |
List of Version
|
WeeklyCalendarConfig |
Used to exclude a set of days in the week.
Contains the range of days to exclude (1-7). |
Enum | Description |
---|---|
MetaSecuritySource.Type | |
RemoteHttpConfig.Protocol | |
Symptom.Severity |
Copyright © 2021 Dassault Systèmes, All Rights Reserved.