194 строки
12 KiB
YAML
194 строки
12 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.spring.cloud.feature.management.filters.TargetingFilter"
|
|
fullName: "com.azure.spring.cloud.feature.management.filters.TargetingFilter"
|
|
name: "TargetingFilter"
|
|
nameWithType: "TargetingFilter"
|
|
summary: "\\`Microsoft.<wbr>Targeting<wbr>Filter\\` enables evaluating a user/group/overall rollout of a feature."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **TargetingFilter**</br> implements <xref href=\"com.azure.spring.cloud.feature.management.filters.FeatureFilter?alt=com.azure.spring.cloud.feature.management.filters.FeatureFilter&text=FeatureFilter\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.TargetingFilter(com.azure.spring.cloud.feature.management.targeting.TargetingContextAccessor)"
|
|
fullName: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.TargetingFilter(TargetingContextAccessor contextAccessor)"
|
|
name: "TargetingFilter(TargetingContextAccessor contextAccessor)"
|
|
nameWithType: "TargetingFilter.TargetingFilter(TargetingContextAccessor contextAccessor)"
|
|
summary: "Filter for targeting a user/group/percentage of users."
|
|
parameters:
|
|
- description: "Accessor for identifying the current user/group when evaluating"
|
|
name: "contextAccessor"
|
|
type: "<xref href=\"com.azure.spring.cloud.feature.management.targeting.TargetingContextAccessor?alt=com.azure.spring.cloud.feature.management.targeting.TargetingContextAccessor&text=TargetingContextAccessor\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public TargetingFilter(TargetingContextAccessor contextAccessor)"
|
|
desc: "Filter for targeting a user/group/percentage of users."
|
|
- uid: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.TargetingFilter(com.azure.spring.cloud.feature.management.targeting.TargetingContextAccessor,com.azure.spring.cloud.feature.management.targeting.TargetingEvaluationOptions)"
|
|
fullName: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.TargetingFilter(TargetingContextAccessor contextAccessor, TargetingEvaluationOptions options)"
|
|
name: "TargetingFilter(TargetingContextAccessor contextAccessor, TargetingEvaluationOptions options)"
|
|
nameWithType: "TargetingFilter.TargetingFilter(TargetingContextAccessor contextAccessor, TargetingEvaluationOptions options)"
|
|
summary: "\\`Microsoft.<wbr>Targeting<wbr>Filter\\` evaluates a user/group/overall rollout of a feature."
|
|
parameters:
|
|
- description: "Context for evaluating the users/groups."
|
|
name: "contextAccessor"
|
|
type: "<xref href=\"com.azure.spring.cloud.feature.management.targeting.TargetingContextAccessor?alt=com.azure.spring.cloud.feature.management.targeting.TargetingContextAccessor&text=TargetingContextAccessor\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "enables customization of the filter."
|
|
name: "options"
|
|
type: "<xref href=\"com.azure.spring.cloud.feature.management.targeting.TargetingEvaluationOptions?alt=com.azure.spring.cloud.feature.management.targeting.TargetingEvaluationOptions&text=TargetingEvaluationOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public TargetingFilter(TargetingContextAccessor contextAccessor, TargetingEvaluationOptions options)"
|
|
desc: "\\`Microsoft.TargetingFilter\\` evaluates a user/group/overall rollout of a feature."
|
|
fields:
|
|
- uid: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.AUDIENCE"
|
|
fullName: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.AUDIENCE"
|
|
name: "AUDIENCE"
|
|
nameWithType: "TargetingFilter.AUDIENCE"
|
|
summary: "Audience in the filter"
|
|
modifiers:
|
|
- "protected"
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "Audience"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "protected static final String AUDIENCE"
|
|
desc: "Audience in the filter"
|
|
- uid: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.EXCLUSION"
|
|
fullName: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.EXCLUSION"
|
|
name: "EXCLUSION"
|
|
nameWithType: "TargetingFilter.EXCLUSION"
|
|
summary: "Audience that always returns false"
|
|
modifiers:
|
|
- "protected"
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "exclusion"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "protected static final String EXCLUSION"
|
|
desc: "Audience that always returns false"
|
|
- uid: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.GROUPS"
|
|
fullName: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.GROUPS"
|
|
name: "GROUPS"
|
|
nameWithType: "TargetingFilter.GROUPS"
|
|
summary: "groups field in the filter"
|
|
modifiers:
|
|
- "protected"
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "Groups"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "protected static final String GROUPS"
|
|
desc: "groups field in the filter"
|
|
- uid: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.OBJECT_MAPPER"
|
|
fullName: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.OBJECT_MAPPER"
|
|
name: "OBJECT_MAPPER"
|
|
nameWithType: "TargetingFilter.OBJECT_MAPPER"
|
|
summary: "Object Mapper for converting configurations to features"
|
|
modifiers:
|
|
- "protected"
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.fasterxml.jackson.databind.ObjectMapper?alt=com.fasterxml.jackson.databind.ObjectMapper&text=ObjectMapper\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected static final ObjectMapper OBJECT_MAPPER"
|
|
desc: "Object Mapper for converting configurations to features"
|
|
- uid: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.OUT_OF_RANGE"
|
|
fullName: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.OUT_OF_RANGE"
|
|
name: "OUT_OF_RANGE"
|
|
nameWithType: "TargetingFilter.OUT_OF_RANGE"
|
|
summary: "Error message for when the total Audience value is greater than 100 percent."
|
|
modifiers:
|
|
- "protected"
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "The value is out of the accepted range."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "protected static final String OUT_OF_RANGE"
|
|
desc: "Error message for when the total Audience value is greater than 100 percent."
|
|
- uid: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.USERS"
|
|
fullName: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.USERS"
|
|
name: "USERS"
|
|
nameWithType: "TargetingFilter.USERS"
|
|
summary: "users field in the filter"
|
|
modifiers:
|
|
- "protected"
|
|
- "static"
|
|
- "final"
|
|
field:
|
|
value: "Users"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "protected static final String USERS"
|
|
desc: "users field in the filter"
|
|
- uid: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.contextAccessor"
|
|
fullName: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.contextAccessor"
|
|
name: "contextAccessor"
|
|
nameWithType: "TargetingFilter.contextAccessor"
|
|
summary: "Accessor for identifying the current user/group when evaluating"
|
|
modifiers:
|
|
- "protected"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.spring.cloud.feature.management.targeting.TargetingContextAccessor?alt=com.azure.spring.cloud.feature.management.targeting.TargetingContextAccessor&text=TargetingContextAccessor\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected final TargetingContextAccessor contextAccessor"
|
|
desc: "Accessor for identifying the current user/group when evaluating"
|
|
- uid: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.options"
|
|
fullName: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.options"
|
|
name: "options"
|
|
nameWithType: "TargetingFilter.options"
|
|
summary: "Options for evaluating the filter"
|
|
modifiers:
|
|
- "protected"
|
|
- "final"
|
|
field:
|
|
type: "<xref href=\"com.azure.spring.cloud.feature.management.targeting.TargetingEvaluationOptions?alt=com.azure.spring.cloud.feature.management.targeting.TargetingEvaluationOptions&text=TargetingEvaluationOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "protected final TargetingEvaluationOptions options"
|
|
desc: "Options for evaluating the filter"
|
|
methods:
|
|
- uid: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.evaluate(com.azure.spring.cloud.feature.management.models.FeatureFilterEvaluationContext)"
|
|
fullName: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.evaluate(FeatureFilterEvaluationContext context)"
|
|
name: "evaluate(FeatureFilterEvaluationContext context)"
|
|
nameWithType: "TargetingFilter.evaluate(FeatureFilterEvaluationContext context)"
|
|
summary: "Evaluates if the filter is on or off."
|
|
parameters:
|
|
- name: "context"
|
|
type: "<xref href=\"com.azure.spring.cloud.feature.management.models.FeatureFilterEvaluationContext?alt=com.azure.spring.cloud.feature.management.models.FeatureFilterEvaluationContext&text=FeatureFilterEvaluationContext\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public boolean evaluate(FeatureFilterEvaluationContext context)"
|
|
desc: "Evaluates if the filter is on or off. Returning true results in Feature evaluation ending and returning true. Returning false results in the next Feature evaluation to continue."
|
|
returns:
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.isTargetedPercentage(java.lang.String)"
|
|
fullName: "com.azure.spring.cloud.feature.management.filters.TargetingFilter.isTargetedPercentage(String contextId)"
|
|
name: "isTargetedPercentage(String contextId)"
|
|
nameWithType: "TargetingFilter.isTargetedPercentage(String contextId)"
|
|
summary: "Computes the percentage that the context<wbr>Id falls into."
|
|
modifiers:
|
|
- "protected"
|
|
parameters:
|
|
- description: "Id of the context being targeted"
|
|
name: "contextId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "protected double isTargetedPercentage(String contextId)"
|
|
desc: "Computes the percentage that the contextId falls into."
|
|
returns:
|
|
description: "the bucket value of the context id"
|
|
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "\\`Microsoft.TargetingFilter\\` enables evaluating a user/group/overall rollout of a feature."
|
|
implements:
|
|
- "<xref href=\"com.azure.spring.cloud.feature.management.filters.FeatureFilter?alt=com.azure.spring.cloud.feature.management.filters.FeatureFilter&text=FeatureFilter\" data-throw-if-not-resolved=\"False\" />"
|
|
metadata: {}
|
|
package: "com.azure.spring.cloud.feature.management.filters"
|
|
artifact: com.azure.spring:spring-cloud-azure-feature-management:5.18.0
|