Enum SzFlagUsageGroup
Enumerates the various classifications of usage groups for the SzFlag instances.
[Flags]
public enum SzFlagUsageGroup : long
- Extension Methods
Fields
SzAddRecordFlags = 1
Flags in this usage group can be used for operations that add (load) records to the entity repository.
Applicable methods include:
The SzFlag instances included in this usage group are:
The pre-defined SzFlag aggregate constants for this group are:
See also: https://docs.senzing.com/flags/index.htmlSzDeleteRecordFlags = 2
Flags in this usage group can be used for operations that delete records from the entity repository.
Applicable methods include:
The SzFlag instances included in this usage group are:
The pre-defined SzFlag aggregate constants for this group are:
See also: https://docs.senzing.com/flags/index.htmlSzEntityFlags = 128
Flags in this usage group can be used for operations that retrieve entity data in order to control the level of detail of the returned entity.
Applicable methods include:
The SzFlag instances included in this usage group are:
- SzEntityIncludePossiblySameRelations
- SzEntityIncludePossiblyRelatedRelations
- SzEntityIncludeNameOnlyRelations
- SzEntityIncludeDisclosedRelations
- SzEntityIncludeAllFeatures
- SzEntityIncludeRepresentativeFeatures
- SzEntityIncludeEntityName
- SzEntityIncludeRecordSummary
- SzEntityIncludeRecordTypes
- SzEntityIncludeRecordData
- SzEntityIncludeRecordMatchingInfo
- SzEntityIncludeRecordJsonData
- SzEntityIncludeRecordUnmappedData
- SzEntityIncludeRecordFeatures
- SzEntityIncludeRecordFeatureDetails
- SzEntityIncludeRecordFeatureStats
- SzEntityIncludeRelatedEntityName
- SzEntityIncludeRelatedMatchingInfo
- SzEntityIncludeRelatedRecordSummary
- SzEntityIncludeRelatedRecordTypes
- SzEntityIncludeRelatedRecordData
- SzEntityIncludeInternalFeatures
- SzEntityIncludeFeatureStats
- SzIncludeMatchKeyDetails
The pre-defined SzFlag aggregate constants for this group are:
The pre-defined SzFlag aggregate constants that also support this group for defining entity or record detail levels are:
See also: https://docs.senzing.com/flags/index.htmlSzExportFlags = 4096
Flags in this usage group can be used for operations that export entities to control how the entities are qualified for inclusion in the export and the level of detail for the entities returned in the search results.
Applicable methods include:
The SzFlag instances included in this usage group are:
- SzEntityIncludePossiblySameRelations
- SzEntityIncludePossiblyRelatedRelations
- SzEntityIncludeNameOnlyRelations
- SzEntityIncludeDisclosedRelations
- SzEntityIncludeAllFeatures
- SzEntityIncludeRepresentativeFeatures
- SzEntityIncludeEntityName
- SzEntityIncludeRecordSummary
- SzEntityIncludeRecordTypes
- SzEntityIncludeRecordData
- SzEntityIncludeRecordMatchingInfo
- SzEntityIncludeRecordJsonData
- SzEntityIncludeRecordUnmappedData
- SzEntityIncludeRecordFeatures
- SzEntityIncludeRecordFeatureDetails
- SzEntityIncludeRecordFeatureStats
- SzEntityIncludeRelatedEntityName
- SzEntityIncludeRelatedMatchingInfo
- SzEntityIncludeRelatedRecordSummary
- SzEntityIncludeRelatedRecordTypes
- SzEntityIncludeRelatedRecordData
- SzEntityIncludeInternalFeatures
- SzEntityIncludeFeatureStats
- SzExportIncludeMultiRecordEntities
- SzExportIncludePossiblySame
- SzExportIncludePossiblyRelated
- SzExportIncludeNameOnly
- SzExportIncludeDisclosed
- SzExportIncludeSingleRecordEntities
The pre-defined SzFlag aggregate constants that also support this group for defining entity or record detail levels are:
- SzRecordDefaultFlags
- SzEntityIncludeAllRelations
- SzEntityDefaultFlags
- SzEntityBriefDefaultFlags
- SzVirtualEntityDefaultFlags
SzFindInterestingEntitiesFlags = 1024
Flags in this usage group can be used to control the methodology for finding an interesting entities and what details to include for the results of the operation.
Applicable methods include:
Currently, there are no SzFlag instances included in this usage group. However, this is a placeholder for when such flags are defined in a future release.
The pre-defined SzFlag aggregate constants that use this group and are defined for "find-path" operations are:
See also: https://docs.senzing.com/flags/index.htmlSzFindNetworkFlags = 512
Flags in this usage group can be used to control the methodology for finding an entity network, what details to include for the entity network and the level of detail for the entities in the network that are returned.
Applicable methods include:
- FindNetwork(ISet<long>, int, int, int, SzFlag?)
- FindNetwork(ISet<(string dataSourceCode, string recordID)>, int, int, int, SzFlag?)
The SzFlag instances included in this usage group are:
- SzEntityIncludePossiblySameRelations
- SzEntityIncludePossiblyRelatedRelations
- SzEntityIncludeNameOnlyRelations
- SzEntityIncludeDisclosedRelations
- SzEntityIncludeAllFeatures
- SzEntityIncludeRepresentativeFeatures
- SzEntityIncludeEntityName
- SzEntityIncludeRecordSummary
- SzEntityIncludeRecordTypes
- SzEntityIncludeRecordData
- SzEntityIncludeRecordMatchingInfo
- SzEntityIncludeRecordJsonData
- SzEntityIncludeRecordUnmappedData
- SzEntityIncludeRecordFeatures
- SzEntityIncludeRecordFeatureDetails
- SzEntityIncludeRecordFeatureStats
- SzEntityIncludeRelatedEntityName
- SzEntityIncludeRelatedMatchingInfo
- SzEntityIncludeRelatedRecordSummary
- SzEntityIncludeRelatedRecordTypes
- SzEntityIncludeRelatedRecordData
- SzEntityIncludeInternalFeatures
- SzIncludeMatchKeyDetails
- SzEntityIncludeFeatureStats
- SzFindNetworkIncludeMatchingInfo
The pre-defined SzFlag aggregate constants that use this group and are defined for "find-path" operations are:
The pre-defined SzFlag aggregate constants that also support this group for defining entity or record detail levels are:
- SzRecordDefaultFlags
- SzEntityIncludeAllRelations
- SzEntityDefaultFlags
- SzEntityBriefDefaultFlags
- SzVirtualEntityDefaultFlags
SzFindPathFlags = 256
Flags in this usage group can be used to control the methodology for finding an entity path, what details to include for the entity path and the level of detail for the entities on the path that are returned.
Applicable methods include:
- FindPath(long, long, int, ISet<long>, ISet<string>, SzFlag?)
- FindPath(string, string, string, string, int, ISet<(string dataSourceCode, string recordID)>, ISet<string>, SzFlag?)
The SzFlag instances included in this usage group are:
- SzEntityIncludePossiblySameRelations
- SzEntityIncludePossiblyRelatedRelations
- SzEntityIncludeNameOnlyRelations
- SzEntityIncludeDisclosedRelations
- SzEntityIncludeAllFeatures
- SzEntityIncludeRepresentativeFeatures
- SzEntityIncludeEntityName
- SzEntityIncludeRecordSummary
- SzEntityIncludeRecordTypes
- SzEntityIncludeRecordData
- SzEntityIncludeRecordMatchingInfo
- SzEntityIncludeRecordJsonData
- SzEntityIncludeRecordUnmappedData
- SzEntityIncludeRecordFeatures
- SzEntityIncludeRecordFeatureDetails
- SzEntityIncludeRecordFeatureStats
- SzEntityIncludeRelatedEntityName
- SzEntityIncludeRelatedMatchingInfo
- SzEntityIncludeRelatedRecordSummary
- SzEntityIncludeRelatedRecordTypes
- SzEntityIncludeRelatedRecordData
- SzEntityIncludeInternalFeatures
- SzEntityIncludeFeatureStats
- SzIncludeMatchKeyDetails
- SzFindPathStrictAvoid
- SzFindPathIncludeMatchingInfo
The pre-defined SzFlag aggregate constants that use this group and are defined for "find-path" operations are:
The pre-defined SzFlag aggregate constants that also support this group for defining entity or record detail levels are:
- SzRecordDefaultFlags
- SzEntityIncludeAllRelations
- SzEntityDefaultFlags
- SzEntityBriefDefaultFlags
- SzVirtualEntityDefaultFlags
SzHowFlags = 131072
Flags in this usage group can be used to control the methodology for performing "how analysis", what details to include for the analysis and the level of detail for the entities in the network that are returned.
Applicable methods include:
The SzFlag instances included in this usage group are:
The pre-defined SzFlag aggregate constants that use this group and are defined for "how" operations are:
The pre-defined SzFlag aggregate constants that also support this group for defining entity or record detail levels are:
- SzRecordDefaultFlags
- SzEntityIncludeAllRelations
- SzEntityDefaultFlags
- SzEntityBriefDefaultFlags
- SzVirtualEntityDefaultFlags
SzRecordFlags = 32
Flags in this usage group can be used for operations that retrieve record data in order to control the level of detail of the returned record.
Applicable methods include:
The SzFlag instances included in this usage group are:
- SzEntityIncludeInternalFeatures
- SzEntityIncludeRecordFeatures
- SzEntityIncludeRecordFeatureDetails
- SzEntityIncludeRecordFeatureStats
- SzEntityIncludeRecordDates
- SzEntityIncludeRecordJsonData
- SzEntityIncludeRecordUnmappedData
The pre-defined SzFlag aggregate constants for this group are:
See also: https://docs.senzing.com/flags/index.htmlSzRecordPreviewFlags = 64
Flags in this usage group can be used for operations that retrieve record data in order to control the level of detail of the returned record.
Applicable methods include:
The SzFlag instances included in this usage group are:
- SzEntityIncludeInternalFeatures
- SzEntityIncludeRecordFeatures
- SzEntityIncludeRecordFeatureDetails
- SzEntityIncludeRecordFeatureStats
- SzEntityIncludeRecordJsonData
- SzEntityIncludeRecordUnmappedData
The pre-defined SzFlag aggregate constants for this group are:
See also: https://docs.senzing.com/flags/index.htmlSzRedoFlags = 16
Flags in this usage group can be used for operations that process redo records in the entity repository.
Applicable methods include:
The SzFlag instances included in this usage group are:
The pre-defined SzFlag aggregate constants for this group are:
See also: https://docs.senzing.com/flags/index.htmlSzReevaluateEntityFlags = 8
Flags in this usage group can be used for operations that reevaluate entities in the entity repository.
Applicable methods include:
The SzFlag instances included in this usage group are:
The pre-defined SzFlag aggregate constants for this group are:
See also: https://docs.senzing.com/flags/index.htmlSzReevaluateRecordFlags = 4
Flags in this usage group can be used for operations that reevaluate records in the entity repository.
Applicable methods include:
The SzFlag instances included in this usage group are:
The pre-defined SzFlag aggregate constants for this group are:
See also: https://docs.senzing.com/flags/index.htmlSzSearchFlags = 2048
Flags in this usage group can be used for operations that search for entities to control how the entities are qualified for inclusion in the search results and the level of detail for the entities returned in the search results.
Applicable methods include:
The SzFlag instances included in this usage group are:
- SzEntityIncludePossiblySameRelations
- SzEntityIncludePossiblyRelatedRelations
- SzEntityIncludeNameOnlyRelations
- SzEntityIncludeDisclosedRelations
- SzEntityIncludeAllFeatures
- SzEntityIncludeRepresentativeFeatures
- SzEntityIncludeEntityName
- SzEntityIncludeRecordSummary
- SzEntityIncludeRecordTypes
- SzEntityIncludeRecordData
- SzEntityIncludeRecordMatchingInfo
- SzEntityIncludeRecordJsonData
- SzEntityIncludeRecordUnmappedData
- SzEntityIncludeRecordFeatures
- SzEntityIncludeRecordFeatureDetails
- SzEntityIncludeRecordFeatureStats
- SzEntityIncludeRelatedEntityName
- SzEntityIncludeRelatedMatchingInfo
- SzEntityIncludeRelatedRecordSummary
- SzEntityIncludeRelatedRecordTypes
- SzEntityIncludeRelatedRecordData
- SzEntityIncludeInternalFeatures
- SzEntityIncludeFeatureStats
- SzIncludeMatchKeyDetails
- SzIncludeFeatureScores
- SzSearchIncludeStats
- SzSearchIncludeResolved
- SzSearchIncludePossiblySame
- SzSearchIncludePossiblyRelated
- SzSearchIncludeNameOnly
- SzSearchIncludeAllCandidates
- SzSearchIncludeRequest
- SzSearchIncludeRequestDetails
The pre-defined SzFlag aggregate constants that use this group and are defined for "search" operations are:
- SzSearchIncludeAllEntities
- SzSearchByAttributesAll
- SzSearchByAttributesStrong
- SzSearchByAttributesMinimalAll
- SzSearchByAttributesMinimalStrong
- SzSearchByAttributesDefaultFlags
The pre-defined SzFlag aggregate constants that also support this group for defining entity or record detail levels are:
- SzRecordDefaultFlags
- SzEntityIncludeAllRelations
- SzEntityDefaultFlags
- SzEntityBriefDefaultFlags
- SzVirtualEntityDefaultFlags
SzVirtualEntityFlags = 262144
Flags in this usage group can be used for operations that retrieve virtual entities in order to control the level of detail of the returned virtual entity.
Applicable methods include:
The SzFlag instances included in this usage group are:
- SzEntityIncludeAllFeatures
- SzEntityIncludeRepresentativeFeatures
- SzEntityIncludeEntityName
- SzEntityIncludeRecordSummary
- SzEntityIncludeRecordTypes
- SzEntityIncludeRecordData
- SzEntityIncludeRecordMatchingInfo
- SzEntityIncludeRecordJsonData
- SzEntityIncludeRecordUnmappedData
- SzEntityIncludeRecordFeatures
- SzEntityIncludeRecordFeatureDetails
- SzEntityIncludeRecordFeatureStats
- SzEntityIncludeInternalFeatures
- SzEntityIncludeFeatureStats
The pre-defined SzFlag aggregate constants for this group are:
See also: https://docs.senzing.com/flags/index.htmlSzWhyEntitiesFlags = 32768
Flags in this usage group can be used to control the methodology for performing "why analysis", what details to include for the analysis and the level of detail for the entities in the network that are returned.
Applicable methods include:
The SzFlag instances included in this usage group are:
- SzEntityIncludePossiblySameRelations
- SzEntityIncludePossiblyRelatedRelations
- SzEntityIncludeNameOnlyRelations
- SzEntityIncludeDisclosedRelations
- SzEntityIncludeAllFeatures
- SzEntityIncludeRepresentativeFeatures
- SzEntityIncludeEntityName
- SzEntityIncludeRecordSummary
- SzEntityIncludeRecordTypes
- SzEntityIncludeRecordData
- SzEntityIncludeRecordMatchingInfo
- SzEntityIncludeRecordJsonData
- SzEntityIncludeRecordUnmappedData
- SzEntityIncludeRecordFeatures
- SzEntityIncludeRecordFeatureDetails
- SzEntityIncludeRecordFeatureStats
- SzEntityIncludeRelatedEntityName
- SzEntityIncludeRelatedMatchingInfo
- SzEntityIncludeRelatedRecordSummary
- SzEntityIncludeRelatedRecordTypes
- SzEntityIncludeRelatedRecordData
- SzEntityIncludeInternalFeatures
- SzEntityIncludeFeatureStats
- SzIncludeMatchKeyDetails
- SzIncludeFeatureScores
The pre-defined SzFlag aggregate constants that use this group and are defined for "why" operations are:
The pre-defined SzFlag aggregate constants that also support this group for defining entity or record detail levels are:
- SzRecordDefaultFlags
- SzEntityIncludeAllRelations
- SzEntityDefaultFlags
- SzEntityBriefDefaultFlags
- SzVirtualEntityDefaultFlags
SzWhyRecordInEntityFlags = 8192
Flags in this usage group can be used to control the methodology for performing "why analysis", what details to include for the analysis and the level of detail for the entities in the network that are returned.
Applicable methods include:
The SzFlag instances included in this usage group are:
- SzEntityIncludePossiblySameRelations
- SzEntityIncludePossiblyRelatedRelations
- SzEntityIncludeNameOnlyRelations
- SzEntityIncludeDisclosedRelations
- SzEntityIncludeAllFeatures
- SzEntityIncludeRepresentativeFeatures
- SzEntityIncludeEntityName
- SzEntityIncludeRecordSummary
- SzEntityIncludeRecordTypes
- SzEntityIncludeRecordData
- SzEntityIncludeRecordMatchingInfo
- SzEntityIncludeRecordJsonData
- SzEntityIncludeRecordUnmappedData
- SzEntityIncludeRecordFeatures
- SzEntityIncludeRecordFeatureDetails
- SzEntityIncludeRecordFeatureStats
- SzEntityIncludeRelatedEntityName
- SzEntityIncludeRelatedMatchingInfo
- SzEntityIncludeRelatedRecordSummary
- SzEntityIncludeRelatedRecordTypes
- SzEntityIncludeRelatedRecordData
- SzEntityIncludeInternalFeatures
- SzEntityIncludeFeatureStats
- SzIncludeMatchKeyDetails
- SzIncludeFeatureScores
The pre-defined SzFlag aggregate constants that use this group and are defined for "why" operations are:
The pre-defined SzFlag aggregate constants that also support this group for defining entity or record detail levels are:
- SzRecordDefaultFlags
- SzEntityIncludeAllRelations
- SzEntityDefaultFlags
- SzEntityBriefDefaultFlags
- SzVirtualEntityDefaultFlags
SzWhyRecordsFlags = 16384
Flags in this usage group can be used to control the methodology for performing "why analysis", what details to include for the analysis and the level of detail for the entities in the network that are returned.
Applicable methods include:
The SzFlag instances included in this usage group are:
- SzEntityIncludePossiblySameRelations
- SzEntityIncludePossiblyRelatedRelations
- SzEntityIncludeNameOnlyRelations
- SzEntityIncludeDisclosedRelations
- SzEntityIncludeAllFeatures
- SzEntityIncludeRepresentativeFeatures
- SzEntityIncludeEntityName
- SzEntityIncludeRecordSummary
- SzEntityIncludeRecordTypes
- SzEntityIncludeRecordData
- SzEntityIncludeRecordMatchingInfo
- SzEntityIncludeRecordJsonData
- SzEntityIncludeRecordUnmappedData
- SzEntityIncludeRecordFeatures
- SzEntityIncludeRecordFeatureDetails
- SzEntityIncludeRecordFeatureStats
- SzEntityIncludeRelatedEntityName
- SzEntityIncludeRelatedMatchingInfo
- SzEntityIncludeRelatedRecordSummary
- SzEntityIncludeRelatedRecordTypes
- SzEntityIncludeRelatedRecordData
- SzEntityIncludeInternalFeatures
- SzEntityIncludeFeatureStats
- SzIncludeMatchKeyDetails
- SzIncludeFeatureScores
The pre-defined SzFlag aggregate constants that use this group and are defined for "why" operations are:
The pre-defined SzFlag aggregate constants that also support this group for defining entity or record detail levels are:
- SzRecordDefaultFlags
- SzEntityIncludeAllRelations
- SzEntityDefaultFlags
- SzEntityBriefDefaultFlags
- SzVirtualEntityDefaultFlags
SzWhySearchFlags = 65536
Flags in this usage group can be used for operations that search for entities to control how the entities are qualified for inclusion in the search results and the level of detail for the entities returned in the search results.
Applicable methods include:
The SzFlag instances included in this usage group are:
- SzEntityIncludePossiblySameRelations
- SzEntityIncludePossiblyRelatedRelations
- SzEntityIncludeNameOnlyRelations
- SzEntityIncludeDisclosedRelations
- SzEntityIncludeAllFeatures
- SzEntityIncludeRepresentativeFeatures
- SzEntityIncludeEntityName
- SzEntityIncludeRecordSummary
- SzEntityIncludeRecordTypes
- SzEntityIncludeRecordData
- SzEntityIncludeRecordMatchingInfo
- SzEntityIncludeRecordJsonData
- SzEntityIncludeRecordUnmappedData
- SzEntityIncludeRecordFeatures
- SzEntityIncludeRecordFeatureDetails
- SzEntityIncludeRecordFeatureStats
- SzEntityIncludeRelatedEntityName
- SzEntityIncludeRelatedMatchingInfo
- SzEntityIncludeRelatedRecordSummary
- SzEntityIncludeRelatedRecordTypes
- SzEntityIncludeRelatedRecordData
- SzEntityIncludeInternalFeatures
- SzEntityIncludeFeatureStats
- SzIncludeMatchKeyDetails
- SzIncludeFeatureScores
- SzSearchIncludeStats
- SzSearchIncludeRequest
- SzSearchIncludeRequestDetails
The pre-defined SzFlag aggregate constants that use this group and are defined for "search" operations are:
The pre-defined SzFlag aggregate constants that also support this group for defining entity or record detail levels are:
- SzRecordDefaultFlags
- SzEntityIncludeAllRelations
- SzEntityDefaultFlags
- SzEntityBriefDefaultFlags
- SzVirtualEntityDefaultFlags