Class VirtualMachinesStub

  • All Implemented Interfaces:
    VirtualMachines, VirtualMachinesTypes, com.vmware.vapi.bindings.Service

    public class VirtualMachinesStub
    extends com.vmware.vapi.internal.bindings.Stub
    implements VirtualMachines
    Remote stub implementation of the VirtualMachines 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
      VirtualMachinesStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)  
      VirtualMachinesStub​(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
      SearchResponse list​(java.lang.String enforcementPointName, java.lang.String cursor, java.lang.String dsl, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String query, java.lang.Boolean sortAscending, java.lang.String sortBy)
      This API filters objects of type virtual machines from the specified NSX Manager.
      void list​(java.lang.String enforcementPointName, java.lang.String cursor, java.lang.String dsl, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String query, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<SearchResponse> asyncCallback)
      This API filters objects of type virtual machines from the specified NSX Manager.
      void list​(java.lang.String enforcementPointName, java.lang.String cursor, java.lang.String dsl, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String query, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<SearchResponse> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      This API filters objects of type virtual machines from the specified NSX Manager.
      SearchResponse list​(java.lang.String enforcementPointName, java.lang.String cursor, java.lang.String dsl, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String query, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      This API filters objects of type virtual machines from the specified NSX Manager.
      void updatetags​(java.lang.String enforcementPointName, VirtualMachineTagsUpdate virtualMachineTagsUpdate)
      Synchronous method overload.
      void updatetags​(java.lang.String enforcementPointName, VirtualMachineTagsUpdate virtualMachineTagsUpdate, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      Asynchronous method overload.
      void updatetags​(java.lang.String enforcementPointName, VirtualMachineTagsUpdate virtualMachineTagsUpdate, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Asynchronous method overload.
      void updatetags​(java.lang.String enforcementPointName, VirtualMachineTagsUpdate virtualMachineTagsUpdate, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Synchronous method overload.
      • 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

      • VirtualMachinesStub

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

        public VirtualMachinesStub​(com.vmware.vapi.core.ApiProvider apiProvider,
                                   com.vmware.vapi.bindings.StubConfigurationBase config)
    • Method Detail

      • list

        public SearchResponse list​(java.lang.String enforcementPointName,
                                   java.lang.String cursor,
                                   java.lang.String dsl,
                                   java.lang.String includedFields,
                                   java.lang.Long pageSize,
                                   java.lang.String query,
                                   java.lang.Boolean sortAscending,
                                   java.lang.String sortBy)
        Description copied from interface: VirtualMachines
        This API filters objects of type virtual machines from the specified NSX Manager.
        This API has been deprecated. Please use the new API GET /infra/realized-state/virtual-machines

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

        Specified by:
        list in interface VirtualMachines
        Parameters:
        enforcementPointName - (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        dsl - Search DSL (domain specific language) query (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)
        query - Search query (optional)
        sortAscending - (optional)
        sortBy - Field by which records are sorted (optional)
        Returns:
        com.vmware.nsx_policy.model.SearchResponse
      • list

        public SearchResponse list​(java.lang.String enforcementPointName,
                                   java.lang.String cursor,
                                   java.lang.String dsl,
                                   java.lang.String includedFields,
                                   java.lang.Long pageSize,
                                   java.lang.String query,
                                   java.lang.Boolean sortAscending,
                                   java.lang.String sortBy,
                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: VirtualMachines
        This API filters objects of type virtual machines from the specified NSX Manager.
        This API has been deprecated. Please use the new API GET /infra/realized-state/virtual-machines

        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:
        list in interface VirtualMachines
        Parameters:
        enforcementPointName - (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        dsl - Search DSL (domain specific language) query (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)
        query - Search query (optional)
        sortAscending - (optional)
        sortBy - Field by which records are sorted (optional)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.SearchResponse
      • list

        public void list​(java.lang.String enforcementPointName,
                         java.lang.String cursor,
                         java.lang.String dsl,
                         java.lang.String includedFields,
                         java.lang.Long pageSize,
                         java.lang.String query,
                         java.lang.Boolean sortAscending,
                         java.lang.String sortBy,
                         com.vmware.vapi.bindings.client.AsyncCallback<SearchResponse> asyncCallback)
        Description copied from interface: VirtualMachines
        This API filters objects of type virtual machines from the specified NSX Manager.
        This API has been deprecated. Please use the new API GET /infra/realized-state/virtual-machines

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

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

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

        Specified by:
        list in interface VirtualMachines
        Parameters:
        enforcementPointName - (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        dsl - Search DSL (domain specific language) query (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)
        query - Search query (optional)
        sortAscending - (optional)
        sortBy - Field by which records are sorted (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • list

        public void list​(java.lang.String enforcementPointName,
                         java.lang.String cursor,
                         java.lang.String dsl,
                         java.lang.String includedFields,
                         java.lang.Long pageSize,
                         java.lang.String query,
                         java.lang.Boolean sortAscending,
                         java.lang.String sortBy,
                         com.vmware.vapi.bindings.client.AsyncCallback<SearchResponse> asyncCallback,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: VirtualMachines
        This API filters objects of type virtual machines from the specified NSX Manager.
        This API has been deprecated. Please use the new API GET /infra/realized-state/virtual-machines

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

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

        Specified by:
        list in interface VirtualMachines
        Parameters:
        enforcementPointName - (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        dsl - Search DSL (domain specific language) query (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)
        query - Search query (optional)
        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.
      • updatetags

        public void updatetags​(java.lang.String enforcementPointName,
                               VirtualMachineTagsUpdate virtualMachineTagsUpdate)
        Description copied from interface: VirtualMachines

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

        Specified by:
        updatetags in interface VirtualMachines
        Parameters:
        enforcementPointName - (required)
        virtualMachineTagsUpdate - (required)
      • updatetags

        public void updatetags​(java.lang.String enforcementPointName,
                               VirtualMachineTagsUpdate virtualMachineTagsUpdate,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: VirtualMachines

        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:
        updatetags in interface VirtualMachines
        Parameters:
        enforcementPointName - (required)
        virtualMachineTagsUpdate - (required)
        invocationConfig - Configuration for the method invocation.
      • updatetags

        public void updatetags​(java.lang.String enforcementPointName,
                               VirtualMachineTagsUpdate virtualMachineTagsUpdate,
                               com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Description copied from interface: VirtualMachines

        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

        Specified by:
        updatetags in interface VirtualMachines
        Parameters:
        enforcementPointName - (required)
        virtualMachineTagsUpdate - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • updatetags

        public void updatetags​(java.lang.String enforcementPointName,
                               VirtualMachineTagsUpdate virtualMachineTagsUpdate,
                               com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: VirtualMachines

        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

        Specified by:
        updatetags in interface VirtualMachines
        Parameters:
        enforcementPointName - (required)
        virtualMachineTagsUpdate - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.