com.vmware.nsx_policy.infra.sha.pre_defined_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

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.sha.pre_defined_runbooks.HelpTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
OdsRunbookHelpInfo	get(java.lang.String runbookId) Read help information of an Online Diagnostic System predefined runbook.
void	get(java.lang.String runbookId, com.vmware.vapi.bindings.client.AsyncCallback<OdsRunbookHelpInfo> asyncCallback) Read help information of an Online Diagnostic System predefined 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 predefined runbook.
OdsRunbookHelpInfo	get(java.lang.String runbookId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read help information of an Online Diagnostic System predefined runbook.

Method Detail

get

OdsRunbookHelpInfo get(java.lang.String runbookId)

Read help information of an Online Diagnostic System predefined runbook.

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

Parameters:

runbookId - Identifier of a predefined 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 predefined 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 predefined 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 predefined 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 predefined 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 predefined 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 predefined runbook (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.