Share via


MetadataSerializationOptionsBuilder Class

Definition

Provides the ability to build the set of options that are used during metadata serialization.

public sealed class MetadataSerializationOptionsBuilder
type MetadataSerializationOptionsBuilder = class
Public NotInheritable Class MetadataSerializationOptionsBuilder
Inheritance
MetadataSerializationOptionsBuilder

Constructors

MetadataSerializationOptionsBuilder(MetadataSerializationOptions)

Creates an instance of the MetadataSerializationOptionsBuilder class that is initialized by the specified options.

MetadataSerializationOptionsBuilder(MetadataSerializationStyle)

Creates a new instance of MetadataSerializationOptionsBuilder class based on the specified style.

Properties

Compatibility

Gets an optional compatibility options that should be used when serializing the metadata.

Formatting

Gets an optional formatting options that should be used when generating the metadata content.

IncludeChildren

Gets an indication if the children of the root object should also be serialized, or only the root object.

IncludeInferredDataTypes

Gets an indication if the serialized output should include inferred data-types or only the data-types that were explicitly set by the user.

IncludeRestrictedInformation

Gets an indication if the serialized output should include restricted information or only the curated version of the data.

Methods

GetOptions()

Gets an instance of MetadataSerializationOptions initialized with the serialization options that were chosen.

WithChildrenMetadata()

Sets the indication that the children of the root object should also be serialized, and not only the root object.

WithCompatibilityOptions(MetadataCompatibilityOptions)

Sets the compatibility options that should be used during the serialization.

WithFormattingOptions(MetadataFormattingOptions)

Sets the formatting options that should be used when generating the metadata content.

WithInferredDataTypes()

Sets the indication that the serialized output should include inferred data-types and not just data-types that are explicitly set by the user.

WithoutChildrenMetadata()

Reset the indication that the children of the root object should also be serialized, to include only the root object.

WithoutCompatibilityOptions()

Resets the compatibility options that should be used during the serialization, and restore the default options.

WithoutFormattingOptions()

Resets the formatting options that should be used when generating the metadata content, and restore the default options.

WithoutInferredDataTypes()

Resets the indication that the serialized output should include inferred data-types, so it will only include data-types that are explicitly set by the user.

WithoutRestrictedInformation()

Reset the indication that the serialized output should not include restricted information, just the curated version of the data.

WithRestrictedInformation()

Sets the indication that the serialized output should include restricted information and not the curated version of the data.

Extension Methods

GetExpressionTrimStyle(MetadataSerializationOptionsBuilder)

Gets the style in which whitespaces in lines in an expression block, are trimmed when serialized into TMDL text; default is TrimTrailingWhitespaces.

IsMetadataOrderHintsExcluded(MetadataSerializationOptionsBuilder)

Gets an indication if the serialized TMDL content should not include hints for the order of metadata elements; default is false, indicating to included in the generated TMDL.

WithExpressionTrimStyle(MetadataSerializationOptionsBuilder, TmdlExpressionTrimStyle)

Sets the style in which whitespaces in lines in an expression block, are trimmed when serialized into TMDL text.

WithMetadataOrderHints(MetadataSerializationOptionsBuilder)

Sets an indication that metadata-order hints should be included in the generated TMDL content.

WithoutMetadataOrderHints(MetadataSerializationOptionsBuilder)

Sets an indication that metadata-order hints should not be included in the generated TMDL content.

Applies to