879 lines
62 KiB
XML
879 lines
62 KiB
XML
<?xml version="1.0"?>
|
|
<doc>
|
|
<assembly>
|
|
<name>Microsoft.Extensions.Diagnostics.HealthChecks</name>
|
|
</assembly>
|
|
<members>
|
|
<member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.DelegateHealthCheck">
|
|
<summary>
|
|
A simple implementation of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> which uses a provided delegate to
|
|
implement the check.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.DelegateHealthCheck.#ctor(System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult}})">
|
|
<summary>
|
|
Create an instance of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.DelegateHealthCheck"/> from the specified delegate.
|
|
</summary>
|
|
<param name="check">A delegate which provides the code to execute when the health check is run.</param>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.DelegateHealthCheck.CheckHealthAsync(Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext,System.Threading.CancellationToken)">
|
|
<summary>
|
|
Runs the health check, returning the status of the component being checked.
|
|
</summary>
|
|
<param name="context">A context object associated with the current execution.</param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that can be used to cancel the health check.</param>
|
|
<returns>A <see cref="T:System.Threading.Tasks.Task`1"/> that completes when the health check has finished, yielding the status of the component being checked.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckLogScope.#ctor(System.String)">
|
|
<summary>
|
|
Creates a new instance of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckLogScope"/> with the provided name.
|
|
</summary>
|
|
<param name="healthCheckName">The name of the health check being executed.</param>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions">
|
|
<summary>
|
|
Options for the default service that executes <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/> instances.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions.#ctor">
|
|
<summary>
|
|
Creates a new instance of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions.Delay">
|
|
<summary>
|
|
Gets or sets the initial delay applied after the application starts before executing
|
|
<see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/> instances. The delay is applied once at startup, and does
|
|
not apply to subsequent iterations. The default value is 5 seconds.
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions.Period">
|
|
<summary>
|
|
Gets or sets the period of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/> execution. The default value is
|
|
30 seconds.
|
|
</summary>
|
|
<remarks>
|
|
The <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions.Period"/> cannot be set to a value lower than 1 second.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions.Predicate">
|
|
<summary>
|
|
Gets or sets a predicate that is used to filter the set of health checks executed.
|
|
</summary>
|
|
<remarks>
|
|
If <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions.Predicate"/> is <c>null</c>, the health check publisher service will run all
|
|
registered health checks - this is the default behavior. To run a subset of health checks,
|
|
provide a function that filters the set of checks. The predicate will be evaluated each period.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckPublisherOptions.Timeout">
|
|
<summary>
|
|
Gets or sets the timeout for executing the health checks an all <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/>
|
|
instances. Use <see cref="F:System.Threading.Timeout.InfiniteTimeSpan"/> to execute with no timeout.
|
|
The default value is 30 seconds.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService">
|
|
<summary>
|
|
A service which can be used to check the status of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instances
|
|
registered in the application.
|
|
</summary>
|
|
<remarks>
|
|
<para>
|
|
The default implementation of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService"/> is registered in the dependency
|
|
injection container as a singleton service by calling
|
|
<see cref="M:Microsoft.Extensions.DependencyInjection.HealthCheckServiceCollectionExtensions.AddHealthChecks(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/>.
|
|
</para>
|
|
<para>
|
|
The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/> returned by
|
|
<see cref="M:Microsoft.Extensions.DependencyInjection.HealthCheckServiceCollectionExtensions.AddHealthChecks(Microsoft.Extensions.DependencyInjection.IServiceCollection)"/>
|
|
provides a convenience API for registering health checks.
|
|
</para>
|
|
<para>
|
|
<see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> implementations can be registered through extension methods provided by
|
|
<see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.
|
|
</para>
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService.CheckHealthAsync(System.Threading.CancellationToken)">
|
|
<summary>
|
|
Runs all the health checks in the application and returns the aggregated status.
|
|
</summary>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> which can be used to cancel the health checks.</param>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task`1"/> which will complete when all the health checks have been run,
|
|
yielding a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/> containing the results.
|
|
</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService.CheckHealthAsync(System.Func{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration,System.Boolean},System.Threading.CancellationToken)">
|
|
<summary>
|
|
Runs the provided health checks and returns the aggregated status
|
|
</summary>
|
|
<param name="predicate">
|
|
A predicate that can be used to include health checks based on user-defined criteria.
|
|
</param>
|
|
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> which can be used to cancel the health checks.</param>
|
|
<returns>
|
|
A <see cref="T:System.Threading.Tasks.Task`1"/> which will complete when all the health checks have been run,
|
|
yielding a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/> containing the results.
|
|
</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckServiceOptions">
|
|
<summary>
|
|
Options for the default implementation of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService"/>
|
|
</summary>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckServiceOptions.Registrations">
|
|
<summary>
|
|
Gets the health check registrations.
|
|
</summary>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions">
|
|
<summary>
|
|
Provides basic extension methods for registering <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instances in an <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Adds a new health check with the specified name and implementation.
|
|
</summary>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="instance">An <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.</param>
|
|
<param name="failureStatus">
|
|
The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
|
|
is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.
|
|
</param>
|
|
<param name="tags">A list of tags that can be used to filter health checks.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">
|
|
<summary>
|
|
Adds a new health check with the specified name and implementation.
|
|
</summary>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="instance">An <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.</param>
|
|
<param name="failureStatus">
|
|
The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
|
|
is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.
|
|
</param>
|
|
<param name="tags">A list of tags that can be used to filter health checks.</param>
|
|
<param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddCheck``1(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Adds a new health check with the specified name and implementation.
|
|
</summary>
|
|
<typeparam name="T">The health check implementation type.</typeparam>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="failureStatus">
|
|
The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
|
|
is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.
|
|
</param>
|
|
<param name="tags">A list of tags that can be used to filter health checks.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
<remarks>
|
|
This method will use <see cref="M:Microsoft.Extensions.DependencyInjection.ActivatorUtilities.GetServiceOrCreateInstance``1(System.IServiceProvider)"/> to create the health check
|
|
instance when needed. If a service of type <typeparamref name="T"/> is registered in the dependency injection container
|
|
with any lifetime it will be used. Otherwise an instance of type <typeparamref name="T"/> will be constructed with
|
|
access to services from the dependency injection container.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddCheck``1(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">
|
|
<summary>
|
|
Adds a new health check with the specified name and implementation.
|
|
</summary>
|
|
<typeparam name="T">The health check implementation type.</typeparam>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="failureStatus">
|
|
The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
|
|
is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.
|
|
</param>
|
|
<param name="tags">A list of tags that can be used to filter health checks.</param>
|
|
<param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
<remarks>
|
|
This method will use <see cref="M:Microsoft.Extensions.DependencyInjection.ActivatorUtilities.GetServiceOrCreateInstance``1(System.IServiceProvider)"/> to create the health check
|
|
instance when needed. If a service of type <typeparamref name="T"/> is registered in the dependency injection container
|
|
with any lifetime it will be used. Otherwise an instance of type <typeparamref name="T"/> will be constructed with
|
|
access to services from the dependency injection container.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddTypeActivatedCheck``1(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Object[])">
|
|
<summary>
|
|
Adds a new type activated health check with the specified name and implementation.
|
|
</summary>
|
|
<typeparam name="T">The health check implementation type.</typeparam>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="args">Additional arguments to provide to the constructor.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
<remarks>
|
|
This method will use <see cref="M:Microsoft.Extensions.DependencyInjection.ActivatorUtilities.CreateInstance``1(System.IServiceProvider,System.Object[])"/> to create the health check
|
|
instance when needed. Additional arguments can be provided to the constructor via <paramref name="args"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddTypeActivatedCheck``1(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Object[])">
|
|
<summary>
|
|
Adds a new type activated health check with the specified name and implementation.
|
|
</summary>
|
|
<typeparam name="T">The health check implementation type.</typeparam>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="failureStatus">
|
|
The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
|
|
is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.
|
|
</param>
|
|
<param name="args">Additional arguments to provide to the constructor.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
<remarks>
|
|
This method will use <see cref="M:Microsoft.Extensions.DependencyInjection.ActivatorUtilities.CreateInstance``1(System.IServiceProvider,System.Object[])"/> to create the health check
|
|
instance when needed. Additional arguments can be provided to the constructor via <paramref name="args"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddTypeActivatedCheck``1(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String},System.Object[])">
|
|
<summary>
|
|
Adds a new type activated health check with the specified name and implementation.
|
|
</summary>
|
|
<typeparam name="T">The health check implementation type.</typeparam>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="failureStatus">
|
|
The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
|
|
is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.
|
|
</param>
|
|
<param name="tags">A list of tags that can be used to filter health checks.</param>
|
|
<param name="args">Additional arguments to provide to the constructor.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
<remarks>
|
|
This method will use <see cref="M:Microsoft.Extensions.DependencyInjection.ActivatorUtilities.CreateInstance``1(System.IServiceProvider,System.Object[])"/> to create the health check
|
|
instance when needed. Additional arguments can be provided to the constructor via <paramref name="args"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderAddCheckExtensions.AddTypeActivatedCheck``1(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String},System.TimeSpan,System.Object[])">
|
|
<summary>
|
|
Adds a new type activated health check with the specified name and implementation.
|
|
</summary>
|
|
<typeparam name="T">The health check implementation type.</typeparam>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="failureStatus">
|
|
The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value
|
|
is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.
|
|
</param>
|
|
<param name="tags">A list of tags that can be used to filter health checks.</param>
|
|
<param name="args">Additional arguments to provide to the constructor.</param>
|
|
<param name="timeout">A <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
<remarks>
|
|
This method will use <see cref="M:Microsoft.Extensions.DependencyInjection.ActivatorUtilities.CreateInstance``1(System.IServiceProvider,System.Object[])"/> to create the health check
|
|
instance when needed. Additional arguments can be provided to the constructor via <paramref name="args"/>.
|
|
</remarks>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions">
|
|
<summary>
|
|
Provides extension methods for registering delegates with the <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult},System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Adds a new health check with the specified name and implementation.
|
|
</summary>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="tags">A list of tags that can be used to filter health checks.</param>
|
|
<param name="check">A delegate that provides the health check implementation.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">
|
|
<summary>
|
|
Adds a new health check with the specified name and implementation.
|
|
</summary>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="tags">A list of tags that can be used to filter health checks.</param>
|
|
<param name="check">A delegate that provides the health check implementation.</param>
|
|
<param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{System.Threading.CancellationToken,Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult},System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Adds a new health check with the specified name and implementation.
|
|
</summary>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="tags">A list of tags that can be used to filter health checks.</param>
|
|
<param name="check">A delegate that provides the health check implementation.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{System.Threading.CancellationToken,Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">
|
|
<summary>
|
|
Adds a new health check with the specified name and implementation.
|
|
</summary>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="tags">A list of tags that can be used to filter health checks.</param>
|
|
<param name="check">A delegate that provides the health check implementation.</param>
|
|
<param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddAsyncCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{System.Threading.Tasks.Task{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult}},System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Adds a new health check with the specified name and implementation.
|
|
</summary>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="tags">A list of tags that can be used to filter health checks.</param>
|
|
<param name="check">A delegate that provides the health check implementation.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddAsyncCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{System.Threading.Tasks.Task{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult}},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">
|
|
<summary>
|
|
Adds a new health check with the specified name and implementation.
|
|
</summary>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="tags">A list of tags that can be used to filter health checks.</param>
|
|
<param name="check">A delegate that provides the health check implementation.</param>
|
|
<param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddAsyncCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult}},System.Collections.Generic.IEnumerable{System.String})">
|
|
<summary>
|
|
Adds a new health check with the specified name and implementation.
|
|
</summary>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="tags">A list of tags that can be used to filter health checks.</param>
|
|
<param name="check">A delegate that provides the health check implementation.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthChecksBuilderDelegateExtensions.AddAsyncCheck(Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder,System.String,System.Func{System.Threading.CancellationToken,System.Threading.Tasks.Task{Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult}},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">
|
|
<summary>
|
|
Adds a new health check with the specified name and implementation.
|
|
</summary>
|
|
<param name="builder">The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</param>
|
|
<param name="name">The name of the health check.</param>
|
|
<param name="tags">A list of tags that can be used to filter health checks.</param>
|
|
<param name="check">A delegate that provides the health check implementation.</param>
|
|
<param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>
|
|
<returns>The <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/>.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.DependencyInjection.HealthCheckServiceCollectionExtensions">
|
|
<summary>
|
|
Provides extension methods for registering <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService"/> in an <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.HealthCheckServiceCollectionExtensions.AddHealthChecks(Microsoft.Extensions.DependencyInjection.IServiceCollection)">
|
|
<summary>
|
|
Adds the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService"/> to the container, using the provided delegate to register
|
|
health checks.
|
|
</summary>
|
|
<remarks>
|
|
This operation is idempotent - multiple invocations will still only result in a single
|
|
<see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService"/> instance in the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/>. It can be invoked
|
|
multiple times in order to get access to the <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/> in multiple places.
|
|
</remarks>
|
|
<param name="services">The <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> to add the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckService"/> to.</param>
|
|
<returns>An instance of <see cref="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder"/> from which health checks can be registered.</returns>
|
|
</member>
|
|
<member name="T:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder">
|
|
<summary>
|
|
A builder used to register health checks.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder.Add(Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration)">
|
|
<summary>
|
|
Adds a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration"/> for a health check.
|
|
</summary>
|
|
<param name="registration">The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration"/>.</param>
|
|
</member>
|
|
<member name="P:Microsoft.Extensions.DependencyInjection.IHealthChecksBuilder.Services">
|
|
<summary>
|
|
Gets the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection"/> into which <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instances should be registered.
|
|
</summary>
|
|
</member>
|
|
<member name="M:Microsoft.AspNetCore.Shared.ArgumentNullThrowHelper.ThrowIfNull(System.Object,System.String)">
|
|
<summary>Throws an <see cref="T:System.ArgumentNullException"/> if <paramref name="argument"/> is null.</summary>
|
|
<param name="argument">The reference type argument to validate as non-null.</param>
|
|
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
|
|
</member>
|
|
<member name="M:Microsoft.AspNetCore.Shared.ArgumentNullThrowHelper.ThrowIfNullOrEmpty(System.String,System.String)">
|
|
<summary>Throws an <see cref="T:System.ArgumentException"/> if <paramref name="argument"/> is null or empty.</summary>
|
|
<param name="argument">The <see cref="T:System.String"/> argument to validate as non-null and non-empty.</param>
|
|
<param name="paramName">The name of the parameter with which <paramref name="argument"/> corresponds.</param>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute">
|
|
<summary>
|
|
Indicates that the specified method requires the ability to generate new code at runtime,
|
|
for example through <see cref="N:System.Reflection"/>.
|
|
</summary>
|
|
<remarks>
|
|
This allows tools to understand which methods are unsafe to call when compiling ahead of time.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute"/> class
|
|
with the specified message.
|
|
</summary>
|
|
<param name="message">
|
|
A message that contains information about the usage of dynamic code.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Message">
|
|
<summary>
|
|
Gets a message that contains information about the usage of dynamic code.
|
|
</summary>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.RequiresDynamicCodeAttribute.Url">
|
|
<summary>
|
|
Gets or sets an optional URL that contains more information about the method,
|
|
why it requires dynamic code, and what options a consumer has to deal with it.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute">
|
|
<summary>
|
|
Indicates that the specified method requires dynamic access to code that is not referenced
|
|
statically, for example through <see cref="N:System.Reflection"/>.
|
|
</summary>
|
|
<remarks>
|
|
This allows tools to understand which methods are unsafe to call when removing unreferenced
|
|
code from an application.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute"/> class
|
|
with the specified message.
|
|
</summary>
|
|
<param name="message">
|
|
A message that contains information about the usage of unreferenced code.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Message">
|
|
<summary>
|
|
Gets a message that contains information about the usage of unreferenced code.
|
|
</summary>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.RequiresUnreferencedCodeAttribute.Url">
|
|
<summary>
|
|
Gets or sets an optional URL that contains more information about the method,
|
|
why it requires unreferenced code, and what options a consumer has to deal with it.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute">
|
|
<summary>
|
|
Suppresses reporting of a specific rule violation, allowing multiple suppressions on a
|
|
single code artifact.
|
|
</summary>
|
|
<remarks>
|
|
<see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> is different than
|
|
<see cref="T:System.Diagnostics.CodeAnalysis.SuppressMessageAttribute"/> in that it doesn't have a
|
|
<see cref="T:System.Diagnostics.ConditionalAttribute"/>. So it is always preserved in the compiled assembly.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.#ctor(System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/>
|
|
class, specifying the category of the tool and the identifier for an analysis rule.
|
|
</summary>
|
|
<param name="category">The category for the attribute.</param>
|
|
<param name="checkId">The identifier of the analysis rule the attribute applies to.</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category">
|
|
<summary>
|
|
Gets the category identifying the classification of the attribute.
|
|
</summary>
|
|
<remarks>
|
|
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> property describes the tool or tool analysis category
|
|
for which a message suppression attribute applies.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId">
|
|
<summary>
|
|
Gets the identifier of the analysis tool rule to be suppressed.
|
|
</summary>
|
|
<remarks>
|
|
Concatenated together, the <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Category"/> and <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.CheckId"/>
|
|
properties form a unique check identifier.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Scope">
|
|
<summary>
|
|
Gets or sets the scope of the code that is relevant for the attribute.
|
|
</summary>
|
|
<remarks>
|
|
The Scope property is an optional argument that specifies the metadata scope for which
|
|
the attribute is relevant.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target">
|
|
<summary>
|
|
Gets or sets a fully qualified path that represents the target of the attribute.
|
|
</summary>
|
|
<remarks>
|
|
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Target"/> property is an optional argument identifying the analysis target
|
|
of the attribute. An example value is "System.IO.Stream.ctor():System.Void".
|
|
Because it is fully qualified, it can be long, particularly for targets such as parameters.
|
|
The analysis tool user interface should be capable of automatically formatting the parameter.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId">
|
|
<summary>
|
|
Gets or sets an optional argument expanding on exclusion criteria.
|
|
</summary>
|
|
<remarks>
|
|
The <see cref="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.MessageId"/> property is an optional argument that specifies additional
|
|
exclusion where the literal metadata target is not sufficiently precise. For example,
|
|
the <see cref="T:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute"/> cannot be applied within a method,
|
|
and it may be desirable to suppress a violation against a statement in the method that will
|
|
give a rule violation, but not against all statements in the method.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessageAttribute.Justification">
|
|
<summary>
|
|
Gets or sets the justification for suppressing the code analysis message.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute">
|
|
<summary>
|
|
States a dependency that one member has on another.
|
|
</summary>
|
|
<remarks>
|
|
This can be used to inform tooling of a dependency that is otherwise not evident purely from
|
|
metadata and IL, for example a member relied on via reflection.
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
|
with the specified signature of a member on the same type as the consumer.
|
|
</summary>
|
|
<param name="memberSignature">The signature of the member depended on.</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String,System.Type)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
|
with the specified signature of a member on a <see cref="T:System.Type"/>.
|
|
</summary>
|
|
<param name="memberSignature">The signature of the member depended on.</param>
|
|
<param name="type">The <see cref="T:System.Type"/> containing <paramref name="memberSignature"/>.</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.String,System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
|
with the specified signature of a member on a type in an assembly.
|
|
</summary>
|
|
<param name="memberSignature">The signature of the member depended on.</param>
|
|
<param name="typeName">The full name of the type containing the specified member.</param>
|
|
<param name="assemblyName">The assembly name of the type containing the specified member.</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes,System.Type)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
|
with the specified types of members on a <see cref="T:System.Type"/>.
|
|
</summary>
|
|
<param name="memberTypes">The types of members depended on.</param>
|
|
<param name="type">The <see cref="T:System.Type"/> containing the specified members.</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes,System.String,System.String)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute"/> class
|
|
with the specified types of members on a type in an assembly.
|
|
</summary>
|
|
<param name="memberTypes">The types of members depended on.</param>
|
|
<param name="typeName">The full name of the type containing the specified members.</param>
|
|
<param name="assemblyName">The assembly name of the type containing the specified members.</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature">
|
|
<summary>
|
|
Gets the signature of the member depended on.
|
|
</summary>
|
|
<remarks>
|
|
Either <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature"/> must be a valid string or <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes"/>
|
|
must not equal <see cref="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None"/>, but not both.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes">
|
|
<summary>
|
|
Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
|
|
of members depended on.
|
|
</summary>
|
|
<remarks>
|
|
Either <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberSignature"/> must be a valid string or <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.MemberTypes"/>
|
|
must not equal <see cref="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None"/>, but not both.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type">
|
|
<summary>
|
|
Gets the <see cref="T:System.Type"/> containing the specified member.
|
|
</summary>
|
|
<remarks>
|
|
If neither <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type"/> nor <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> are specified,
|
|
the type of the consumer is assumed.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName">
|
|
<summary>
|
|
Gets the full name of the type containing the specified member.
|
|
</summary>
|
|
<remarks>
|
|
If neither <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Type"/> nor <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> are specified,
|
|
the type of the consumer is assumed.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.AssemblyName">
|
|
<summary>
|
|
Gets the assembly name of the specified type.
|
|
</summary>
|
|
<remarks>
|
|
<see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.AssemblyName"/> is only valid when <see cref="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.TypeName"/> is specified.
|
|
</remarks>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicDependencyAttribute.Condition">
|
|
<summary>
|
|
Gets or sets the condition in which the dependency is applicable, e.g. "DEBUG".
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute">
|
|
<summary>
|
|
Indicates that certain members on a specified <see cref="T:System.Type"/> are accessed dynamically,
|
|
for example through <see cref="N:System.Reflection"/>.
|
|
</summary>
|
|
<remarks>
|
|
This allows tools to understand which members are being accessed during the execution
|
|
of a program.
|
|
|
|
This attribute is valid on members whose type is <see cref="T:System.Type"/> or <see cref="T:System.String"/>.
|
|
|
|
When this attribute is applied to a location of type <see cref="T:System.String"/>, the assumption is
|
|
that the string represents a fully qualified type name.
|
|
|
|
When this attribute is applied to a class, interface, or struct, the members specified
|
|
can be accessed dynamically on <see cref="T:System.Type"/> instances returned from calling
|
|
<see cref="M:System.Object.GetType"/> on instances of that class, interface, or struct.
|
|
|
|
If the attribute is applied to a method it's treated as a special case and it implies
|
|
the attribute should be applied to the "this" parameter of the method. As such the attribute
|
|
should only be used on instance methods of types assignable to System.Type (or string, but no methods
|
|
will use it there).
|
|
</remarks>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.#ctor(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes)">
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute"/> class
|
|
with the specified member types.
|
|
</summary>
|
|
<param name="memberTypes">The types of members dynamically accessed.</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembersAttribute.MemberTypes">
|
|
<summary>
|
|
Gets the <see cref="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes"/> which specifies the type
|
|
of members dynamically accessed.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes">
|
|
<summary>
|
|
Specifies the types of members that are dynamically accessed.
|
|
|
|
This enumeration has a <see cref="T:System.FlagsAttribute"/> attribute that allows a
|
|
bitwise combination of its member values.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.None">
|
|
<summary>
|
|
Specifies no members.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicParameterlessConstructor">
|
|
<summary>
|
|
Specifies the default, parameterless public constructor.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors">
|
|
<summary>
|
|
Specifies all public constructors.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicConstructors">
|
|
<summary>
|
|
Specifies all non-public constructors.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicMethods">
|
|
<summary>
|
|
Specifies all public methods.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicMethods">
|
|
<summary>
|
|
Specifies all non-public methods.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicFields">
|
|
<summary>
|
|
Specifies all public fields.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicFields">
|
|
<summary>
|
|
Specifies all non-public fields.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicNestedTypes">
|
|
<summary>
|
|
Specifies all public nested types.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicNestedTypes">
|
|
<summary>
|
|
Specifies all non-public nested types.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicProperties">
|
|
<summary>
|
|
Specifies all public properties.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicProperties">
|
|
<summary>
|
|
Specifies all non-public properties.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicEvents">
|
|
<summary>
|
|
Specifies all public events.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.NonPublicEvents">
|
|
<summary>
|
|
Specifies all non-public events.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.Interfaces">
|
|
<summary>
|
|
Specifies all interfaces implemented by the type.
|
|
</summary>
|
|
</member>
|
|
<member name="F:System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.All">
|
|
<summary>
|
|
Specifies all members.
|
|
</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.AllowNullAttribute">
|
|
<summary>Specifies that null is allowed as an input even if the corresponding type disallows it.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DisallowNullAttribute">
|
|
<summary>Specifies that null is disallowed as an input even if the corresponding type allows it.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullAttribute">
|
|
<summary>Specifies that an output may be null even if the corresponding type disallows it.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.NotNullAttribute">
|
|
<summary>Specifies that an output will not be null even if the corresponding type allows it. Specifies that an input argument was not null when the call returns.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute">
|
|
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue"/>, the parameter may be null even if the corresponding type disallows it.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.#ctor(System.Boolean)">
|
|
<summary>Initializes the attribute with the specified return value condition.</summary>
|
|
<param name="returnValue">
|
|
The return value condition. If the method returns this value, the associated parameter may be null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.MaybeNullWhenAttribute.ReturnValue">
|
|
<summary>Gets the return value condition.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute">
|
|
<summary>Specifies that when a method returns <see cref="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue"/>, the parameter will not be null even if the corresponding type allows it.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.#ctor(System.Boolean)">
|
|
<summary>Initializes the attribute with the specified return value condition.</summary>
|
|
<param name="returnValue">
|
|
The return value condition. If the method returns this value, the associated parameter will not be null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.NotNullWhenAttribute.ReturnValue">
|
|
<summary>Gets the return value condition.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute">
|
|
<summary>Specifies that the output will be non-null if the named parameter is non-null.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.#ctor(System.String)">
|
|
<summary>Initializes the attribute with the associated parameter name.</summary>
|
|
<param name="parameterName">
|
|
The associated parameter name. The output will be non-null if the argument to the parameter specified is non-null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.NotNullIfNotNullAttribute.ParameterName">
|
|
<summary>Gets the associated parameter name.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnAttribute">
|
|
<summary>Applied to a method that will never return under any circumstance.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute">
|
|
<summary>Specifies that the method will not return if the associated Boolean parameter is passed the specified value.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.#ctor(System.Boolean)">
|
|
<summary>Initializes the attribute with the specified parameter value.</summary>
|
|
<param name="parameterValue">
|
|
The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to
|
|
the associated parameter matches this value.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.DoesNotReturnIfAttribute.ParameterValue">
|
|
<summary>Gets the condition parameter value.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute">
|
|
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String)">
|
|
<summary>Initializes the attribute with a field or property member.</summary>
|
|
<param name="member">
|
|
The field or property member that is promised to be not-null.
|
|
</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.#ctor(System.String[])">
|
|
<summary>Initializes the attribute with the list of field and property members.</summary>
|
|
<param name="members">
|
|
The list of field and property members that are promised to be not-null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullAttribute.Members">
|
|
<summary>Gets field or property member names.</summary>
|
|
</member>
|
|
<member name="T:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute">
|
|
<summary>Specifies that the method or property will ensure that the listed field and property members have not-null values when returning with the specified return value condition.</summary>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String)">
|
|
<summary>Initializes the attribute with the specified return value condition and a field or property member.</summary>
|
|
<param name="returnValue">
|
|
The return value condition. If the method returns this value, the associated parameter will not be null.
|
|
</param>
|
|
<param name="member">
|
|
The field or property member that is promised to be not-null.
|
|
</param>
|
|
</member>
|
|
<member name="M:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.#ctor(System.Boolean,System.String[])">
|
|
<summary>Initializes the attribute with the specified return value condition and list of field and property members.</summary>
|
|
<param name="returnValue">
|
|
The return value condition. If the method returns this value, the associated parameter will not be null.
|
|
</param>
|
|
<param name="members">
|
|
The list of field and property members that are promised to be not-null.
|
|
</param>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.ReturnValue">
|
|
<summary>Gets the return value condition.</summary>
|
|
</member>
|
|
<member name="P:System.Diagnostics.CodeAnalysis.MemberNotNullWhenAttribute.Members">
|
|
<summary>Gets field or property member names.</summary>
|
|
</member>
|
|
</members>
|
|
</doc>
|