Class ApiServiceStub

  • All Implemented Interfaces:
    ApiService, ApiServiceTypes, com.vmware.vapi.bindings.Service

    public class ApiServiceStub
    extends com.vmware.vapi.internal.bindings.Stub
    implements ApiService
    Remote stub implementation of the ApiService 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
      ApiServiceStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)  
      ApiServiceStub​(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
      ApiServiceConfig get()
      Read the configuration of the NSX API service.
      void get​(com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback)
      Read the configuration of the NSX API service.
      void get​(com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read the configuration of the NSX API service.
      ApiServiceConfig get​(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read the configuration of the NSX API service.
      ApiServiceConfig update​(ApiServiceConfig apiServiceConfig)
      Update the configuration of the NSX API service.
      void update​(ApiServiceConfig apiServiceConfig, com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback)
      Update the configuration of the NSX API service.
      void update​(ApiServiceConfig apiServiceConfig, com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Update the configuration of the NSX API service.
      ApiServiceConfig update​(ApiServiceConfig apiServiceConfig, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Update the configuration of the NSX API service.
      • 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

      • ApiServiceStub

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

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

      • get

        public ApiServiceConfig get()
        Description copied from interface: ApiService
        Read the configuration of the NSX API service.

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

        Specified by:
        get in interface ApiService
        Returns:
        com.vmware.nsx_policy.model.ApiServiceConfig
      • get

        public ApiServiceConfig get​(com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: ApiService
        Read the configuration of the NSX API service.

        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 ApiService
        Parameters:
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ApiServiceConfig
      • get

        public void get​(com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback)
        Description copied from interface: ApiService
        Read the configuration of the NSX API service.

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

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

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

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

        public void get​(com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: ApiService
        Read the configuration of the NSX API service.

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

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

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

        public ApiServiceConfig update​(ApiServiceConfig apiServiceConfig)
        Description copied from interface: ApiService
        Update the configuration of the NSX API service. Changes are applied to all nodes in the cluster. The API service on each node will restart after it is updated using this API. There may be a delay of up to a minute or so between the time this API call completes and when the new configuration goes into effect.

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

        Specified by:
        update in interface ApiService
        Parameters:
        apiServiceConfig - (required)
        Returns:
        com.vmware.nsx_policy.model.ApiServiceConfig
      • update

        public ApiServiceConfig update​(ApiServiceConfig apiServiceConfig,
                                       com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: ApiService
        Update the configuration of the NSX API service. Changes are applied to all nodes in the cluster. The API service on each node will restart after it is updated using this API. There may be a delay of up to a minute or so between the time this API call completes and when the new configuration goes into effect.

        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:
        update in interface ApiService
        Parameters:
        apiServiceConfig - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.ApiServiceConfig
      • update

        public void update​(ApiServiceConfig apiServiceConfig,
                           com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback)
        Description copied from interface: ApiService
        Update the configuration of the NSX API service. Changes are applied to all nodes in the cluster. The API service on each node will restart after it is updated using this API. There may be a delay of up to a minute or so between the time this API call completes and when the new configuration goes into effect.

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

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

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

        Specified by:
        update in interface ApiService
        Parameters:
        apiServiceConfig - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • update

        public void update​(ApiServiceConfig apiServiceConfig,
                           com.vmware.vapi.bindings.client.AsyncCallback<ApiServiceConfig> asyncCallback,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: ApiService
        Update the configuration of the NSX API service. Changes are applied to all nodes in the cluster. The API service on each node will restart after it is updated using this API. There may be a delay of up to a minute or so between the time this API call completes and when the new configuration goes into effect.

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

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

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