com.vmware.nsx.cluster.restore

Class InstructionResourcesStub

java.lang.Object

com.vmware.vapi.internal.bindings.Stub

com.vmware.nsx.cluster.restore.InstructionResourcesStub

All Implemented Interfaces:

InstructionResources, InstructionResourcesTypes, com.vmware.vapi.bindings.Service

public class InstructionResourcesStub
extends com.vmware.vapi.internal.bindings.Stub
implements InstructionResources

Remote stub implementation of the InstructionResources 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

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

_VAPI_SERVICE_ID

Constructor Summary

Constructors

Constructor and Description
InstructionResourcesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)
InstructionResourcesStub(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)

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.

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

InstructionResourcesStub

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

InstructionResourcesStub

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

Method Detail

get

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

Description copied from interface: InstructionResources

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.

Specified by:

get in interface InstructionResources

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

get

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

Description copied from interface: InstructionResources

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.

Specified by:

get in interface InstructionResources

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

get

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

Description copied from interface: InstructionResources

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

Specified by:

get in interface InstructionResources

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

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

Description copied from interface: InstructionResources

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

Specified by:

get in interface InstructionResources

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.