Package com.vmware.nsx_policy.infra

Interface IpPools

  • All Superinterfaces:
    IpPoolsTypes, com.vmware.vapi.bindings.Service
    All Known Implementing Classes:
    IpPoolsStub
    public interface IpPools
extends com.vmware.vapi.bindings.Service, IpPoolsTypes

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void delete​(java.lang.String ipPoolId)
      Delete the IpAddressPool with the given id.
      void delete​(java.lang.String ipPoolId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      Delete the IpAddressPool with the given id.
      void delete​(java.lang.String ipPoolId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Delete the IpAddressPool with the given id.
      void delete​(java.lang.String ipPoolId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Delete the IpAddressPool with the given id.
      IpAddressPool get​(java.lang.String ipPoolId)
      Read IpAddressPool with given Id.
      void get​(java.lang.String ipPoolId, com.vmware.vapi.bindings.client.AsyncCallback<IpAddressPool> asyncCallback)
      Read IpAddressPool with given Id.
      void get​(java.lang.String ipPoolId, com.vmware.vapi.bindings.client.AsyncCallback<IpAddressPool> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read IpAddressPool with given Id.
      IpAddressPool get​(java.lang.String ipPoolId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read IpAddressPool with given Id.
      IpAddressPoolListResult list​(java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)
      Paginated list of IpAddressPools.
      void list​(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<IpAddressPoolListResult> asyncCallback)
      Paginated list of IpAddressPools.
      void list​(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<IpAddressPoolListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Paginated list of IpAddressPools.
      IpAddressPoolListResult list​(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)
      Paginated list of IpAddressPools.
      void patch​(java.lang.String ipPoolId, IpAddressPool ipAddressPool)
      Creates a new IpAddressPool with specified ID if not already present.
      void patch​(java.lang.String ipPoolId, IpAddressPool ipAddressPool, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      Creates a new IpAddressPool with specified ID if not already present.
      void patch​(java.lang.String ipPoolId, IpAddressPool ipAddressPool, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Creates a new IpAddressPool with specified ID if not already present.
      void patch​(java.lang.String ipPoolId, IpAddressPool ipAddressPool, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Creates a new IpAddressPool with specified ID if not already present.
      IpAddressPool update​(java.lang.String ipPoolId, IpAddressPool ipAddressPool)
      Create a new IpAddressPool with given ID if it does not exist.
      void update​(java.lang.String ipPoolId, IpAddressPool ipAddressPool, com.vmware.vapi.bindings.client.AsyncCallback<IpAddressPool> asyncCallback)
      Create a new IpAddressPool with given ID if it does not exist.
      void update​(java.lang.String ipPoolId, IpAddressPool ipAddressPool, com.vmware.vapi.bindings.client.AsyncCallback<IpAddressPool> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Create a new IpAddressPool with given ID if it does not exist.
      IpAddressPool update​(java.lang.String ipPoolId, IpAddressPool ipAddressPool, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Create a new IpAddressPool with given ID if it does not exist.

    • Method Detail

      • delete

        void delete​(java.lang.String ipPoolId)
        Delete the IpAddressPool with the given id.

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

        Parameters:
        ipPoolId - (required)
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • delete

        void delete​(java.lang.String ipPoolId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Delete the IpAddressPool with the given id.

        Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

        Parameters:
        ipPoolId - (required)
        invocationConfig - Configuration for the method invocation.
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • delete

        void delete​(java.lang.String ipPoolId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Delete the IpAddressPool with the given id.

        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

        Parameters:
        ipPoolId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • delete

        void delete​(java.lang.String ipPoolId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Delete the IpAddressPool with the given id.

        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

        Parameters:
        ipPoolId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • get

        IpAddressPool get​(java.lang.String ipPoolId)
        Read IpAddressPool with given Id.

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

        Parameters:
        ipPoolId - (required)
        Returns:
        com.vmware.nsx_policy.model.IpAddressPool
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • get

        IpAddressPool get​(java.lang.String ipPoolId,
                  com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Read IpAddressPool with given Id.

        Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

        Parameters:
        ipPoolId - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.IpAddressPool
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • get

        void get​(java.lang.String ipPoolId,
         com.vmware.vapi.bindings.client.AsyncCallback<IpAddressPool> asyncCallback)
        Read IpAddressPool with given Id.

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

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

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

        Parameters:
        ipPoolId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • get

        void get​(java.lang.String ipPoolId,
         com.vmware.vapi.bindings.client.AsyncCallback<IpAddressPool> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Read IpAddressPool with given Id.

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

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

        Parameters:
        ipPoolId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • list

        IpAddressPoolListResult list​(java.lang.String cursor,
                             java.lang.Boolean includeMarkForDeleteObjects,
                             java.lang.String includedFields,
                             java.lang.Long pageSize,
                             java.lang.Boolean sortAscending,
                             java.lang.String sortBy)
        Paginated list of IpAddressPools.

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

        Parameters:
        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.IpAddressPoolListResult
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • list

        IpAddressPoolListResult list​(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)
        Paginated list of IpAddressPools.

        Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

        Parameters:
        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.IpAddressPoolListResult
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • list

        void list​(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<IpAddressPoolListResult> asyncCallback)
        Paginated list of IpAddressPools.

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

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

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

        Parameters:
        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

        void list​(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<IpAddressPoolListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Paginated list of IpAddressPools.

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

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

        Parameters:
        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

        void patch​(java.lang.String ipPoolId,
           IpAddressPool ipAddressPool)
        Creates a new IpAddressPool with specified ID if not already present. If IpAddressPool of given ID is already present, then the instance is updated. This is a full replace.

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

        Parameters:
        ipPoolId - (required)
        ipAddressPool - (required)
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • patch

        void patch​(java.lang.String ipPoolId,
           IpAddressPool ipAddressPool,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Creates a new IpAddressPool with specified ID if not already present. If IpAddressPool of given ID is already present, then the instance is updated. This is a full replace.

        Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

        Parameters:
        ipPoolId - (required)
        ipAddressPool - (required)
        invocationConfig - Configuration for the method invocation.
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • patch

        void patch​(java.lang.String ipPoolId,
           IpAddressPool ipAddressPool,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Creates a new IpAddressPool with specified ID if not already present. If IpAddressPool of given ID is already present, then the instance is updated. This is a full replace.

        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

        Parameters:
        ipPoolId - (required)
        ipAddressPool - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • patch

        void patch​(java.lang.String ipPoolId,
           IpAddressPool ipAddressPool,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Creates a new IpAddressPool with specified ID if not already present. If IpAddressPool of given ID is already present, then the instance is updated. This is a full replace.

        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

        Parameters:
        ipPoolId - (required)
        ipAddressPool - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • update

        IpAddressPool update​(java.lang.String ipPoolId,
                     IpAddressPool ipAddressPool)
        Create a new IpAddressPool with given ID if it does not exist. If IpAddressPool with given ID already exists, it will update existing instance. This is a full replace.

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

        Parameters:
        ipPoolId - (required)
        ipAddressPool - (required)
        Returns:
        com.vmware.nsx_policy.model.IpAddressPool
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • update

        IpAddressPool update​(java.lang.String ipPoolId,
                     IpAddressPool ipAddressPool,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Create a new IpAddressPool with given ID if it does not exist. If IpAddressPool with given ID already exists, it will update existing instance. This is a full replace.

        Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

        Parameters:
        ipPoolId - (required)
        ipAddressPool - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.IpAddressPool
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found

      • update

        void update​(java.lang.String ipPoolId,
            IpAddressPool ipAddressPool,
            com.vmware.vapi.bindings.client.AsyncCallback<IpAddressPool> asyncCallback)
        Create a new IpAddressPool with given ID if it does not exist. If IpAddressPool with given ID already exists, it will update existing instance. This is a full replace.

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

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

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

        Parameters:
        ipPoolId - (required)
        ipAddressPool - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • update

        void update​(java.lang.String ipPoolId,
            IpAddressPool ipAddressPool,
            com.vmware.vapi.bindings.client.AsyncCallback<IpAddressPool> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Create a new IpAddressPool with given ID if it does not exist. If IpAddressPool with given ID already exists, it will update existing instance. This is a full replace.

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

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

        Parameters:
        ipPoolId - (required)
        ipAddressPool - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.