Class Check

java.lang.Object
software.amazon.awssdk.services.evs.model.Check
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Check.Builder,Check>
@Generated("software.amazon.awssdk:codegen") public final class Check extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Check.Builder,Check>

A check on the environment to identify environment health and validate VMware VCF licensing compliance.

See Also:

  • Method Details

    • type

      public final CheckType type()

      The check type. Amazon EVS performs the following checks:

      • KEY_REUSE: Verifies that the VCF license key is not used by another Amazon EVS environment.

      • KEY_COVERAGE: Verifies that the VCF license key allocates sufficient vCPU cores for all deployed hosts.

      • REACHABILITY: Verifies that the Amazon EVS control plane has a persistent connection to SDDC Manager.

      • HOST_COUNT: Verifies that the environment meets the minimum host count.

      • VCENTER_REACHABILITY: Verifies vCenter Server reachability through the vCenter connector.

      • VCENTER_VM_SYNC: Verifies that the vCenter connector can synchronize VM inventory from vCenter Server.

      • VCENTER_VM_EVENT: Verifies that the vCenter connector can receive VM lifecycle events from vCenter Server.

      • OPERATIONS_MANAGER_REACHABILITY: Verifies Operations Manager reachability through the Operations Manager connector.

      • SDDC_MANAGER_REACHABILITY: Verifies SDDC Manager reachability through the SDDC Manager connector.

      • SDDC_MANAGER_HOST_COUNT: Verifies that the host count reported by SDDC Manager meets Amazon EVS minimum requirements.

      • SDDC_MANAGER_KEY_COVERAGE: Verifies that the VCF license key configured in SDDC Manager covers all deployed hosts.

      • SDDC_MANAGER_KEY_REUSE: Verifies that the VCF license key configured in SDDC Manager is not used by another Amazon EVS environment.

      • CONNECTOR_HEALTH: Aggregate health across all connectors in the environment.

      If the service returns an enum value that is not available in the current SDK version, type will return CheckType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The check type. Amazon EVS performs the following checks:

      • KEY_REUSE: Verifies that the VCF license key is not used by another Amazon EVS environment.

      • KEY_COVERAGE: Verifies that the VCF license key allocates sufficient vCPU cores for all deployed hosts.

      • REACHABILITY: Verifies that the Amazon EVS control plane has a persistent connection to SDDC Manager.

      • HOST_COUNT: Verifies that the environment meets the minimum host count.

      • VCENTER_REACHABILITY: Verifies vCenter Server reachability through the vCenter connector.

      • VCENTER_VM_SYNC: Verifies that the vCenter connector can synchronize VM inventory from vCenter Server.

      • VCENTER_VM_EVENT: Verifies that the vCenter connector can receive VM lifecycle events from vCenter Server.

      • OPERATIONS_MANAGER_REACHABILITY: Verifies Operations Manager reachability through the Operations Manager connector.

      • SDDC_MANAGER_REACHABILITY: Verifies SDDC Manager reachability through the SDDC Manager connector.

      • SDDC_MANAGER_HOST_COUNT: Verifies that the host count reported by SDDC Manager meets Amazon EVS minimum requirements.

      • SDDC_MANAGER_KEY_COVERAGE: Verifies that the VCF license key configured in SDDC Manager covers all deployed hosts.

      • SDDC_MANAGER_KEY_REUSE: Verifies that the VCF license key configured in SDDC Manager is not used by another Amazon EVS environment.

      • CONNECTOR_HEALTH: Aggregate health across all connectors in the environment.

      See Also:

    • typeAsString

      public final String typeAsString()

      The check type. Amazon EVS performs the following checks:

      • KEY_REUSE: Verifies that the VCF license key is not used by another Amazon EVS environment.

      • KEY_COVERAGE: Verifies that the VCF license key allocates sufficient vCPU cores for all deployed hosts.

      • REACHABILITY: Verifies that the Amazon EVS control plane has a persistent connection to SDDC Manager.

      • HOST_COUNT: Verifies that the environment meets the minimum host count.

      • VCENTER_REACHABILITY: Verifies vCenter Server reachability through the vCenter connector.

      • VCENTER_VM_SYNC: Verifies that the vCenter connector can synchronize VM inventory from vCenter Server.

      • VCENTER_VM_EVENT: Verifies that the vCenter connector can receive VM lifecycle events from vCenter Server.

      • OPERATIONS_MANAGER_REACHABILITY: Verifies Operations Manager reachability through the Operations Manager connector.

      • SDDC_MANAGER_REACHABILITY: Verifies SDDC Manager reachability through the SDDC Manager connector.

      • SDDC_MANAGER_HOST_COUNT: Verifies that the host count reported by SDDC Manager meets Amazon EVS minimum requirements.

      • SDDC_MANAGER_KEY_COVERAGE: Verifies that the VCF license key configured in SDDC Manager covers all deployed hosts.

      • SDDC_MANAGER_KEY_REUSE: Verifies that the VCF license key configured in SDDC Manager is not used by another Amazon EVS environment.

      • CONNECTOR_HEALTH: Aggregate health across all connectors in the environment.

      If the service returns an enum value that is not available in the current SDK version, type will return CheckType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

      Returns:
      The check type. Amazon EVS performs the following checks:

      • KEY_REUSE: Verifies that the VCF license key is not used by another Amazon EVS environment.

      • KEY_COVERAGE: Verifies that the VCF license key allocates sufficient vCPU cores for all deployed hosts.

      • REACHABILITY: Verifies that the Amazon EVS control plane has a persistent connection to SDDC Manager.

      • HOST_COUNT: Verifies that the environment meets the minimum host count.

      • VCENTER_REACHABILITY: Verifies vCenter Server reachability through the vCenter connector.

      • VCENTER_VM_SYNC: Verifies that the vCenter connector can synchronize VM inventory from vCenter Server.

      • VCENTER_VM_EVENT: Verifies that the vCenter connector can receive VM lifecycle events from vCenter Server.

      • OPERATIONS_MANAGER_REACHABILITY: Verifies Operations Manager reachability through the Operations Manager connector.

      • SDDC_MANAGER_REACHABILITY: Verifies SDDC Manager reachability through the SDDC Manager connector.

      • SDDC_MANAGER_HOST_COUNT: Verifies that the host count reported by SDDC Manager meets Amazon EVS minimum requirements.

      • SDDC_MANAGER_KEY_COVERAGE: Verifies that the VCF license key configured in SDDC Manager covers all deployed hosts.

      • SDDC_MANAGER_KEY_REUSE: Verifies that the VCF license key configured in SDDC Manager is not used by another Amazon EVS environment.

      • CONNECTOR_HEALTH: Aggregate health across all connectors in the environment.

      See Also:

    • id

      public final String id()

      A unique ID for the check.

      Returns:
      A unique ID for the check.

    • result

      public final CheckResult result()

      The check result.

      If the service returns an enum value that is not available in the current SDK version, result will return CheckResult.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resultAsString().

      Returns:
      The check result.
      See Also:

    • resultAsString

      public final String resultAsString()

      The check result.

      If the service returns an enum value that is not available in the current SDK version, result will return CheckResult.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resultAsString().

      Returns:
      The check result.
      See Also:

    • impairedSince

      public final Instant impairedSince()

      The time when environment health began to be impaired.

      Returns:
      The time when environment health began to be impaired.

    • toBuilder

      public Check.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Check.Builder,Check>
      Returns:
      a builder for type T

    • builder

      public static Check.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Check.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.