Package com.vmware.nsx_policy.infra.ip_pools

Class IpAllocationsStub

  • All Implemented Interfaces:
    IpAllocations, IpAllocationsTypes, com.vmware.vapi.bindings.Service
    public class IpAllocationsStub
extends com.vmware.vapi.internal.bindings.Stub
implements IpAllocations
    Remote stub implementation of the IpAllocations 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
      IpAllocationsStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)  
      IpAllocationsStub​(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
      void delete​(java.lang.String ipPoolId, java.lang.String ipAllocationId)
      Releases the IP that was allocated for this allocation request
      void delete​(java.lang.String ipPoolId, java.lang.String ipAllocationId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      Releases the IP that was allocated for this allocation request
      void delete​(java.lang.String ipPoolId, java.lang.String ipAllocationId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Releases the IP that was allocated for this allocation request
      void delete​(java.lang.String ipPoolId, java.lang.String ipAllocationId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Releases the IP that was allocated for this allocation request
      IpAddressAllocation get​(java.lang.String ipPoolId, java.lang.String ipAllocationId)
      Read a previously created allocation
      void get​(java.lang.String ipPoolId, java.lang.String ipAllocationId, com.vmware.vapi.bindings.client.AsyncCallback<IpAddressAllocation> asyncCallback)
      Read a previously created allocation
      void get​(java.lang.String ipPoolId, java.lang.String ipAllocationId, com.vmware.vapi.bindings.client.AsyncCallback<IpAddressAllocation> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read a previously created allocation
      IpAddressAllocation get​(java.lang.String ipPoolId, java.lang.String ipAllocationId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read a previously created allocation
      IpAddressAllocationListResult list​(java.lang.String ipPoolId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)
      Returns information about which addresses have been allocated from a specified IP address pool in policy.
      void list​(java.lang.String ipPoolId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<IpAddressAllocationListResult> asyncCallback)
      Returns information about which addresses have been allocated from a specified IP address pool in policy.
      void list​(java.lang.String ipPoolId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<IpAddressAllocationListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Returns information about which addresses have been allocated from a specified IP address pool in policy.
      IpAddressAllocationListResult list​(java.lang.String ipPoolId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Returns information about which addresses have been allocated from a specified IP address pool in policy.
      void patch​(java.lang.String ipPoolId, java.lang.String ipAllocationId, IpAddressAllocation ipAddressAllocation)
      If allocation of the same ID is found, this is a no-op.
      void patch​(java.lang.String ipPoolId, java.lang.String ipAllocationId, IpAddressAllocation ipAddressAllocation, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      If allocation of the same ID is found, this is a no-op.
      void patch​(java.lang.String ipPoolId, java.lang.String ipAllocationId, IpAddressAllocation ipAddressAllocation, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If allocation of the same ID is found, this is a no-op.
      void patch​(java.lang.String ipPoolId, java.lang.String ipAllocationId, IpAddressAllocation ipAddressAllocation, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If allocation of the same ID is found, this is a no-op.
      IpAddressAllocation update​(java.lang.String ipPoolId, java.lang.String ipAllocationId, IpAddressAllocation ipAddressAllocation)
      If allocation of the same ID is found, this is a no-op.
      void update​(java.lang.String ipPoolId, java.lang.String ipAllocationId, IpAddressAllocation ipAddressAllocation, com.vmware.vapi.bindings.client.AsyncCallback<IpAddressAllocation> asyncCallback)
      If allocation of the same ID is found, this is a no-op.
      void update​(java.lang.String ipPoolId, java.lang.String ipAllocationId, IpAddressAllocation ipAddressAllocation, com.vmware.vapi.bindings.client.AsyncCallback<IpAddressAllocation> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If allocation of the same ID is found, this is a no-op.
      IpAddressAllocation update​(java.lang.String ipPoolId, java.lang.String ipAllocationId, IpAddressAllocation ipAddressAllocation, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If allocation of the same ID is found, this is a no-op.

      • 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

      • IpAllocationsStub

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

      • IpAllocationsStub

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

    • Method Detail

      • delete

        public void delete​(java.lang.String ipPoolId,
                   java.lang.String ipAllocationId)
        Description copied from interface: IpAllocations
        Releases the IP that was allocated for this allocation request

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

        Specified by:
        delete in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)

      • delete

        public void delete​(java.lang.String ipPoolId,
                   java.lang.String ipAllocationId,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: IpAllocations
        Releases the IP that was allocated for this allocation request

        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:
        delete in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)
        invocationConfig - Configuration for the method invocation.

      • delete

        public void delete​(java.lang.String ipPoolId,
                   java.lang.String ipAllocationId,
                   com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Description copied from interface: IpAllocations
        Releases the IP that was allocated for this allocation request

        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:
        delete in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • delete

        public void delete​(java.lang.String ipPoolId,
                   java.lang.String ipAllocationId,
                   com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: IpAllocations
        Releases the IP that was allocated for this allocation request

        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:
        delete in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • get

        public IpAddressAllocation get​(java.lang.String ipPoolId,
                               java.lang.String ipAllocationId)
        Description copied from interface: IpAllocations
        Read a previously created allocation

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

        Specified by:
        get in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)
        Returns:
        com.vmware.nsx_policy.model.IpAddressAllocation

      • get

        public IpAddressAllocation get​(java.lang.String ipPoolId,
                               java.lang.String ipAllocationId,
                               com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: IpAllocations
        Read a previously created allocation

        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 IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.IpAddressAllocation

      • get

        public void get​(java.lang.String ipPoolId,
                java.lang.String ipAllocationId,
                com.vmware.vapi.bindings.client.AsyncCallback<IpAddressAllocation> asyncCallback)
        Description copied from interface: IpAllocations
        Read a previously created allocation

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

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

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

        Specified by:
        get in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • get

        public void get​(java.lang.String ipPoolId,
                java.lang.String ipAllocationId,
                com.vmware.vapi.bindings.client.AsyncCallback<IpAddressAllocation> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: IpAllocations
        Read a previously created allocation

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

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

        Specified by:
        get in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • list

        public IpAddressAllocationListResult list​(java.lang.String ipPoolId,
                                          java.lang.String cursor,
                                          java.lang.Boolean includeMarkForDeleteObjects,
                                          java.lang.String includedFields,
                                          java.lang.Long pageSize,
                                          java.lang.Boolean sortAscending,
                                          java.lang.String sortBy)
        Description copied from interface: IpAllocations
        Returns information about which addresses have been allocated from a specified IP address pool in policy.

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

        Specified by:
        list in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)
        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_policy.model.IpAddressAllocationListResult

      • list

        public IpAddressAllocationListResult list​(java.lang.String ipPoolId,
                                          java.lang.String cursor,
                                          java.lang.Boolean includeMarkForDeleteObjects,
                                          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: IpAllocations
        Returns information about which addresses have been allocated from a specified IP address pool in policy.

        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 IpAllocations
        Parameters:
        ipPoolId - (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)
        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_policy.model.IpAddressAllocationListResult

      • list

        public void list​(java.lang.String ipPoolId,
                 java.lang.String cursor,
                 java.lang.Boolean includeMarkForDeleteObjects,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<IpAddressAllocationListResult> asyncCallback)
        Description copied from interface: IpAllocations
        Returns information about which addresses have been allocated from a specified IP address pool in policy.

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

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

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

        Specified by:
        list in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)
        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.

      • list

        public void list​(java.lang.String ipPoolId,
                 java.lang.String cursor,
                 java.lang.Boolean includeMarkForDeleteObjects,
                 java.lang.String includedFields,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<IpAddressAllocationListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: IpAllocations
        Returns information about which addresses have been allocated from a specified IP address pool in policy.

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

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

        Specified by:
        list in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includeMarkForDeleteObjects - Include objects that are marked for deletion in results (optional, default to false)
        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.

      • patch

        public void patch​(java.lang.String ipPoolId,
                  java.lang.String ipAllocationId,
                  IpAddressAllocation ipAddressAllocation)
        Description copied from interface: IpAllocations
        If allocation of the same ID is found, this is a no-op. If no allocation of the specified ID is found, then a new allocation is created. An allocation cannot be updated once created. When an allocation is requested from an IpAddressPool, the IP could be allocated from any subnet in the pool that has the available capacity. Request to allocate an IP will fail if no subnet was previously created. If specific IP was requested, the status of allocation is reflected in the realized state. If any IP is requested, the IP finally allocated is obtained by polling on the realized state until the allocated IP is returned in the extended attributes.

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

        Specified by:
        patch in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)
        ipAddressAllocation - (required)

      • patch

        public void patch​(java.lang.String ipPoolId,
                  java.lang.String ipAllocationId,
                  IpAddressAllocation ipAddressAllocation,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: IpAllocations
        If allocation of the same ID is found, this is a no-op. If no allocation of the specified ID is found, then a new allocation is created. An allocation cannot be updated once created. When an allocation is requested from an IpAddressPool, the IP could be allocated from any subnet in the pool that has the available capacity. Request to allocate an IP will fail if no subnet was previously created. If specific IP was requested, the status of allocation is reflected in the realized state. If any IP is requested, the IP finally allocated is obtained by polling on the realized state until the allocated IP is returned in the extended attributes.

        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:
        patch in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)
        ipAddressAllocation - (required)
        invocationConfig - Configuration for the method invocation.

      • patch

        public void patch​(java.lang.String ipPoolId,
                  java.lang.String ipAllocationId,
                  IpAddressAllocation ipAddressAllocation,
                  com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Description copied from interface: IpAllocations
        If allocation of the same ID is found, this is a no-op. If no allocation of the specified ID is found, then a new allocation is created. An allocation cannot be updated once created. When an allocation is requested from an IpAddressPool, the IP could be allocated from any subnet in the pool that has the available capacity. Request to allocate an IP will fail if no subnet was previously created. If specific IP was requested, the status of allocation is reflected in the realized state. If any IP is requested, the IP finally allocated is obtained by polling on the realized state until the allocated IP is returned in the extended attributes.

        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:
        patch in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)
        ipAddressAllocation - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • patch

        public void patch​(java.lang.String ipPoolId,
                  java.lang.String ipAllocationId,
                  IpAddressAllocation ipAddressAllocation,
                  com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: IpAllocations
        If allocation of the same ID is found, this is a no-op. If no allocation of the specified ID is found, then a new allocation is created. An allocation cannot be updated once created. When an allocation is requested from an IpAddressPool, the IP could be allocated from any subnet in the pool that has the available capacity. Request to allocate an IP will fail if no subnet was previously created. If specific IP was requested, the status of allocation is reflected in the realized state. If any IP is requested, the IP finally allocated is obtained by polling on the realized state until the allocated IP is returned in the extended attributes.

        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:
        patch in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)
        ipAddressAllocation - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • update

        public IpAddressAllocation update​(java.lang.String ipPoolId,
                                  java.lang.String ipAllocationId,
                                  IpAddressAllocation ipAddressAllocation)
        Description copied from interface: IpAllocations
        If allocation of the same ID is found, this is a no-op. If no allocation of the specified ID is found, then a new allocation is created. An allocation cannot be updated once created. When an IP allocation is requested from an IpAddressPool, the IP could be allocated from any subnet in the pool that has the available capacity. Request to allocate an IP will fail if no subnet was previously created. If specific IP was requested, the status of allocation is reflected in the realized state. If any IP is requested, the IP finally allocated is obtained by polling on the realized state until the allocated IP is returned in the extended attributes. An allocation cannot be updated once created.

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

        Specified by:
        update in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)
        ipAddressAllocation - (required)
        Returns:
        com.vmware.nsx_policy.model.IpAddressAllocation

      • update

        public IpAddressAllocation update​(java.lang.String ipPoolId,
                                  java.lang.String ipAllocationId,
                                  IpAddressAllocation ipAddressAllocation,
                                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: IpAllocations
        If allocation of the same ID is found, this is a no-op. If no allocation of the specified ID is found, then a new allocation is created. An allocation cannot be updated once created. When an IP allocation is requested from an IpAddressPool, the IP could be allocated from any subnet in the pool that has the available capacity. Request to allocate an IP will fail if no subnet was previously created. If specific IP was requested, the status of allocation is reflected in the realized state. If any IP is requested, the IP finally allocated is obtained by polling on the realized state until the allocated IP is returned in the extended attributes. An allocation cannot be updated once created.

        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 IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)
        ipAddressAllocation - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.IpAddressAllocation

      • update

        public void update​(java.lang.String ipPoolId,
                   java.lang.String ipAllocationId,
                   IpAddressAllocation ipAddressAllocation,
                   com.vmware.vapi.bindings.client.AsyncCallback<IpAddressAllocation> asyncCallback)
        Description copied from interface: IpAllocations
        If allocation of the same ID is found, this is a no-op. If no allocation of the specified ID is found, then a new allocation is created. An allocation cannot be updated once created. When an IP allocation is requested from an IpAddressPool, the IP could be allocated from any subnet in the pool that has the available capacity. Request to allocate an IP will fail if no subnet was previously created. If specific IP was requested, the status of allocation is reflected in the realized state. If any IP is requested, the IP finally allocated is obtained by polling on the realized state until the allocated IP is returned in the extended attributes. An allocation cannot be updated once created.

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

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

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

        Specified by:
        update in interface IpAllocations
        Parameters:
        ipPoolId - (required)
        ipAllocationId - (required)
        ipAddressAllocation - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • update

        public void update​(java.lang.String ipPoolId,
                   java.lang.String ipAllocationId,
                   IpAddressAllocation ipAddressAllocation,
                   com.vmware.vapi.bindings.client.AsyncCallback<IpAddressAllocation> asyncCallback,
                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: IpAllocations
        If allocation of the same ID is found, this is a no-op. If no allocation of the specified ID is found, then a new allocation is created. An allocation cannot be updated once created. When an IP allocation is requested from an IpAddressPool, the IP could be allocated from any subnet in the pool that has the available capacity. Request to allocate an IP will fail if no subnet was previously created. If specific IP was requested, the status of allocation is reflected in the realized state. If any IP is requested, the IP finally allocated is obtained by polling on the realized state until the allocated IP is returned in the extended attributes. An allocation cannot be updated once created.

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

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

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