Package com.vmware.nsx_policy.infra.sha.dynamic_runbooks

Interface Help

  • All Superinterfaces:
    HelpTypes, com.vmware.vapi.bindings.Service
    All Known Implementing Classes:
    HelpStub
    public interface Help
extends com.vmware.vapi.bindings.Service, HelpTypes

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      OdsRunbookHelpInfo get​(java.lang.String runbookId)
      Read help information of an Online Diagnostic System Dynamic Runbook.
      void get​(java.lang.String runbookId, com.vmware.vapi.bindings.client.AsyncCallback<OdsRunbookHelpInfo> asyncCallback)
      Read help information of an Online Diagnostic System Dynamic Runbook.
      void get​(java.lang.String runbookId, com.vmware.vapi.bindings.client.AsyncCallback<OdsRunbookHelpInfo> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read help information of an Online Diagnostic System Dynamic Runbook.
      OdsRunbookHelpInfo get​(java.lang.String runbookId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read help information of an Online Diagnostic System Dynamic Runbook.

    • Method Detail

      • get

        OdsRunbookHelpInfo get​(java.lang.String runbookId)
        Read help information of an Online Diagnostic System Dynamic Runbook.

        Synchronous method overload. Result of the invocation will be reported as a method return value.

        Parameters:
        runbookId - Identifier of a Dynamic Runbook (required)
        Returns:
        com.vmware.nsx_policy.model.OdsRunbookHelpInfo
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • get

        OdsRunbookHelpInfo get​(java.lang.String runbookId,
                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Read help information of an Online Diagnostic System Dynamic Runbook.

        Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

        Parameters:
        runbookId - Identifier of a Dynamic Runbook (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.OdsRunbookHelpInfo
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • get

        void get​(java.lang.String runbookId,
         com.vmware.vapi.bindings.client.AsyncCallback<OdsRunbookHelpInfo> asyncCallback)
        Read help information of an Online Diagnostic System Dynamic Runbook.

        Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

        Invocation Result:
        com.vmware.nsx_policy.model.OdsRunbookHelpInfo

        Operation Errors:
        InvalidRequest - Bad Request, Precondition Failed
        Unauthorized - Forbidden
        ServiceUnavailable - Service Unavailable
        InternalServerError - Internal Server Error
        NotFound - Not Found

        Parameters:
        runbookId - Identifier of a Dynamic Runbook (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • get

        void get​(java.lang.String runbookId,
         com.vmware.vapi.bindings.client.AsyncCallback<OdsRunbookHelpInfo> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Read help information of an Online Diagnostic System Dynamic Runbook.

        Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

        Invocation Result:
        com.vmware.nsx_policy.model.OdsRunbookHelpInfo

        Operation Errors:
        InvalidRequest - Bad Request, Precondition Failed
        Unauthorized - Forbidden
        ServiceUnavailable - Service Unavailable
        InternalServerError - Internal Server Error
        NotFound - Not Found

        Parameters:
        runbookId - Identifier of a Dynamic Runbook (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.