Package com.vmware.nsx_policy.cluster

Class RestoreStub

  • All Implemented Interfaces:
    Restore, RestoreTypes, com.vmware.vapi.bindings.Service
    public class RestoreStub
extends com.vmware.vapi.internal.bindings.Stub
implements Restore
    Remote stub implementation of the Restore 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

    • Constructor Summary

      Constructors 
      Constructor Description
      RestoreStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)  
      RestoreStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ClusterRestoreStatus advance​(AdvanceClusterRestoreRequest advanceClusterRestoreRequest)
      Advance any currently suspended restore operation.
      void advance​(AdvanceClusterRestoreRequest advanceClusterRestoreRequest, com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
      Advance any currently suspended restore operation.
      void advance​(AdvanceClusterRestoreRequest advanceClusterRestoreRequest, com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Advance any currently suspended restore operation.
      ClusterRestoreStatus advance​(AdvanceClusterRestoreRequest advanceClusterRestoreRequest, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Advance any currently suspended restore operation.
      ClusterRestoreStatus cancel()
      This operation is only valid when a restore is in suspended state.
      void cancel​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
      This operation is only valid when a restore is in suspended state.
      void cancel​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      This operation is only valid when a restore is in suspended state.
      ClusterRestoreStatus cancel​(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      This operation is only valid when a restore is in suspended state.
      ClusterRestoreStatus retry()
      Retry any currently in-progress, failed restore operation.
      void retry​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
      Retry any currently in-progress, failed restore operation.
      void retry​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Retry any currently in-progress, failed restore operation.
      ClusterRestoreStatus retry​(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Retry any currently in-progress, failed restore operation.
      ClusterRestoreStatus start​(InitiateClusterRestoreRequest initiateClusterRestoreRequest)
      Start the restore of an NSX cluster, from some previously backed-up configuration.
      void start​(InitiateClusterRestoreRequest initiateClusterRestoreRequest, com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
      Start the restore of an NSX cluster, from some previously backed-up configuration.
      void start​(InitiateClusterRestoreRequest initiateClusterRestoreRequest, com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Start the restore of an NSX cluster, from some previously backed-up configuration.
      ClusterRestoreStatus start​(InitiateClusterRestoreRequest initiateClusterRestoreRequest, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Start the restore of an NSX cluster, from some previously backed-up configuration.
      ClusterRestoreStatus suspend()
      Suspend any currently running restore operation.
      void suspend​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
      Suspend any currently running restore operation.
      void suspend​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Suspend any currently running restore operation.
      ClusterRestoreStatus suspend​(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Suspend any currently running restore operation.

      • 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

      • RestoreStub

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

      • RestoreStub

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

    • Method Detail

      • advance

        public ClusterRestoreStatus advance​(AdvanceClusterRestoreRequest advanceClusterRestoreRequest)
        Description copied from interface: Restore
        Advance any currently suspended restore operation. The operation might have been suspended because (1) the user had suspended it previously, or (2) the operation is waiting for user input, to be provided as a part of the POST request body. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED. Otherwise, a 409 response is returned.

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

        Specified by:
        advance in interface Restore
        Parameters:
        advanceClusterRestoreRequest - (required)
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

      • advance

        public ClusterRestoreStatus advance​(AdvanceClusterRestoreRequest advanceClusterRestoreRequest,
                                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Restore
        Advance any currently suspended restore operation. The operation might have been suspended because (1) the user had suspended it previously, or (2) the operation is waiting for user input, to be provided as a part of the POST request body. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED. Otherwise, a 409 response is returned.

        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:
        advance in interface Restore
        Parameters:
        advanceClusterRestoreRequest - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

      • advance

        public void advance​(AdvanceClusterRestoreRequest advanceClusterRestoreRequest,
                    com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
        Description copied from interface: Restore
        Advance any currently suspended restore operation. The operation might have been suspended because (1) the user had suspended it previously, or (2) the operation is waiting for user input, to be provided as a part of the POST request body. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED. Otherwise, a 409 response is returned.

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

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

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

        Specified by:
        advance in interface Restore
        Parameters:
        advanceClusterRestoreRequest - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • advance

        public void advance​(AdvanceClusterRestoreRequest advanceClusterRestoreRequest,
                    com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Restore
        Advance any currently suspended restore operation. The operation might have been suspended because (1) the user had suspended it previously, or (2) the operation is waiting for user input, to be provided as a part of the POST request body. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED. Otherwise, a 409 response is returned.

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

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

        Specified by:
        advance in interface Restore
        Parameters:
        advanceClusterRestoreRequest - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • cancel

        public ClusterRestoreStatus cancel()
        Description copied from interface: Restore
        This operation is only valid when a restore is in suspended state. The UI user can cancel any restore operation when the restore is suspended either due to an error, or for a user input. The API user would need to monitor the progression of a restore by calling periodically \"/api/v1/cluster/restore/status\" API. The response object (ClusterRestoreStatus), contains a field \"endpoints\". The API user can cancel the restore process if 'cancel' action is shown in the endpoint field. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED.

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

        Specified by:
        cancel in interface Restore
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

      • cancel

        public ClusterRestoreStatus cancel​(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Restore
        This operation is only valid when a restore is in suspended state. The UI user can cancel any restore operation when the restore is suspended either due to an error, or for a user input. The API user would need to monitor the progression of a restore by calling periodically \"/api/v1/cluster/restore/status\" API. The response object (ClusterRestoreStatus), contains a field \"endpoints\". The API user can cancel the restore process if 'cancel' action is shown in the endpoint field. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED.

        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:
        cancel in interface Restore
        Parameters:
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

      • cancel

        public void cancel​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
        Description copied from interface: Restore
        This operation is only valid when a restore is in suspended state. The UI user can cancel any restore operation when the restore is suspended either due to an error, or for a user input. The API user would need to monitor the progression of a restore by calling periodically \"/api/v1/cluster/restore/status\" API. The response object (ClusterRestoreStatus), contains a field \"endpoints\". The API user can cancel the restore process if 'cancel' action is shown in the endpoint field. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED.

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

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

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

        Specified by:
        cancel in interface Restore
        Parameters:
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • cancel

        public void cancel​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Restore
        This operation is only valid when a restore is in suspended state. The UI user can cancel any restore operation when the restore is suspended either due to an error, or for a user input. The API user would need to monitor the progression of a restore by calling periodically \"/api/v1/cluster/restore/status\" API. The response object (ClusterRestoreStatus), contains a field \"endpoints\". The API user can cancel the restore process if 'cancel' action is shown in the endpoint field. This operation is only valid when a GET cluster/restore/status returns a status with value SUSPENDED.

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

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

        Specified by:
        cancel in interface Restore
        Parameters:
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • retry

        public ClusterRestoreStatus retry()
        Description copied from interface: Restore
        Retry any currently in-progress, failed restore operation. Only the last step of the multi-step restore operation would have failed,and only that step is retried. This operation is only valid when a GET cluster/restore/status returns a status with value FAILED. Otherwise, a 409 response is returned.

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

        Specified by:
        retry in interface Restore
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

      • retry

        public ClusterRestoreStatus retry​(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Restore
        Retry any currently in-progress, failed restore operation. Only the last step of the multi-step restore operation would have failed,and only that step is retried. This operation is only valid when a GET cluster/restore/status returns a status with value FAILED. Otherwise, a 409 response is returned.

        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:
        retry in interface Restore
        Parameters:
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

      • retry

        public void retry​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
        Description copied from interface: Restore
        Retry any currently in-progress, failed restore operation. Only the last step of the multi-step restore operation would have failed,and only that step is retried. This operation is only valid when a GET cluster/restore/status returns a status with value FAILED. Otherwise, a 409 response is returned.

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

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

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

        Specified by:
        retry in interface Restore
        Parameters:
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • retry

        public void retry​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Restore
        Retry any currently in-progress, failed restore operation. Only the last step of the multi-step restore operation would have failed,and only that step is retried. This operation is only valid when a GET cluster/restore/status returns a status with value FAILED. Otherwise, a 409 response is returned.

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

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

        Specified by:
        retry in interface Restore
        Parameters:
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • start

        public ClusterRestoreStatus start​(InitiateClusterRestoreRequest initiateClusterRestoreRequest)
        Description copied from interface: Restore
        Start the restore of an NSX cluster, from some previously backed-up configuration. This operation is only valid when a GET cluster/restore/status returns a status with value NOT_STARTED. Otherwise, a 409 response is returned.

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

        Specified by:
        start in interface Restore
        Parameters:
        initiateClusterRestoreRequest - (required)
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

      • start

        public ClusterRestoreStatus start​(InitiateClusterRestoreRequest initiateClusterRestoreRequest,
                                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Restore
        Start the restore of an NSX cluster, from some previously backed-up configuration. This operation is only valid when a GET cluster/restore/status returns a status with value NOT_STARTED. Otherwise, a 409 response is returned.

        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:
        start in interface Restore
        Parameters:
        initiateClusterRestoreRequest - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

      • start

        public void start​(InitiateClusterRestoreRequest initiateClusterRestoreRequest,
                  com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
        Description copied from interface: Restore
        Start the restore of an NSX cluster, from some previously backed-up configuration. This operation is only valid when a GET cluster/restore/status returns a status with value NOT_STARTED. Otherwise, a 409 response is returned.

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

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

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

        Specified by:
        start in interface Restore
        Parameters:
        initiateClusterRestoreRequest - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • start

        public void start​(InitiateClusterRestoreRequest initiateClusterRestoreRequest,
                  com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Restore
        Start the restore of an NSX cluster, from some previously backed-up configuration. This operation is only valid when a GET cluster/restore/status returns a status with value NOT_STARTED. Otherwise, a 409 response is returned.

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

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

        Specified by:
        start in interface Restore
        Parameters:
        initiateClusterRestoreRequest - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • suspend

        public ClusterRestoreStatus suspend()
        Description copied from interface: Restore
        Suspend any currently running restore operation. The restore operation is made up of a number of steps. When this call is issued, any currently running step is allowed to finish (successfully or with errors), and the next step (and therefore the entire restore operation) is suspended until a subsequent resume or cancel call is issued. This operation is only valid when a GET cluster/restore/status returns a status with value RUNNING. Otherwise, a 409 response is returned.

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

        Specified by:
        suspend in interface Restore
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

      • suspend

        public ClusterRestoreStatus suspend​(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Restore
        Suspend any currently running restore operation. The restore operation is made up of a number of steps. When this call is issued, any currently running step is allowed to finish (successfully or with errors), and the next step (and therefore the entire restore operation) is suspended until a subsequent resume or cancel call is issued. This operation is only valid when a GET cluster/restore/status returns a status with value RUNNING. Otherwise, a 409 response is returned.

        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:
        suspend in interface Restore
        Parameters:
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ClusterRestoreStatus

      • suspend

        public void suspend​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback)
        Description copied from interface: Restore
        Suspend any currently running restore operation. The restore operation is made up of a number of steps. When this call is issued, any currently running step is allowed to finish (successfully or with errors), and the next step (and therefore the entire restore operation) is suspended until a subsequent resume or cancel call is issued. This operation is only valid when a GET cluster/restore/status returns a status with value RUNNING. Otherwise, a 409 response is returned.

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

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

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

        Specified by:
        suspend in interface Restore
        Parameters:
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • suspend

        public void suspend​(com.vmware.vapi.bindings.client.AsyncCallback<ClusterRestoreStatus> asyncCallback,
                    com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Restore
        Suspend any currently running restore operation. The restore operation is made up of a number of steps. When this call is issued, any currently running step is allowed to finish (successfully or with errors), and the next step (and therefore the entire restore operation) is suspended until a subsequent resume or cancel call is issued. This operation is only valid when a GET cluster/restore/status returns a status with value RUNNING. Otherwise, a 409 response is returned.

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

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

        Specified by:
        suspend in interface Restore
        Parameters:
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.