Documentation Index Fetch the complete documentation index at: https://easyaf.dev/llms.txt
Use this file to discover all available pages before exploring further.
Definition Assembly: Microsoft.OData.Mcp.Core.dllNamespace: Microsoft.OData.Mcp.Core.ModelsInheritance: System.ObjectSyntax Microsoft . OData . Mcp . Core . Models . EdmSingleton
Summary Represents a singleton in an OData entity container.
Singletons represent individual entity instances that are addressable as single resources
rather than collections. They are useful for representing unique entities like service
configuration, user profiles, or system settings that exist as single instances.
Constructors Initializes a new instance of the EdmSingleton class.
Syntax Initializes a new instance of the EdmSingleton class with the specified name and type.
Syntax public EdmSingleton ( string name , string type )
Parameters Name Type Description namestringThe name of the singleton. typestringThe entity type of the singleton.
Exceptions Exception Description ArgumentExceptionThrown when name or type is null or whitespace.
Inherited Syntax Properties Gets or sets the annotations for this singleton.
Syntax public System . Collections . Generic . Dictionary < string , object > Annotations { get ; set ; }
Property Value Type: System.Collections.Generic.Dictionary<string, object>
A dictionary of annotations that provide additional metadata about the singleton.
Annotations can be used to specify additional behaviors, constraints, or metadata
that are not captured by the standard OData model elements.
Gets a value indicating whether this singleton has any navigation property bindings.
Syntax public bool HasNavigationPropertyBindings { get ; }
Property Value Type: bool
true if the singleton has navigation property bindings; otherwise, false.
Gets or sets the name of the singleton.
Syntax public required string Name { get ; set ; }
Property Value Type: string
The name used to address this singleton in OData URLs.
The singleton name appears in the URL path when accessing the individual entity.
Gets or sets the navigation property bindings for this singleton.
Syntax public System . Collections . Generic . List < Microsoft . OData . Mcp . Core . Models . EdmNavigationPropertyBinding > NavigationPropertyBindings { get ; set ; }
Property Value Type: System.Collections.Generic.List<Microsoft.OData.Mcp.Core.Models.EdmNavigationPropertyBinding>
A collection of navigation property bindings that establish relationships with other entity sets or singletons.
Navigation property bindings specify which entity set or singleton should be used when following
a navigation property from this singleton. They establish the connections between related
resources in the model.
Gets or sets the entity type of the singleton.
Syntax public required string Type { get ; set ; }
Property Value Type: string
The fully qualified name of the entity type for this singleton.
The singleton instance must be of this entity type or one of its derived types.
This determines the structure and properties available for the singleton.
Gets the short name of the entity type (without namespace).
Syntax public string TypeName { get ; }
Property Value Type: string
The entity type name without the namespace prefix.
Gets the namespace of the entity type.
Syntax public string TypeNamespace { get ; }
Property Value Type: string
The namespace portion of the entity type, or an empty string if no namespace.
Methods Adds an annotation to this singleton.
Syntax public void AddAnnotation ( string term , object value )
Parameters Name Type Description termstringThe annotation term. valueobjectThe annotation value.
Exceptions Exception Description ArgumentExceptionThrown when term is null or whitespace.
Adds a navigation property binding to this singleton.
Syntax public void AddNavigationPropertyBinding ( string navigationPropertyPath , string target )
Parameters Name Type Description navigationPropertyPathstringThe path of the navigation property. targetstringThe target entity set or singleton name.
Exceptions Exception Description ArgumentExceptionThrown when navigationPropertyPath or target is null or whitespace.
Override Determines whether the specified object is equal to the current singleton.
Syntax public override bool Equals ( object obj )
Parameters Name Type Description objobject?The object to compare with the current singleton.
Returns Type: bool
true if the specified object is equal to the current singleton; otherwise, false.
Inherited Virtual Syntax public virtual bool Equals ( object obj )
Parameters Name Type Description objobject?-
Returns Type: bool
Inherited Syntax public static bool Equals ( object objA , object objB )
Parameters Name Type Description objAobject?- objBobject?-
Returns Type: bool
Gets an annotation value by term.
Syntax public T GetAnnotation < T >( string term )
Parameters Name Type Description termstringThe annotation term.
Returns Type: T?
The annotation value, or the default value of T if not found.
Type Parameters
T - The type of the annotation value.
Override Returns a hash code for the current singleton.
Syntax public override int GetHashCode ()
Returns Type: int
A hash code for the current singleton.
Inherited Virtual Syntax public virtual int GetHashCode ()
Returns Type: int
Gets a navigation property binding by navigation property path.
Syntax public Microsoft . OData . Mcp . Core . Models . EdmNavigationPropertyBinding GetNavigationPropertyBinding ( string navigationPropertyPath )
Parameters Name Type Description navigationPropertyPathstringThe path of the navigation property.
Returns Type: Microsoft.OData.Mcp.Core.Models.EdmNavigationPropertyBinding?
The navigation property binding with the specified path, or null if not found.
Inherited Syntax public System . Type GetType ()
Returns Type: System.Type
Inherited Syntax protected internal object MemberwiseClone ()
Returns Type: object
Inherited Syntax public static bool ReferenceEquals ( object objA , object objB )
Parameters Name Type Description objAobject?- objBobject?-
Returns Type: bool
Removes a navigation property binding from this singleton.
Syntax public bool RemoveNavigationPropertyBinding ( string navigationPropertyPath )
Parameters Name Type Description navigationPropertyPathstringThe path of the navigation property to remove.
Returns Type: bool
true if the binding was removed; otherwise, false.
Override Returns a string representation of the singleton.
Syntax public override string ToString ()
Returns Type: string
A string containing the singleton name and type.
Inherited Virtual Syntax public virtual string ToString ()
Returns Type: string? 
