Class HostingReadiness
Describes a hosting manager's readiness to deploy a cluster.
Namespace: Neon.Kube.Hosting
Assembly: Neon.Kube.dll
Syntax
public class HostingReadinessProperties
IsReady
Set to true when the hosting manager has verified that the
environment is ready to deploy the cluster or false when there
are one or more problems. This is initialized to true by the
constructor and will be set to false when problems are added.
Declaration
public bool IsReady { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Problems
Lists any detected problems.
Declaration
public IReadOnlyList<HostingReadinessProblem> Problems { get; }Property Value
| Type | Description |
|---|---|
| IReadOnlyList<HostingReadinessProblem> |
Methods
AddProblem(string, string)
Adds a problem to the instance and also set IsReady=false.
Declaration
public void AddProblem(string type, string details)Parameters
| Type | Name | Description |
|---|---|---|
| string | type | Specifies the problem type. |
| string | details | Specifies the problem details. |
ThrowIfNotReady()
Throws a HostingReadinessException including this instance when the hosting manager isn't ready.
Declaration
public void ThrowIfNotReady()ToString()
Renders any problems into a string suitable for use as an exception message.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| string | The formatted string. |