CustomEntity.java

  1. // Copyright (c) Microsoft Corporation. All rights reserved.
  2. // Licensed under the MIT License.
  3. //
  4. // Code generated by Microsoft (R) AutoRest Code Generator.
  5. // Changes may cause incorrect behavior and will be lost if the code is
  6. // regenerated.

  8. package com.azure.search.documents.indexes.models;

  10. import com.azure.core.annotation.Fluent;
  11. import com.fasterxml.jackson.annotation.JsonCreator;
  12. import com.fasterxml.jackson.annotation.JsonProperty;
  13. import java.util.List;

  15. /** An object that contains information about the matches that were found, and related metadata. */
  16. @Fluent
  17. public final class CustomEntity {
  18.     /*
  19.      * The top-level entity descriptor. Matches in the skill output will be
  20.      * grouped by this name, and it should represent the "normalized" form of
  21.      * the text being found.
  22.      */
  23.     @JsonProperty(value = "name", required = true)
  24.     private String name;

  26.     /*
  27.      * This field can be used as a passthrough for custom metadata about the
  28.      * matched text(s). The value of this field will appear with every match of
  29.      * its entity in the skill output.
  30.      */
  31.     @JsonProperty(value = "description")
  32.     private String description;

  34.     /*
  35.      * This field can be used as a passthrough for custom metadata about the
  36.      * matched text(s). The value of this field will appear with every match of
  37.      * its entity in the skill output.
  38.      */
  39.     @JsonProperty(value = "type")
  40.     private String type;

  42.     /*
  43.      * This field can be used as a passthrough for custom metadata about the
  44.      * matched text(s). The value of this field will appear with every match of
  45.      * its entity in the skill output.
  46.      */
  47.     @JsonProperty(value = "subtype")
  48.     private String subtype;

  50.     /*
  51.      * This field can be used as a passthrough for custom metadata about the
  52.      * matched text(s). The value of this field will appear with every match of
  53.      * its entity in the skill output.
  54.      */
  55.     @JsonProperty(value = "id")
  56.     private String id;

  58.     /*
  59.      * Defaults to false. Boolean value denoting whether comparisons with the
  60.      * entity name should be sensitive to character casing. Sample case
  61.      * insensitive matches of "Microsoft" could be: microsoft, microSoft,
  62.      * MICROSOFT.
  63.      */
  64.     @JsonProperty(value = "caseSensitive")
  65.     private Boolean caseSensitive;

  67.     /*
  68.      * Defaults to false. Boolean value denoting whether comparisons with the
  69.      * entity name should be sensitive to accent.
  70.      */
  71.     @JsonProperty(value = "accentSensitive")
  72.     private Boolean accentSensitive;

  74.     /*
  75.      * Defaults to 0. Maximum value of 5. Denotes the acceptable number of
  76.      * divergent characters that would still constitute a match with the entity
  77.      * name. The smallest possible fuzziness for any given match is returned.
  78.      * For instance, if the edit distance is set to 3, "Windows10" would still
  79.      * match "Windows", "Windows10" and "Windows 7". When case sensitivity is
  80.      * set to false, case differences do NOT count towards fuzziness tolerance,
  81.      * but otherwise do.
  82.      */
  83.     @JsonProperty(value = "fuzzyEditDistance")
  84.     private Integer fuzzyEditDistance;

  86.     /*
  87.      * Changes the default case sensitivity value for this entity. It be used
  88.      * to change the default value of all aliases caseSensitive values.
  89.      */
  90.     @JsonProperty(value = "defaultCaseSensitive")
  91.     private Boolean defaultCaseSensitive;

  93.     /*
  94.      * Changes the default accent sensitivity value for this entity. It be used
  95.      * to change the default value of all aliases accentSensitive values.
  96.      */
  97.     @JsonProperty(value = "defaultAccentSensitive")
  98.     private Boolean defaultAccentSensitive;

  100.     /*
  101.      * Changes the default fuzzy edit distance value for this entity. It can be
  102.      * used to change the default value of all aliases fuzzyEditDistance
  103.      * values.
  104.      */
  105.     @JsonProperty(value = "defaultFuzzyEditDistance")
  106.     private Integer defaultFuzzyEditDistance;

  108.     /*
  109.      * An array of complex objects that can be used to specify alternative
  110.      * spellings or synonyms to the root entity name.
  111.      */
  112.     @JsonProperty(value = "aliases")
  113.     private List<CustomEntityAlias> aliases;

  115.     /**
  116.      * Creates an instance of CustomEntity class.
  117.      *
  118.      * @param name the name value to set.
  119.      */
  120.     @JsonCreator
  121.     public CustomEntity(@JsonProperty(value = "name", required = true) String name) {
  122.         this.name = name;
  123.     }

  125.     /**
  126.      * Get the name property: The top-level entity descriptor. Matches in the skill output will be grouped by this name,
  127.      * and it should represent the "normalized" form of the text being found.
  128.      *
  129.      * @return the name value.
  130.      */
  131.     public String getName() {
  132.         return this.name;
  133.     }

  135.     /**
  136.      * Get the description property: This field can be used as a passthrough for custom metadata about the matched
  137.      * text(s). The value of this field will appear with every match of its entity in the skill output.
  138.      *
  139.      * @return the description value.
  140.      */
  141.     public String getDescription() {
  142.         return this.description;
  143.     }

  145.     /**
  146.      * Set the description property: This field can be used as a passthrough for custom metadata about the matched
  147.      * text(s). The value of this field will appear with every match of its entity in the skill output.
  148.      *
  149.      * @param description the description value to set.
  150.      * @return the CustomEntity object itself.
  151.      */
  152.     public CustomEntity setDescription(String description) {
  153.         this.description = description;
  154.         return this;
  155.     }

  157.     /**
  158.      * Get the type property: This field can be used as a passthrough for custom metadata about the matched text(s). The
  159.      * value of this field will appear with every match of its entity in the skill output.
  160.      *
  161.      * @return the type value.
  162.      */
  163.     public String getType() {
  164.         return this.type;
  165.     }

  167.     /**
  168.      * Set the type property: This field can be used as a passthrough for custom metadata about the matched text(s). The
  169.      * value of this field will appear with every match of its entity in the skill output.
  170.      *
  171.      * @param type the type value to set.
  172.      * @return the CustomEntity object itself.
  173.      */
  174.     public CustomEntity setType(String type) {
  175.         this.type = type;
  176.         return this;
  177.     }

  179.     /**
  180.      * Get the subtype property: This field can be used as a passthrough for custom metadata about the matched text(s).
  181.      * The value of this field will appear with every match of its entity in the skill output.
  182.      *
  183.      * @return the subtype value.
  184.      */
  185.     public String getSubtype() {
  186.         return this.subtype;
  187.     }

  189.     /**
  190.      * Set the subtype property: This field can be used as a passthrough for custom metadata about the matched text(s).
  191.      * The value of this field will appear with every match of its entity in the skill output.
  192.      *
  193.      * @param subtype the subtype value to set.
  194.      * @return the CustomEntity object itself.
  195.      */
  196.     public CustomEntity setSubtype(String subtype) {
  197.         this.subtype = subtype;
  198.         return this;
  199.     }

  201.     /**
  202.      * Get the id property: This field can be used as a passthrough for custom metadata about the matched text(s). The
  203.      * value of this field will appear with every match of its entity in the skill output.
  204.      *
  205.      * @return the id value.
  206.      */
  207.     public String getId() {
  208.         return this.id;
  209.     }

  211.     /**
  212.      * Set the id property: This field can be used as a passthrough for custom metadata about the matched text(s). The
  213.      * value of this field will appear with every match of its entity in the skill output.
  214.      *
  215.      * @param id the id value to set.
  216.      * @return the CustomEntity object itself.
  217.      */
  218.     public CustomEntity setId(String id) {
  219.         this.id = id;
  220.         return this;
  221.     }

  223.     /**
  224.      * Get the caseSensitive property: Defaults to false. Boolean value denoting whether comparisons with the entity
  225.      * name should be sensitive to character casing. Sample case insensitive matches of "Microsoft" could be: microsoft,
  226.      * microSoft, MICROSOFT.
  227.      *
  228.      * @return the caseSensitive value.
  229.      */
  230.     public Boolean isCaseSensitive() {
  231.         return this.caseSensitive;
  232.     }

  234.     /**
  235.      * Set the caseSensitive property: Defaults to false. Boolean value denoting whether comparisons with the entity
  236.      * name should be sensitive to character casing. Sample case insensitive matches of "Microsoft" could be: microsoft,
  237.      * microSoft, MICROSOFT.
  238.      *
  239.      * @param caseSensitive the caseSensitive value to set.
  240.      * @return the CustomEntity object itself.
  241.      */
  242.     public CustomEntity setCaseSensitive(Boolean caseSensitive) {
  243.         this.caseSensitive = caseSensitive;
  244.         return this;
  245.     }

  247.     /**
  248.      * Get the accentSensitive property: Defaults to false. Boolean value denoting whether comparisons with the entity
  249.      * name should be sensitive to accent.
  250.      *
  251.      * @return the accentSensitive value.
  252.      */
  253.     public Boolean isAccentSensitive() {
  254.         return this.accentSensitive;
  255.     }

  257.     /**
  258.      * Set the accentSensitive property: Defaults to false. Boolean value denoting whether comparisons with the entity
  259.      * name should be sensitive to accent.
  260.      *
  261.      * @param accentSensitive the accentSensitive value to set.
  262.      * @return the CustomEntity object itself.
  263.      */
  264.     public CustomEntity setAccentSensitive(Boolean accentSensitive) {
  265.         this.accentSensitive = accentSensitive;
  266.         return this;
  267.     }

  269.     /**
  270.      * Get the fuzzyEditDistance property: Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent
  271.      * characters that would still constitute a match with the entity name. The smallest possible fuzziness for any
  272.      * given match is returned. For instance, if the edit distance is set to 3, "Windows10" would still match "Windows",
  273.      * "Windows10" and "Windows 7". When case sensitivity is set to false, case differences do NOT count towards
  274.      * fuzziness tolerance, but otherwise do.
  275.      *
  276.      * @return the fuzzyEditDistance value.
  277.      */
  278.     public Integer getFuzzyEditDistance() {
  279.         return this.fuzzyEditDistance;
  280.     }

  282.     /**
  283.      * Set the fuzzyEditDistance property: Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent
  284.      * characters that would still constitute a match with the entity name. The smallest possible fuzziness for any
  285.      * given match is returned. For instance, if the edit distance is set to 3, "Windows10" would still match "Windows",
  286.      * "Windows10" and "Windows 7". When case sensitivity is set to false, case differences do NOT count towards
  287.      * fuzziness tolerance, but otherwise do.
  288.      *
  289.      * @param fuzzyEditDistance the fuzzyEditDistance value to set.
  290.      * @return the CustomEntity object itself.
  291.      */
  292.     public CustomEntity setFuzzyEditDistance(Integer fuzzyEditDistance) {
  293.         this.fuzzyEditDistance = fuzzyEditDistance;
  294.         return this;
  295.     }

  297.     /**
  298.      * Get the defaultCaseSensitive property: Changes the default case sensitivity value for this entity. It be used to
  299.      * change the default value of all aliases caseSensitive values.
  300.      *
  301.      * @return the defaultCaseSensitive value.
  302.      */
  303.     public Boolean isDefaultCaseSensitive() {
  304.         return this.defaultCaseSensitive;
  305.     }

  307.     /**
  308.      * Set the defaultCaseSensitive property: Changes the default case sensitivity value for this entity. It be used to
  309.      * change the default value of all aliases caseSensitive values.
  310.      *
  311.      * @param defaultCaseSensitive the defaultCaseSensitive value to set.
  312.      * @return the CustomEntity object itself.
  313.      */
  314.     public CustomEntity setDefaultCaseSensitive(Boolean defaultCaseSensitive) {
  315.         this.defaultCaseSensitive = defaultCaseSensitive;
  316.         return this;
  317.     }

  319.     /**
  320.      * Get the defaultAccentSensitive property: Changes the default accent sensitivity value for this entity. It be used
  321.      * to change the default value of all aliases accentSensitive values.
  322.      *
  323.      * @return the defaultAccentSensitive value.
  324.      */
  325.     public Boolean isDefaultAccentSensitive() {
  326.         return this.defaultAccentSensitive;
  327.     }

  329.     /**
  330.      * Set the defaultAccentSensitive property: Changes the default accent sensitivity value for this entity. It be used
  331.      * to change the default value of all aliases accentSensitive values.
  332.      *
  333.      * @param defaultAccentSensitive the defaultAccentSensitive value to set.
  334.      * @return the CustomEntity object itself.
  335.      */
  336.     public CustomEntity setDefaultAccentSensitive(Boolean defaultAccentSensitive) {
  337.         this.defaultAccentSensitive = defaultAccentSensitive;
  338.         return this;
  339.     }

  341.     /**
  342.      * Get the defaultFuzzyEditDistance property: Changes the default fuzzy edit distance value for this entity. It can
  343.      * be used to change the default value of all aliases fuzzyEditDistance values.
  344.      *
  345.      * @return the defaultFuzzyEditDistance value.
  346.      */
  347.     public Integer getDefaultFuzzyEditDistance() {
  348.         return this.defaultFuzzyEditDistance;
  349.     }

  351.     /**
  352.      * Set the defaultFuzzyEditDistance property: Changes the default fuzzy edit distance value for this entity. It can
  353.      * be used to change the default value of all aliases fuzzyEditDistance values.
  354.      *
  355.      * @param defaultFuzzyEditDistance the defaultFuzzyEditDistance value to set.
  356.      * @return the CustomEntity object itself.
  357.      */
  358.     public CustomEntity setDefaultFuzzyEditDistance(Integer defaultFuzzyEditDistance) {
  359.         this.defaultFuzzyEditDistance = defaultFuzzyEditDistance;
  360.         return this;
  361.     }

  363.     /**
  364.      * Get the aliases property: An array of complex objects that can be used to specify alternative spellings or
  365.      * synonyms to the root entity name.
  366.      *
  367.      * @return the aliases value.
  368.      */
  369.     public List<CustomEntityAlias> getAliases() {
  370.         return this.aliases;
  371.     }

  373.     /**
  374.      * Set the aliases property: An array of complex objects that can be used to specify alternative spellings or
  375.      * synonyms to the root entity name.
  376.      *
  377.      * @param aliases the aliases value to set.
  378.      * @return the CustomEntity object itself.
  379.      */
  380.     public CustomEntity setAliases(List<CustomEntityAlias> aliases) {
  381.         this.aliases = aliases;
  382.         return this;
  383.     }
  384. }
Created with JaCoCo 0.8.7.202105040129