com.vmware.nsx_policy.infra.sha

Interface PreDefinedRunbooks

All Superinterfaces:

PreDefinedRunbooksTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

PreDefinedRunbooksStub

public interface PreDefinedRunbooks
extends com.vmware.vapi.bindings.Service, PreDefinedRunbooksTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.infra.sha.PreDefinedRunbooksTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
OdsPredefinedRunbook	get(java.lang.String runbookId) Read Online Diagnostic System predefined runbook.
void	get(java.lang.String runbookId, com.vmware.vapi.bindings.client.AsyncCallback<OdsPredefinedRunbook> asyncCallback) Read Online Diagnostic System predefined runbook.
void	get(java.lang.String runbookId, com.vmware.vapi.bindings.client.AsyncCallback<OdsPredefinedRunbook> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read Online Diagnostic System predefined runbook.
OdsPredefinedRunbook	get(java.lang.String runbookId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read Online Diagnostic System predefined runbook.
OdsPredefinedRunbookListResult	list(java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) List Online Diagnostic System predefined runbooks.
void	list(java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<OdsPredefinedRunbookListResult> asyncCallback) List Online Diagnostic System predefined runbooks.
void	list(java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<OdsPredefinedRunbookListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List Online Diagnostic System predefined runbooks.
OdsPredefinedRunbookListResult	list(java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) List Online Diagnostic System predefined runbooks.

Method Detail

get

OdsPredefinedRunbook get(java.lang.String runbookId)

Read 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.OdsPredefinedRunbook

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

OdsPredefinedRunbook get(java.lang.String runbookId,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read 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.OdsPredefinedRunbook

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<OdsPredefinedRunbook> asyncCallback)

Read 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.OdsPredefinedRunbook

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<OdsPredefinedRunbook> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read 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.OdsPredefinedRunbook

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.

list

OdsPredefinedRunbookListResult list(java.lang.String cursor,
                                    java.lang.Boolean includeMarkForDeleteObjects,
                                    java.lang.String includedFields,
                                    java.lang.Long pageSize,
                                    java.lang.Boolean sortAscending,
                                    java.lang.String sortBy)

List Online Diagnostic System predefined runbooks.

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

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

Returns:

com.vmware.nsx_policy.model.OdsPredefinedRunbookListResult

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

list

OdsPredefinedRunbookListResult list(java.lang.String cursor,
                                    java.lang.Boolean includeMarkForDeleteObjects,
                                    java.lang.String includedFields,
                                    java.lang.Long pageSize,
                                    java.lang.Boolean sortAscending,
                                    java.lang.String sortBy,
                                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List Online Diagnostic System predefined runbooks.

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:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.OdsPredefinedRunbookListResult

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

list

void list(java.lang.String cursor,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<OdsPredefinedRunbookListResult> asyncCallback)

List Online Diagnostic System predefined runbooks.

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

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

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

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

list

void list(java.lang.String cursor,
          java.lang.Boolean includeMarkForDeleteObjects,
          java.lang.String includedFields,
          java.lang.Long pageSize,
          java.lang.Boolean sortAscending,
          java.lang.String sortBy,
          com.vmware.vapi.bindings.client.AsyncCallback<OdsPredefinedRunbookListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

List Online Diagnostic System predefined runbooks.

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.OdsPredefinedRunbookListResult

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

Parameters:

cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)

includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)

includedFields - Comma separated list of fields that should be included in query result (optional)

pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)

sortAscending - (optional)

sortBy - Field by which records are sorted (optional)

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

invocationConfig - Configuration for the method invocation.