review.tizen.org Git - platform/core/dotnet/build-tools.git/blob

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Microsoft.Extensions.Diagnostics.HealthChecks.Abstractions</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext.Registration">\r
   8             <summary>\r
   9             Gets or sets the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration"/> of the currently executing <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/>.\r
  10             </summary>\r
  11         </member>\r
  12         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration">\r
  13             <summary>\r
  14             Represent the registration information associated with an <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> implementation.\r
  15             </summary>\r
  16             <remarks>\r
  17             <para>\r
  18             The health check registration is provided as a separate object so that application developers can customize\r
  19             how health check implementations are configured.\r
  20             </para>\r
  21             <para>\r
  22             The registration is provided to an <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> implementation during execution through\r
  23             <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext.Registration"/>. This allows a health check implementation to access named\r
  24             options or perform other operations based on the registered name.\r
  25             </para>\r
  26             </remarks>\r
  27         </member>\r
  28         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.#ctor(System.String,Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String})">\r
  29             <summary>\r
  30             Creates a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration" /> for an existing <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck" /> instance.\r
  31             </summary>\r
  32             <param name="name">The health check name.</param>\r
  33             <param name="instance">The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck" /> instance.</param>\r
  34             <param name="failureStatus">\r
  35             The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus" /> that should be reported upon failure of the health check. If the provided value\r
  36             is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy" /> will be reported.\r
  37             </param>\r
  38             <param name="tags">A list of tags that can be used for filtering health checks.</param>\r
  39         </member>\r
  40         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.#ctor(System.String,Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck,System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">\r
  41             <summary>\r
  42             Creates a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration"/> for an existing <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.\r
  43             </summary>\r
  44             <param name="name">The health check name.</param>\r
  45             <param name="instance">The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.</param>\r
  46             <param name="failureStatus">\r
  47             The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported upon failure of the health check. If the provided value\r
  48             is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.\r
  49             </param>\r
  50             <param name="tags">A list of tags that can be used for filtering health checks.</param>\r
  51             <param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>\r
  52         </member>\r
  53         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.#ctor(System.String,System.Func{System.IServiceProvider,Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck},System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String})">\r
  54             <summary>\r
  55             Creates a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration"/> for an existing <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.\r
  56             </summary>\r
  57             <param name="name">The health check name.</param>\r
  58             <param name="factory">A delegate used to create the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.</param>\r
  59             <param name="failureStatus">\r
  60             The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value\r
  61             is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.\r
  62             </param>\r
  63             <param name="tags">A list of tags that can be used for filtering health checks.</param>\r
  64         </member>\r
  65         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.#ctor(System.String,System.Func{System.IServiceProvider,Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck},System.Nullable{Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus},System.Collections.Generic.IEnumerable{System.String},System.Nullable{System.TimeSpan})">\r
  66             <summary>\r
  67             Creates a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration"/> for an existing <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.\r
  68             </summary>\r
  69             <param name="name">The health check name.</param>\r
  70             <param name="factory">A delegate used to create the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.</param>\r
  71             <param name="failureStatus">\r
  72             The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported when the health check reports a failure. If the provided value\r
  73             is <c>null</c>, then <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> will be reported.\r
  74             </param>\r
  75             <param name="tags">A list of tags that can be used for filtering health checks.</param>\r
  76             <param name="timeout">An optional <see cref="T:System.TimeSpan"/> representing the timeout of the check.</param>\r
  77         </member>\r
  78         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.Factory">\r
  79             <summary>\r
  80             Gets or sets a delegate used to create the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instance.\r
  81             </summary>\r
  82         </member>\r
  83         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.FailureStatus">\r
  84             <summary>\r
  85             Gets or sets the <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> that should be reported upon failure of the health check.\r
  86             </summary>\r
  87         </member>\r
  88         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.Timeout">\r
  89             <summary>\r
  90             Gets or sets the timeout used for the test.\r
  91             </summary>\r
  92         </member>\r
  93         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.Name">\r
  94             <summary>\r
  95             Gets or sets the health check name.\r
  96             </summary>\r
  97         </member>\r
  98         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckRegistration.Tags">\r
  99             <summary>\r
 100             Gets a list of tags that can be used for filtering health checks.\r
 101             </summary>\r
 102         </member>\r
 103         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult">\r
 104             <summary>\r
 105             Represents the result of a health check.\r
 106             </summary>\r
 107         </member>\r
 108         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.#ctor(Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus,System.String,System.Exception,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object})">\r
 109             <summary>\r
 110             Creates a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult"/> with the specified values for <paramref name="status"/>, \r
 111             <paramref name="exception"/>, <paramref name="description"/>, and <paramref name="data"/>.\r
 112             </summary>\r
 113             <param name="status">A value indicating the status of the component that was checked.</param>\r
 114             <param name="description">A human-readable description of the status of the component that was checked.</param>\r
 115             <param name="exception">An <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Exception"/> representing the exception that was thrown when checking for status (if any).</param>\r
 116             <param name="data">Additional key-value pairs describing the health of the component.</param>\r
 117         </member>\r
 118         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Data">\r
 119             <summary>\r
 120             Gets additional key-value pairs describing the health of the component.\r
 121             </summary>\r
 122         </member>\r
 123         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Description">\r
 124             <summary>\r
 125             Gets a human-readable description of the status of the component that was checked.\r
 126             </summary>\r
 127         </member>\r
 128         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Exception">\r
 129             <summary>\r
 130             Gets an <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Exception"/> representing the exception that was thrown when checking for status (if any).\r
 131             </summary>\r
 132         </member>\r
 133         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Status">\r
 134             <summary>\r
 135             Gets a value indicating the status of the component that was checked.\r
 136             </summary>\r
 137         </member>\r
 138         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Healthy(System.String,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object})">\r
 139             <summary>\r
 140             Creates a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult"/> representing a healthy component.\r
 141             </summary>\r
 142             <param name="description">A human-readable description of the status of the component that was checked. Optional.</param>\r
 143             <param name="data">Additional key-value pairs describing the health of the component. Optional.</param>\r
 144             <returns>A <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult"/> representing a healthy component.</returns>\r
 145         </member>\r
 146         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Degraded(System.String,System.Exception,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object})">\r
 147             <summary>\r
 148             Creates a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult"/> representing a degraded component.\r
 149             </summary>\r
 150             <param name="description">A human-readable description of the status of the component that was checked. Optional.</param>\r
 151             <param name="exception">An <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Exception"/> representing the exception that was thrown when checking for status. Optional.</param>\r
 152             <param name="data">Additional key-value pairs describing the health of the component. Optional.</param>\r
 153             <returns>A <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult"/> representing a degraged component.</returns>\r
 154         </member>\r
 155         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Unhealthy(System.String,System.Exception,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object})">\r
 156             <summary>\r
 157             Creates a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult"/> representing an unhealthy component.\r
 158             </summary>\r
 159             <param name="description">A human-readable description of the status of the component that was checked. Optional.</param>\r
 160             <param name="exception">An <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult.Exception"/> representing the exception that was thrown when checking for status. Optional.</param>\r
 161             <param name="data">Additional key-value pairs describing the health of the component. Optional.</param>\r
 162             <returns>A <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckResult"/> representing an unhealthy component.</returns>\r
 163         </member>\r
 164         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport">\r
 165             <summary>\r
 166             Represents the result of executing a group of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/> instances.\r
 167             </summary>\r
 168         </member>\r
 169         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport.#ctor(System.Collections.Generic.IReadOnlyDictionary{System.String,Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry},System.TimeSpan)">\r
 170             <summary>\r
 171             Create a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/> from the specified results.\r
 172             </summary>\r
 173             <param name="entries">A <see cref="T:System.Collections.Generic.IReadOnlyDictionary`2"/> containing the results from each health check.</param>\r
 174             <param name="totalDuration">A value indicating the time the health check service took to execute.</param>\r
 175         </member>\r
 176         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport.Entries">\r
 177             <summary>\r
 178             A <see cref="T:System.Collections.Generic.IReadOnlyDictionary`2"/> containing the results from each health check.\r
 179             </summary>\r
 180             <remarks>\r
 181             The keys in this dictionary map the name of each executed health check to a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry"/> for the\r
 182             result data retruned from the corresponding health check.\r
 183             </remarks>\r
 184         </member>\r
 185         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport.Status">\r
 186             <summary>\r
 187             Gets a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus"/> representing the aggregate status of all the health checks. The value of <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport.Status"/>\r
 188             will be the most servere status reported by a health check. If no checks were executed, the value is always <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Healthy"/>.\r
 189             </summary>\r
 190         </member>\r
 191         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport.TotalDuration">\r
 192             <summary>\r
 193             Gets the time the health check service took to execute.\r
 194             </summary>\r
 195         </member>\r
 196         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry">\r
 197             <summary>\r
 198             Represents an entry in a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/>. Corresponds to the result of a single <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck"/>.\r
 199             </summary>\r
 200         </member>\r
 201         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.#ctor(Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus,System.String,System.TimeSpan,System.Exception,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object})">\r
 202             <summary>\r
 203             Creates a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry"/> with the specified values for <paramref name="status"/>, <paramref name="exception"/>,\r
 204             <paramref name="description"/>, and <paramref name="data"/>.\r
 205             </summary>\r
 206             <param name="status">A value indicating the health status of the component that was checked.</param>\r
 207             <param name="description">A human-readable description of the status of the component that was checked.</param>\r
 208             <param name="duration">A value indicating the health execution duration.</param>\r
 209             <param name="exception">An <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Exception"/> representing the exception that was thrown when checking for status (if any).</param>\r
 210             <param name="data">Additional key-value pairs describing the health of the component.</param>\r
 211         </member>\r
 212         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.#ctor(Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus,System.String,System.TimeSpan,System.Exception,System.Collections.Generic.IReadOnlyDictionary{System.String,System.Object},System.Collections.Generic.IEnumerable{System.String})">\r
 213             <summary>\r
 214             Creates a new <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry"/> with the specified values for <paramref name="status"/>, <paramref name="exception"/>,\r
 215             <paramref name="description"/>, and <paramref name="data"/>.\r
 216             </summary>\r
 217             <param name="status">A value indicating the health status of the component that was checked.</param>\r
 218             <param name="description">A human-readable description of the status of the component that was checked.</param>\r
 219             <param name="duration">A value indicating the health execution duration.</param>\r
 220             <param name="exception">An <see cref="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Exception"/> representing the exception that was thrown when checking for status (if any).</param>\r
 221             <param name="data">Additional key-value pairs describing the health of the component.</param>\r
 222             <param name="tags">Tags associated with the health check that generated the report entry.</param>\r
 223         </member>\r
 224         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Data">\r
 225             <summary>\r
 226             Gets additional key-value pairs describing the health of the component.\r
 227             </summary>\r
 228         </member>\r
 229         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Description">\r
 230             <summary>\r
 231             Gets a human-readable description of the status of the component that was checked.\r
 232             </summary>\r
 233         </member>\r
 234         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Duration">\r
 235             <summary>\r
 236             Gets the health check execution duration.\r
 237             </summary>\r
 238         </member>\r
 239         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Exception">\r
 240             <summary>\r
 241             Gets an <see cref="T:System.Exception"/> representing the exception that was thrown when checking for status (if any).\r
 242             </summary>\r
 243         </member>\r
 244         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Status">\r
 245             <summary>\r
 246             Gets the health status of the component that was checked.\r
 247             </summary>\r
 248         </member>\r
 249         <member name="P:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReportEntry.Tags">\r
 250             <summary>\r
 251             Gets the tags associated with the health check.\r
 252             </summary>\r
 253         </member>\r
 254         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus">\r
 255             <summary>\r
 256             Represents the reported status of a health check result.\r
 257             </summary>\r
 258             <remarks>\r
 259             <para>\r
 260             A status of <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> should be considered the default value for a failing health check. Application\r
 261             developers may configure a health check to report a different status as desired.\r
 262             </para>\r
 263             <para>\r
 264             The values of this enum or ordered from least healthy to most healthy. So <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Degraded"/> is\r
 265             greater than <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy"/> but less than <see cref="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Healthy"/>.\r
 266             </para>\r
 267             </remarks>\r
 268         </member>\r
 269         <member name="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Unhealthy">\r
 270             <summary>\r
 271             Indicates that the health check determined that the component was unhealthy, or an unhandled\r
 272             exception was thrown while executing the health check.\r
 273             </summary>\r
 274         </member>\r
 275         <member name="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Degraded">\r
 276             <summary>\r
 277             Indicates that the health check determined that the component was in a degraded state.\r
 278             </summary>\r
 279         </member>\r
 280         <member name="F:Microsoft.Extensions.Diagnostics.HealthChecks.HealthStatus.Healthy">\r
 281             <summary>\r
 282             Indicates that the health check determined that the component was healthy.\r
 283             </summary>\r
 284         </member>\r
 285         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck">\r
 286             <summary>\r
 287             Represents a health check, which can be used to check the status of a component in the application, such as a backend service, database or some internal\r
 288             state.\r
 289             </summary>\r
 290         </member>\r
 291         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheck.CheckHealthAsync(Microsoft.Extensions.Diagnostics.HealthChecks.HealthCheckContext,System.Threading.CancellationToken)">\r
 292             <summary>\r
 293             Runs the health check, returning the status of the component being checked.\r
 294             </summary>\r
 295             <param name="context">A context object associated with the current execution.</param>\r
 296             <param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken"/> that can be used to cancel the health check.</param>\r
 297             <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>\r
 298         </member>\r
 299         <member name="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher">\r
 300             <summary>\r
 301             Represents a publisher of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/> information.\r
 302             </summary>\r
 303             <remarks>\r
 304             <para>\r
 305             The default health checks implementation provided an <c>IHostedService</c> implementation that can\r
 306             be used to execute health checks at regular intervals and provide the resulting <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/>\r
 307             data to all registered <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/> instances.\r
 308             </para>\r
 309             <para>\r
 310             To provide an <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/> implementation, register an instance or type as a singleton\r
 311             service in the dependency injection container.\r
 312             </para>\r
 313             <para>\r
 314             <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/> instances are provided with a <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/> after executing\r
 315             health checks in a background thread. The use of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/> depend on hosting in\r
 316             an application using <c>IWebHost</c> or generic host (<c>IHost</c>). Execution of <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher"/>\r
 317             instance is not related to execution of health checks via a middleware.\r
 318             </para>\r
 319             </remarks>\r
 320         </member>\r
 321         <member name="M:Microsoft.Extensions.Diagnostics.HealthChecks.IHealthCheckPublisher.PublishAsync(Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport,System.Threading.CancellationToken)">\r
 322             <summary>\r
 323             Publishes the provided <paramref name="report"/>.\r
 324             </summary>\r
 325             <param name="report">The <see cref="T:Microsoft.Extensions.Diagnostics.HealthChecks.HealthReport"/>. The result of executing a set of health checks.</param>\r
 326             <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken"/>.</param>\r
 327             <returns>A <see cref="T:System.Threading.Tasks.Task"/> which will complete when publishing is complete.</returns>\r
 328         </member>\r
 329     </members>\r
 330 </doc>\r