• Api Documentation
Show / Hide Table of Contents
  • Si.Srp.Api.Common.Model
    • GreekSearchApiResponse
    • GreekSearchWrapper
    • IdAtVersion
    • IdSearchResponse
    • Links
    • ProductSearchApiResponse
    • ProductSearchWrapper
    • User
  • Si.Srp.Models.Common
    • ActualEstimated
    • AsianDate
    • BarrierFrequency
    • BonusType
    • BrochureType
    • Categories
    • Classification
    • CompanyType
    • CouponType
    • CurrencyCode
    • DirectionParticipation
    • DirectionTrade
    • DistributionChannels
    • EnumEntity
    • ExerciseType
    • FileType
    • Frequency
    • PayoffStyles
    • ProductGroup
    • RatingAgency
    • RatingValue
    • RedemptionType
    • Region
    • Style
    • TaxStatuses
    • Type
    • User
    • ValidationConst
    • WrapperGroupName
  • Si.Srp.Models.Common.DTO
    • PaginationWrapper<TType>
  • Si.Srp.Models.Common.Response
    • Diagnostics
    • ResponseError
    • Status
  • Si.Srp.Models.Greeks.Enums
    • EntityType
    • GreekType
    • Outcome
  • Si.Srp.Models.Greeks.External.API
    • Greeks
    • SearchResponse
    • UnderlyingGreek
    • UnderlyingGreekMarket
    • UnderlyingGreekProduct
    • UnderlyingGreekVersus<TType>
    • UnderlyingGreekVersusBarrier
    • UnderlyingGreekVersusTime
  • Si.Srp.Models.Greeks.External.API.Facet
    • Facet
    • FacetResult
    • FacetValue
  • Si.Srp.Models.Greeks.Request
    • UnderlyingGreekSearch
    • UnderlyingGreekSearchRequest
  • Si.Srp.Models.Read
    • Amount
    • Amounts
    • AnnuityBonus
    • AnnuitySpread
    • AsianOption
    • AssetClass
    • Autocall
    • Barrier
    • Brochure
    • CapitalReturn
    • Commission
    • CouponBase
    • CreditRating
    • DerivativeCounterparty
    • Description
    • DigitalCoupon
    • Distributor
    • Exchange
    • Exercise
    • Expiry
    • FixedCoupon
    • GroupedStrongEntity
    • Identifiers
    • Issuer
    • Market
    • MaxPayout
    • Participation
    • ParticipationCap
    • PayoffType
    • Product
    • ProductLine
    • RangeCoupon
    • Rider
    • StrongEntity
    • ThirdpartyDistributor
    • Underlying
    • UnderlyingProvider
    • Valuation
    • Volume
    • Wrapper
  • Si.Srp.Models.Search.Facet
    • Facet
    • FacetResult
    • FacetValue
  • Si.Srp.Models.Search.Request
    • ContinuedProductSearch
    • CreateProductSearch
    • FacetOptions
    • ProductSearchBase
    • ProductSearchRequest
    • SearchOperator
    • SearchType
    • UserRestrictions
  • Si.Srp.Models.Search.Response
    • CreateSearchResponse
    • Direction
    • ElasticsearchResponse<TType>
    • FieldName
    • HasFields
    • ProductResult
    • RawSearchResponse
    • SearchResponse
    • SortField

Class FacetOptions

Represents the options for facet generation

Constructors

FacetOptions()

Declaration
public FacetOptions()

Properties

BlacklistRegex

A regex that may be used to negatively filter the facet values

Declaration
public string BlacklistRegex { get; set; }
Property Value
Type Description
System.String

BlacklistText

Text that may be used to negatively filter the facet values

Declaration
public string BlacklistText { get; set; }
Property Value
Type Description
System.String

FacetTopN

The number of top facet results, limited to 1k

Declaration
public int FacetTopN { get; set; }
Property Value
Type Description
System.Int32

ShowAnnuityBonusFrequency

True if the Annuity Bonus Frequency facets should be generated

Declaration
public bool ShowAnnuityBonusFrequency { get; set; }
Property Value
Type Description
System.Boolean

ShowAnnuityBonusType

True if all Annuity Bonus Type facets should be generated

Declaration
public bool ShowAnnuityBonusType { get; set; }
Property Value
Type Description
System.Boolean

ShowAsianOption

True if all Asian Option facets should be generated

Declaration
public bool ShowAsianOption { get; set; }
Property Value
Type Description
System.Boolean

ShowAsianOptionDateType

True if the Asian Option Date Type facets should be generated

Declaration
public bool ShowAsianOptionDateType { get; set; }
Property Value
Type Description
System.Boolean

ShowAsianOptionFrequency

True if the Asian Option Frequency facets should be generated

Declaration
public bool ShowAsianOptionFrequency { get; set; }
Property Value
Type Description
System.Boolean

ShowAssetClasses

True if the AssetClass facets should be generated

Declaration
public bool ShowAssetClasses { get; set; }
Property Value
Type Description
System.Boolean

ShowAutoCallFrequency

True if the Auto call facets should be generated

Declaration
public bool ShowAutoCallFrequency { get; set; }
Property Value
Type Description
System.Boolean

ShowBarrier

True if the Barrier facets should be generated

Declaration
public bool ShowBarrier { get; set; }
Property Value
Type Description
System.Boolean

ShowCallPutFrequency

True if the Call put facets should be generated

Declaration
public bool ShowCallPutFrequency { get; set; }
Property Value
Type Description
System.Boolean

ShowCapitalReturn

True if the Capital Return facets should be generated

Declaration
public bool ShowCapitalReturn { get; set; }
Property Value
Type Description
System.Boolean

ShowCategories

True if the Categories facets should be generated

Declaration
public bool ShowCategories { get; set; }
Property Value
Type Description
System.Boolean

ShowClass

True if the Class facets should be generated

Declaration
public bool ShowClass { get; set; }
Property Value
Type Description
System.Boolean

ShowCollectionCounts

Shows the counts of list properties

Declaration
public bool ShowCollectionCounts { get; set; }
Property Value
Type Description
System.Boolean

ShowCoupon

True if all Coupon facets should be generated

Declaration
public bool ShowCoupon { get; set; }
Property Value
Type Description
System.Boolean

ShowCouponBarrierObservationFrequency

True if the Coupon Barrier Observation Frequency facets should be generated

Declaration
public bool ShowCouponBarrierObservationFrequency { get; set; }
Property Value
Type Description
System.Boolean

ShowCouponObservationFrequency

True if the Coupon Observation Frequency facets should be generated

Declaration
public bool ShowCouponObservationFrequency { get; set; }
Property Value
Type Description
System.Boolean

ShowCouponPaymentFrequency

True if the Coupon Payment Frequency facets should be generated

Declaration
public bool ShowCouponPaymentFrequency { get; set; }
Property Value
Type Description
System.Boolean

ShowCouponType

True if the Coupon Type facets should be generated

Declaration
public bool ShowCouponType { get; set; }
Property Value
Type Description
System.Boolean

ShowCurrencies

True if the Currencies facets should be generated

Declaration
public bool ShowCurrencies { get; set; }
Property Value
Type Description
System.Boolean

ShowDerivativeCounterparty

True if all DerivativeCounterparty facets should be generated

Declaration
public bool ShowDerivativeCounterparty { get; set; }
Property Value
Type Description
System.Boolean

ShowDerivativeCounterpartyId

True if the DerivativeCounterparty Id facets should be generated

Declaration
public bool ShowDerivativeCounterpartyId { get; set; }
Property Value
Type Description
System.Boolean

ShowDerivativeCounterpartyType

True if the DerivativeCounterparty Type facets should be generated

Declaration
public bool ShowDerivativeCounterpartyType { get; set; }
Property Value
Type Description
System.Boolean

ShowDirectionTrade

True if the Direction Trade facets should be generated

Declaration
public bool ShowDirectionTrade { get; set; }
Property Value
Type Description
System.Boolean

ShowDistributionChannels

True if the DistributionChannels facets should be generated

Declaration
public bool ShowDistributionChannels { get; set; }
Property Value
Type Description
System.Boolean

ShowDistributor

True if the Distributor facets should be generated

Declaration
public bool ShowDistributor { get; set; }
Property Value
Type Description
System.Boolean

ShowExchange

True if the Exchange facets should be generated

Declaration
public bool ShowExchange { get; set; }
Property Value
Type Description
System.Boolean

ShowExpiry

True if the Expiry facets should be generated

Declaration
public bool ShowExpiry { get; set; }
Property Value
Type Description
System.Boolean

ShowInterestCreditPeriod

True if the Interest Credit Period facets should be generated

Declaration
public bool ShowInterestCreditPeriod { get; set; }
Property Value
Type Description
System.Boolean

ShowIssuer

True if all Issuer facets should be generated

Declaration
public bool ShowIssuer { get; set; }
Property Value
Type Description
System.Boolean

ShowIssuerCreditRating

True if all Issuer Credit Rating facets should be generated

Declaration
public bool ShowIssuerCreditRating { get; set; }
Property Value
Type Description
System.Boolean

ShowIssuerCreditRatingAgency

True if the Issuer Credit Rating Agency facets should be generated

Declaration
public bool ShowIssuerCreditRatingAgency { get; set; }
Property Value
Type Description
System.Boolean

ShowIssuerCreditRatingValue

True if the Issuer Credit Rating Value facets should be generated

Declaration
public bool ShowIssuerCreditRatingValue { get; set; }
Property Value
Type Description
System.Boolean

ShowIssuerGroup

True if the Issuer Group facets should be generated

Declaration
public bool ShowIssuerGroup { get; set; }
Property Value
Type Description
System.Boolean

ShowIssuerId

True if the Issuer id facets should be generated

Declaration
public bool ShowIssuerId { get; set; }
Property Value
Type Description
System.Boolean

ShowIssuerType

True if the Issuer Type facets should be generated

Declaration
public bool ShowIssuerType { get; set; }
Property Value
Type Description
System.Boolean

ShowMarket

True if all Market facets should be generated

Declaration
public bool ShowMarket { get; set; }
Property Value
Type Description
System.Boolean

ShowMarketDistributorGroup

True if the Market Distributor Group facets should be generated

Declaration
public bool ShowMarketDistributorGroup { get; set; }
Property Value
Type Description
System.Boolean

ShowMarketDistributorId

True if the Market Distributor Id facets should be generated

Declaration
public bool ShowMarketDistributorId { get; set; }
Property Value
Type Description
System.Boolean

ShowMarketDistributorType

True if the Market Distributor Type facets should be generated

Declaration
public bool ShowMarketDistributorType { get; set; }
Property Value
Type Description
System.Boolean

ShowMarketDistributorVolumeType

True if the Market Distributor Volume Type facets should be generated

Declaration
public bool ShowMarketDistributorVolumeType { get; set; }
Property Value
Type Description
System.Boolean

ShowMarketId

True if the Market Id facets should be generated

Declaration
public bool ShowMarketId { get; set; }
Property Value
Type Description
System.Boolean

ShowMarketRegion

True if the Market Region facets should be generated

Declaration
public bool ShowMarketRegion { get; set; }
Property Value
Type Description
System.Boolean

ShowOnlyAnnuityBonusType

True if the Annuity Bonus Type facets should be generated

Declaration
public bool ShowOnlyAnnuityBonusType { get; set; }
Property Value
Type Description
System.Boolean

ShowParticipations

True if the Participations facets should be generated

Declaration
public bool ShowParticipations { get; set; }
Property Value
Type Description
System.Boolean

ShowPayoffs

True if the Payoffs facets should be generated

Declaration
public bool ShowPayoffs { get; set; }
Property Value
Type Description
System.Boolean

ShowPayoffStyle

True if the PayoffStyle facets should be generated

Declaration
public bool ShowPayoffStyle { get; set; }
Property Value
Type Description
System.Boolean

ShowProductGroups

True if the ProductGroup facets should be generated

Declaration
public bool ShowProductGroups { get; set; }
Property Value
Type Description
System.Boolean

ShowProductLines

True if the Product Lines facets should be generated

Declaration
public bool ShowProductLines { get; set; }
Property Value
Type Description
System.Boolean

ShowSalesVolume

True if the Sales Volume facets should be generated

Declaration
public bool ShowSalesVolume { get; set; }
Property Value
Type Description
System.Boolean

ShowStyle

True if the Style facets should be generated

Declaration
public bool ShowStyle { get; set; }
Property Value
Type Description
System.Boolean

ShowTaxStatus

True if the Tax Status facets should be generated

Declaration
public bool ShowTaxStatus { get; set; }
Property Value
Type Description
System.Boolean

ShowThirdPartyDistributor

True if all ThirdPartyDistributor facets should be generated

Declaration
public bool ShowThirdPartyDistributor { get; set; }
Property Value
Type Description
System.Boolean

ShowThirdPartyDistributorId

True if the ThirdPartyDistributor Id facets should be generated

Declaration
public bool ShowThirdPartyDistributorId { get; set; }
Property Value
Type Description
System.Boolean

ShowThirdPartyDistributorType

True if the ThirdPartyDistributor Type facets should be generated

Declaration
public bool ShowThirdPartyDistributorType { get; set; }
Property Value
Type Description
System.Boolean

ShowTypes

True if the Types facets should be generated

Declaration
public bool ShowTypes { get; set; }
Property Value
Type Description
System.Boolean

ShowUnderlying

True if all Underlying facets should be generated

Declaration
public bool ShowUnderlying { get; set; }
Property Value
Type Description
System.Boolean

ShowUnderlyingGroup

True if the Underlying Group facets should be generated

Declaration
public bool ShowUnderlyingGroup { get; set; }
Property Value
Type Description
System.Boolean

ShowUnderlyingId

True if the Underlying Id facets should be generated

Declaration
public bool ShowUnderlyingId { get; set; }
Property Value
Type Description
System.Boolean

ShowUnderlyingInstrument

True if the Underlying Instrument facets should be generated

Declaration
public bool ShowUnderlyingInstrument { get; set; }
Property Value
Type Description
System.Boolean

ShowUnderlyingInstrumentGroup

True if the Underlying Instrument Group facets should be generated

Declaration
public bool ShowUnderlyingInstrumentGroup { get; set; }
Property Value
Type Description
System.Boolean

ShowUnderlyingProvider

True if the Underlying Provider facets should be generated

Declaration
public bool ShowUnderlyingProvider { get; set; }
Property Value
Type Description
System.Boolean

ShowUnderlyingProviderType

True if the Underlying Provider Type facets should be generated

Declaration
public bool ShowUnderlyingProviderType { get; set; }
Property Value
Type Description
System.Boolean

ShowUnderlyingSector

True if the Underlying Sector facets should be generated

Declaration
public bool ShowUnderlyingSector { get; set; }
Property Value
Type Description
System.Boolean

ShowUnderlyingSectorGroup

True if the Underlying Sector Group facets should be generated

Declaration
public bool ShowUnderlyingSectorGroup { get; set; }
Property Value
Type Description
System.Boolean

ShowWrapper

True if all Wrapper facets should be generated

Declaration
public bool ShowWrapper { get; set; }
Property Value
Type Description
System.Boolean

ShowWrapperGroup

True if the Wrapper Group facets should be generated

Declaration
public bool ShowWrapperGroup { get; set; }
Property Value
Type Description
System.Boolean

ShowWrapperId

True if the Wrapper Id facets should be generated

Declaration
public bool ShowWrapperId { get; set; }
Property Value
Type Description
System.Boolean

WhitelistRegex

A regex that may be used to positively filter the facet values

Declaration
public string WhitelistRegex { get; set; }
Property Value
Type Description
System.String

WhitelistText

Text that may be used to positively filter the facet values

Declaration
public string WhitelistText { get; set; }
Property Value
Type Description
System.String
In This Article
Back to top Generated by DocFX