Package com.vmware.vapi.std.errors

Class ServiceUnavailable

  • All Implemented Interfaces:
    StaticStructure, Structure, java.io.Serializable
    public class ServiceUnavailable
extends Error
implements java.io.Serializable, StaticStructure
    The ServiceUnavailable exception indicates that the interface is unavailable.

    Examples:

    • Attempt to invoke a method when the server is too busy.
    • Attempt to invoke a method when the server is undergoing maintenance.
    • An method fails to contact VMware Tools running inside the virtual machine.

    Counterexamples:

    • A client provides an invalid service or operation identifier when invoking the method using a dynamic interface (for example REST). The OperationNotFound exception would be used instead.
    • A client invokes the method from the interface, but that interface has not been installed. The OperationNotFound exception would be used instead.
    See Also:
    Serialized Form

    • Constructor Detail

      • ServiceUnavailable

        public ServiceUnavailable​(java.util.List<LocalizableMessage> messages,
                          Structure data)
        This constructor is provided for backwards compatibility purposes only. Please use the Builder class instead.

      • ServiceUnavailable

        public ServiceUnavailable()
        Default constructor.

      • ServiceUnavailable

        protected ServiceUnavailable​(StructValue __dynamicStructureFields)

      • ServiceUnavailable

        protected ServiceUnavailable​(StructValue __dynamicStructureFields,
                             Error.Type errorType)

    • Method Detail

      • _getType

        public com.vmware.vapi.bindings.type.ErrorType _getType()
        Description copied from interface: StaticStructure
        WARNING: Internal method, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.
        Specified by:
        _getType in interface StaticStructure
        Overrides:
        _getType in class Error
        Returns:
        the static bindings StructType

      • _getDataValue

        public StructValue _getDataValue()
        Description copied from interface: Structure
        Returns this Structure represented in the dynamic DataValue model.

        Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.

        Specified by:
        _getDataValue in interface Structure
        Overrides:
        _getDataValue in class Error
        Returns:
        StructValue representing this structure

      • _validate

        public void _validate()
        Description copied from interface: StaticStructure
        Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.

        More precisely, for each union: given value of the discriminant/tag field (@UnionTag in the IDL) of an union in this structure, validates that:

      • all fields of the union required for that value of the discriminant are set
      • fields of the union that are not allowed for that value of the discriminant are not set
      • any other fields of the structure (not participating in the union) do not affect the validation result
Specified by:
_validate in interface StaticStructure
Overrides:
_validate in class Error