SearchFacetBuilderTDocumentString Method (String, SearchPathDefinitionTDocument, NullableInt32) | 
 
            Creates a facet that narrows down Atlas Search results based on the most frequent
            string values in the specified string field.
            
 
    Namespace: 
   MongoDB.Driver.Search
    Assembly:
   MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.19.1+3a2a09dd959482f665ffbb5df2557ec541597af4
Syntaxpublic SearchFacet<TDocument> String(
	string name,
	SearchPathDefinition<TDocument> path,
	int? numBuckets = null
)
Public Function String ( 
	name As String,
	path As SearchPathDefinition(Of TDocument),
	Optional numBuckets As Integer? = Nothing
) As SearchFacet(Of TDocument)
member String : 
        name : string * 
        path : SearchPathDefinition<'TDocument> * 
        ?numBuckets : Nullable<int> 
(* Defaults:
        let _numBuckets = defaultArg numBuckets null
*)
-> SearchFacet<'TDocument> 
Parameters
- name
 - Type: SystemString
The name of the facet. - path
 - Type: MongoDB.Driver.SearchSearchPathDefinitionTDocument
The field path to facet on. - numBuckets (Optional)
 - Type: SystemNullableInt32
            The maximum number of facet categories to return in the results.
             
Return Value
Type: 
SearchFacetTDocumentA string search facet.
See Also