com.vmware.nsx.cluster.restore

Interface InstructionResources

All Superinterfaces:

InstructionResourcesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

InstructionResourcesStub

public interface InstructionResources
extends com.vmware.vapi.bindings.Service, InstructionResourcesTypes

Field Summary

Fields inherited from interface com.vmware.nsx.cluster.restore.InstructionResourcesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ActionableResourceListResult	get(java.lang.String instructionId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy) For restore operations requiring user input e.g.
void	get(java.lang.String instructionId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ActionableResourceListResult> asyncCallback) For restore operations requiring user input e.g.
void	get(java.lang.String instructionId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<ActionableResourceListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) For restore operations requiring user input e.g.
ActionableResourceListResult	get(java.lang.String instructionId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) For restore operations requiring user input e.g.

Method Detail

get

ActionableResourceListResult get(java.lang.String instructionId,
                                 java.lang.String cursor,
                                 java.lang.String includedFields,
                                 java.lang.Long pageSize,
                                 java.lang.Boolean sortAscending,
                                 java.lang.String sortBy)

For restore operations requiring user input e.g. performing an action, accepting/rejecting an action, etc. the information to be conveyed to users is provided in this call.

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

Parameters:

instructionId - Id of the instruction set whose instructions are to be returned (required)

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

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.model.ActionableResourceListResult

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

ActionableResourceListResult get(java.lang.String instructionId,
                                 java.lang.String cursor,
                                 java.lang.String includedFields,
                                 java.lang.Long pageSize,
                                 java.lang.Boolean sortAscending,
                                 java.lang.String sortBy,
                                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

For restore operations requiring user input e.g. performing an action, accepting/rejecting an action, etc. the information to be conveyed to users is provided in this call.

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:

instructionId - Id of the instruction set whose instructions are to be returned (required)

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

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.model.ActionableResourceListResult

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 instructionId,
         java.lang.String cursor,
         java.lang.String includedFields,
         java.lang.Long pageSize,
         java.lang.Boolean sortAscending,
         java.lang.String sortBy,
         com.vmware.vapi.bindings.client.AsyncCallback<ActionableResourceListResult> asyncCallback)

For restore operations requiring user input e.g. performing an action, accepting/rejecting an action, etc. the information to be conveyed to users is provided in this call.

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

Invocation Result:
com.vmware.nsx.model.ActionableResourceListResult

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

Parameters:

instructionId - Id of the instruction set whose instructions are to be returned (required)

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

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.

get

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

For restore operations requiring user input e.g. performing an action, accepting/rejecting an action, etc. the information to be conveyed to users is provided in this call.

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.model.ActionableResourceListResult

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

Parameters:

instructionId - Id of the instruction set whose instructions are to be returned (required)

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

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.