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

Class HelpStub

  • All Implemented Interfaces:
    Help, HelpTypes, com.vmware.vapi.bindings.Service
    public class HelpStub
extends com.vmware.vapi.internal.bindings.Stub
implements Help
    Remote stub implementation of the Help API service.

    WARNING: Internal class, subject to change in future versions.

    • Field Summary

      • Fields inherited from class com.vmware.vapi.internal.bindings.Stub

        apiProvider, converter, ifaceId, retryPolicy, securityContext

    • Constructor Summary

      Constructors 
      Constructor Description
      HelpStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)  
      HelpStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)  

    • Method Summary

      All Methods Instance Methods Concrete 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.

      • Methods inherited from class com.vmware.vapi.internal.bindings.Stub

        invokeMethod, invokeMethodAsync, invokeStreamMethod, toString

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • HelpStub

        public HelpStub​(com.vmware.vapi.core.ApiProvider apiProvider,
                com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                com.vmware.vapi.bindings.StubConfigurationBase config)

      • HelpStub

        public HelpStub​(com.vmware.vapi.core.ApiProvider apiProvider,
                com.vmware.vapi.bindings.StubConfigurationBase config)

    • Method Detail

      • get

        public OdsRunbookHelpInfo get​(java.lang.String runbookId)
        Description copied from interface: Help
        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.

        Specified by:
        get in interface Help
        Parameters:
        runbookId - Identifier of a Dynamic Runbook (required)
        Returns:
        com.vmware.nsx_policy.model.OdsRunbookHelpInfo

      • get

        public OdsRunbookHelpInfo get​(java.lang.String runbookId,
                              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Help
        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.

        Specified by:
        get in interface Help
        Parameters:
        runbookId - Identifier of a Dynamic Runbook (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.OdsRunbookHelpInfo

      • get

        public void get​(java.lang.String runbookId,
                com.vmware.vapi.bindings.client.AsyncCallback<OdsRunbookHelpInfo> asyncCallback)
        Description copied from interface: Help
        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

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

      • get

        public void get​(java.lang.String runbookId,
                com.vmware.vapi.bindings.client.AsyncCallback<OdsRunbookHelpInfo> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Help
        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

        Specified by:
        get in interface Help
        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.