ODataModelBuilder Class

Reference

Definition

Namespace:: Microsoft.AspNet.OData.Builder

Assembly:: Microsoft.AspNet.OData.dll

Assembly:: Microsoft.AspNetCore.OData.dll

Package:: Microsoft.AspNet.OData v7.5.8

Package:: Microsoft.AspNetCore.OData v7.5.8

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

ODataModelBuilder is used to map CLR classes to an EDM model.

public class ODataModelBuilder

type ODataModelBuilder = class

Public Class ODataModelBuilder

Inheritance: Object
ODataModelBuilder

Derived: Microsoft.AspNet.OData.Builder.ODataConventionModelBuilder

Constructors

ODataModelBuilder()

Initializes a new instance of the ODataModelBuilder class.

Properties

BindingOptions	Gets or sets the navigation property binding options.
ContainerName	Gets or sets the name of the container that will hold all the navigation sources, actions and functions
DataServiceVersion	Gets or sets the data service version of the model. The default value is 4.0.
EntitySets	Gets the collection of EDM entity sets in the model to be built.
EnumTypes	Gets the collection of EDM types in the model to be built.
MaxDataServiceVersion	Gets or sets the maximum data service version of the model. The default value is 4.0.
Namespace	Gets or sets the namespace that will be used for the resulting model
NavigationSources	Gets the collection of EDM navigation sources (entity sets and singletons) in the model to be built.
Operations	Gets the collection of Operations (i.e. Actions, Functions and ServiceOperations) in the model to be built.
Singletons	Gets the collection of EDM singletons in the model to be built.
StructuralTypes	Gets the collection of EDM types in the model to be built.

Methods

Action(String)	Adds an unbound action to the builder.
AddComplexType(Type)	Registers an complex type as part of the model and returns an object that can be used to configure the entity. This method can be called multiple times for the same entity to perform multiple lines of configuration.
AddEntitySet(String, EntityTypeConfiguration)	Registers an entity set as a part of the model and returns an object that can be used to configure the entity set. This method can be called multiple times for the same type to perform multiple lines of configuration.
AddEntityType(Type)	Registers an entity type as part of the model and returns an object that can be used to configure the entity. This method can be called multiple times for the same entity to perform multiple lines of configuration.
AddEnumType(Type)	Registers an enum type as part of the model and returns an object that can be used to configure the enum type.
AddOperation(OperationConfiguration)	Adds a operation to the model.
AddSingleton(String, EntityTypeConfiguration)	Registers a singleton as a part of the model and returns an object that can be used to configure the singleton. This method can be called multiple times for the same type to perform multiple lines of configuration.
ComplexType<TComplexType>()	Registers a type as a complex type in the model and returns an object that can be used to configure the complex type. This method can be called multiple times for the same type to perform multiple lines of configuration.
EntitySet<TEntityType>(String)	Registers an entity set as a part of the model and returns an object that can be used to configure the entity set. This method can be called multiple times for the same type to perform multiple lines of configuration.
EntityType<TEntityType>()	Registers an entity type as part of the model and returns an object that can be used to configure the entity type. This method can be called multiple times for the same entity to perform multiple lines of configuration.
EnumType<TEnumType>()	Registers an enum type as part of the model and returns an object that can be used to configure the enum.
Function(String)	Adds an unbound function to the builder.
GetEdmModel()	Creates a IEdmModel based on the configuration performed using this builder.
GetTypeConfigurationOrNull(Type)	Attempts to find a pre-configured structural type or a primitive type or an enum type that matches the T. If no matches are found NULL is returned.
RemoveEntitySet(String)	Removes the entity set from the model.
RemoveEnumType(Type)	Removes the type from the model.
RemoveOperation(OperationConfiguration)	Remove the operation from the model
RemoveOperation(String)	Remove the operation from the model If there is more than one operation with the name specified this method will not work. You need to use the other RemoveOperation(..) overload instead.
RemoveSingleton(String)	Removes the singleton from the model.
RemoveStructuralType(Type)	Removes the type from the model.
Singleton<TEntityType>(String)	Registers a singleton as a part of the model and returns an object that can be used to configure the singleton. This method can be called multiple times for the same type to perform multiple lines of configuration.
ValidateModel(IEdmModel)	Validates the IEdmModel that is being created.

Applies to

Share via