com.vmware.nsx_policy.infra.sha

Interface RunbookInvocations

All Superinterfaces:

RunbookInvocationsTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

RunbookInvocationsStub

public interface RunbookInvocations
extends com.vmware.vapi.bindings.Service, RunbookInvocationsTypes

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
void	create(java.lang.String invocationId, OdsRunbookInvocation odsRunbookInvocation) Synchronous method overload.
void	create(java.lang.String invocationId, OdsRunbookInvocation odsRunbookInvocation, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Asynchronous method overload.
void	create(java.lang.String invocationId, OdsRunbookInvocation odsRunbookInvocation, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Asynchronous method overload.
void	create(java.lang.String invocationId, OdsRunbookInvocation odsRunbookInvocation, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Synchronous method overload.
void	delete(java.lang.String invocationId) Delete an Online Diagnostic System runbook invocation with the specified identifier.
void	delete(java.lang.String invocationId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback) Delete an Online Diagnostic System runbook invocation with the specified identifier.
void	delete(java.lang.String invocationId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete an Online Diagnostic System runbook invocation with the specified identifier.
void	delete(java.lang.String invocationId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Delete an Online Diagnostic System runbook invocation with the specified identifier.
OdsRunbookInvocation	get(java.lang.String invocationId) Read an Online Diagnostic System runbook invocation with the specified identifier.
void	get(java.lang.String invocationId, com.vmware.vapi.bindings.client.AsyncCallback<OdsRunbookInvocation> asyncCallback) Read an Online Diagnostic System runbook invocation with the specified identifier.
void	get(java.lang.String invocationId, com.vmware.vapi.bindings.client.AsyncCallback<OdsRunbookInvocation> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read an Online Diagnostic System runbook invocation with the specified identifier.
OdsRunbookInvocation	get(java.lang.String invocationId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Read an Online Diagnostic System runbook invocation with the specified identifier.
OdsRunbookInvocationListResult	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) Get a paginated list of Online Diagnostic System runbook invocation entities.
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<OdsRunbookInvocationListResult> asyncCallback) Get a paginated list of Online Diagnostic System runbook invocation entities.
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<OdsRunbookInvocationListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Get a paginated list of Online Diagnostic System runbook invocation entities.
OdsRunbookInvocationListResult	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) Get a paginated list of Online Diagnostic System runbook invocation entities.

Method Detail

create

void create(java.lang.String invocationId,
            OdsRunbookInvocation odsRunbookInvocation)

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

Parameters:

invocationId - (required)

odsRunbookInvocation - (required)

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

create

void create(java.lang.String invocationId,
            OdsRunbookInvocation odsRunbookInvocation,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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:

invocationId - (required)

odsRunbookInvocation - (required)

invocationConfig - Configuration for the method invocation.

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

create

void create(java.lang.String invocationId,
            OdsRunbookInvocation odsRunbookInvocation,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

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

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

Parameters:

invocationId - (required)

odsRunbookInvocation - (required)

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

create

void create(java.lang.String invocationId,
            OdsRunbookInvocation odsRunbookInvocation,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

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

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

Parameters:

invocationId - (required)

odsRunbookInvocation - (required)

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String invocationId)

Delete an Online Diagnostic System runbook invocation with the specified identifier.

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

Parameters:

invocationId - (required)

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

delete

void delete(java.lang.String invocationId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete an Online Diagnostic System runbook invocation with the specified identifier.

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:

invocationId - (required)

invocationConfig - Configuration for the method invocation.

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

delete

void delete(java.lang.String invocationId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)

Delete an Online Diagnostic System runbook invocation with the specified identifier.

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

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

Parameters:

invocationId - (required)

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

delete

void delete(java.lang.String invocationId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Delete an Online Diagnostic System runbook invocation with the specified identifier.

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

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

Parameters:

invocationId - (required)

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

invocationConfig - Configuration for the method invocation.

get

OdsRunbookInvocation get(java.lang.String invocationId)

Read an Online Diagnostic System runbook invocation with the specified identifier.

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

Parameters:

invocationId - (required)

Returns:

com.vmware.nsx_policy.model.OdsRunbookInvocation

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

OdsRunbookInvocation get(java.lang.String invocationId,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read an Online Diagnostic System runbook invocation with the specified identifier.

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:

invocationId - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.OdsRunbookInvocation

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 invocationId,
         com.vmware.vapi.bindings.client.AsyncCallback<OdsRunbookInvocation> asyncCallback)

Read an Online Diagnostic System runbook invocation with the specified identifier.

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

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

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

Parameters:

invocationId - (required)

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

get

void get(java.lang.String invocationId,
         com.vmware.vapi.bindings.client.AsyncCallback<OdsRunbookInvocation> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Read an Online Diagnostic System runbook invocation with the specified identifier.

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

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

Parameters:

invocationId - (required)

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

invocationConfig - Configuration for the method invocation.

list

OdsRunbookInvocationListResult 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)

Get a paginated list of Online Diagnostic System runbook invocation entities.

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

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

OdsRunbookInvocationListResult 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)

Get a paginated list of Online Diagnostic System runbook invocation entities.

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

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

Get a paginated list of Online Diagnostic System runbook invocation entities.

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

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

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

Get a paginated list of Online Diagnostic System runbook invocation entities.

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

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.