◆ ShareUsageBuilderBase() [1/2]
| fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.ShareUsageBuilderBase | ( | ILoggerFactory | loggerFactory | ) |
Constructor.
- Parameters
-
- loggerFactory - the ILoggerFactory to use when creating loggers for a ShareUsageBuilderBase
◆ ShareUsageBuilderBase() [2/2]
fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.ShareUsageBuilderBase ( ILoggerFactory loggerFactory, Logger logger ) Constructor.
- Parameters
-
- loggerFactory - the ILoggerFactory to use when creating loggers for a ShareUsageBuilderBase
- logger - the Logger to use for ShareUsageElement
Member Function Documentation
◆ build()
abstract T fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.build ( ) throws IOException abstractCreate the ShareUsageElement.
- Returns
- the newly created T>@throwsIOExceptioniftherewasanexceptioncreatingtheelement
◆ setAddTimeout()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setAddTimeout ( int milliseconds ) Set the timeout in milliseconds to allow when attempting to add an item to the queue.
If this timeout is exceeded then usage sharing will be disabled.
- Parameters
-
- milliseconds - timeout to set
- Returns
- this builder
◆ setBlockedHttpHeader()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setBlockedHttpHeader ( String blockedHeader ) Add a header to the (case insensitive) list of names of HTTP headers that will not be sent to 51Degrees.
Some headers, such as 'cookies' are hard-coded to be blocked regardless of this setting.
- Parameters
-
- blockedHeader - the name of the header to block
- Returns
- this builder
◆ setBlockedHttpHeaders()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setBlockedHttpHeaders ( List< String > blockedHeaders ) Set the (case insensitive) names of HTTP headers that will not be sent to 51Degrees.
Some headers, such as 'cookies' are hard-coded to be blocked regardless of this setting.
- Parameters
-
- blockedHeaders - the names of the headers to block
- Returns
- this builder
◆ setIgnoreFlowDataEvidenceFilter()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setIgnoreFlowDataEvidenceFilter ( String evidenceFilter ) Adds evidence key:values to the filter such that requests which contain this evidence are ignored.
- Parameters
-
- evidenceFilter - comma separated string containing evidence keys and evidence to ignore
- Returns
- this builder
◆ setIncludedQueryStringParameter()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setIncludedQueryStringParameter ( String queryStringParameterName ) Add a parameter name to the (case insensitive) list of names of query string parameters that will be sent to 51Degrees.
- Parameters
-
- queryStringParameterName - the name of the query string parameter to include
- Returns
- this builder
◆ setIncludedQueryStringParameters() [1/2]
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setIncludedQueryStringParameters ( List< String > queryStringParameterNames ) Add parameter names to the (case insensitive) list of names of query string parameters that will be sent to 51Degrees.
- Parameters
-
- queryStringParameterNames - the names of the query string parameter to include
- Returns
- this builder
◆ setIncludedQueryStringParameters() [2/2]
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setIncludedQueryStringParameters ( String queryStringParameterNames ) Add parameter names to the (case insensitive) list of names of query string parameters that will be sent to 51Degrees.
- Parameters
-
- queryStringParameterNames - a comma separated list of names of the query string parameter to include
- Returns
- this builder
◆ setMaximumQueueSize()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setMaximumQueueSize ( int size ) Set the maximum number of entries to be stored in the queue to be sent.
This must be more than the minimum entries per message.
- Parameters
-
- size - the size to set
- Returns
- this builder
◆ setMinimumEntriesPerMessage()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setMinimumEntriesPerMessage ( int minimumEntriesPerMessage ) Set the minimum number of entries to be aggregated by the ShareUsageElement before they are sent to the remote service.
- Parameters
-
- minimumEntriesPerMessage - the minimum number of entries to be aggregated by the ShareUsageElement before they are sent to the remote service
- Returns
- this builder
◆ setRepeatEvidenceIntervalMinutes()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setRepeatEvidenceIntervalMinutes ( int interval ) Set the interval which determines if a non-unique piece of evidence is repeat evidence or new.
- Parameters
-
- interval - the interval in minutes
- Returns
- this builder
◆ setSessionCookieName()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setSessionCookieName ( String cookieName ) Set the name of the cookie that contains the session id.
- Parameters
-
- cookieName - the name of the cookie that contains the session id
- Returns
- this builder
◆ setSharePercentage()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setSharePercentage ( double sharePercentage ) Set the percentage of data that the ShareUsageElement should be sharing.
- Parameters
-
- sharePercentage - the proportion of events sent to the pipeline that should be shared to 51Degrees. 1 = 100%, 0.5 = 50%, etc.
- Returns
- this builder
◆ setShareUsageUrl()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setShareUsageUrl ( String shareUsageUrl ) Set the URL to use when sharing usage data.
- Parameters
-
- shareUsageUrl - the URL to use when sharing usage data
- Returns
- this builder
◆ setTakeTimeout()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setTakeTimeout ( int milliseconds ) Set the timeout in milliseconds to allow when attempting to take an item from the queue in order to send to the remote service.
- Parameters
-
- milliseconds - timeout to set
- Returns
- this builder
◆ setShareUsageUrl()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setShareUsageUrl ( String shareUsageUrl ) Set the URL to use when sharing usage data.
- Parameters
-
- shareUsageUrl - the URL to use when sharing usage data
- Returns
- this builder
◆ setTakeTimeout()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setTakeTimeout ( int milliseconds ) Set the timeout in milliseconds to allow when attempting to take an item from the queue in order to send to the remote service.
- Parameters
-
- milliseconds - timeout to set
- Returns
- this builder
◆ setTrackSession()
ShareUsageBuilderBase<T> fiftyone.pipeline.engines.fiftyone.flowelements.ShareUsageBuilderBase< T >.setTrackSession ( boolean track ) Enable or disable session tracking.
- Parameters
-
- track - boolean value sets whether the usage element should track sessions
- Returns
- this builder