Package com.vmware.nsx_policy.infra

Interface Domains

  • All Superinterfaces:
    DomainsTypes, com.vmware.vapi.bindings.Service
    All Known Implementing Classes:
    DomainsStub
    public interface Domains
extends com.vmware.vapi.bindings.Service, DomainsTypes

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void delete​(java.lang.String domainId)
      Delete the domain along with all the entities contained by this domain.
      void delete​(java.lang.String domainId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      Delete the domain along with all the entities contained by this domain.
      void delete​(java.lang.String domainId, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Delete the domain along with all the entities contained by this domain.
      void delete​(java.lang.String domainId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Delete the domain along with all the entities contained by this domain.
      Domain get​(java.lang.String domainId)
      Read a domain.
      void get​(java.lang.String domainId, com.vmware.vapi.bindings.client.AsyncCallback<Domain> asyncCallback)
      Read a domain.
      void get​(java.lang.String domainId, com.vmware.vapi.bindings.client.AsyncCallback<Domain> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read a domain.
      Domain get​(java.lang.String domainId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read a domain.
      DomainListResult 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 all domains for infra.
      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<DomainListResult> asyncCallback)
      Paginated list of all domains for infra.
      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<DomainListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Paginated list of all domains for infra.
      DomainListResult 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 all domains for infra.
      void patch​(java.lang.String domainId, Domain domain)
      If a domain with the domain-id is not already present, create a new domain.
      void patch​(java.lang.String domainId, Domain domain, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
      If a domain with the domain-id is not already present, create a new domain.
      void patch​(java.lang.String domainId, Domain domain, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If a domain with the domain-id is not already present, create a new domain.
      void patch​(java.lang.String domainId, Domain domain, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If a domain with the domain-id is not already present, create a new domain.
      Domain update​(java.lang.String domainId, Domain domain)
      If a domain with the domain-id is not already present, create a new domain.
      void update​(java.lang.String domainId, Domain domain, com.vmware.vapi.bindings.client.AsyncCallback<Domain> asyncCallback)
      If a domain with the domain-id is not already present, create a new domain.
      void update​(java.lang.String domainId, Domain domain, com.vmware.vapi.bindings.client.AsyncCallback<Domain> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If a domain with the domain-id is not already present, create a new domain.
      Domain update​(java.lang.String domainId, Domain domain, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      If a domain with the domain-id is not already present, create a new domain.

    • Method Detail

      • delete

        void delete​(java.lang.String domainId)
        Delete the domain along with all the entities contained by this domain. The groups that are a part of this domain are also deleted along with the domain.

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

        Parameters:
        domainId - Domain ID (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 domainId,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Delete the domain along with all the entities contained by this domain. The groups that are a part of this domain are also deleted along with the domain.

        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:
        domainId - Domain ID (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 domainId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Delete the domain along with all the entities contained by this domain. The groups that are a part of this domain are also deleted along with the domain.

        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:
        domainId - Domain ID (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • delete

        void delete​(java.lang.String domainId,
            com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Delete the domain along with all the entities contained by this domain. The groups that are a part of this domain are also deleted along with the domain.

        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:
        domainId - Domain ID (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • get

        Domain get​(java.lang.String domainId)
        Read a domain.

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

        Parameters:
        domainId - Domain ID (required)
        Returns:
        com.vmware.nsx_policy.model.Domain
        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

        Domain get​(java.lang.String domainId,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Read a domain.

        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:
        domainId - Domain ID (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.Domain
        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 domainId,
         com.vmware.vapi.bindings.client.AsyncCallback<Domain> asyncCallback)
        Read a domain.

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

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

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

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

      • get

        void get​(java.lang.String domainId,
         com.vmware.vapi.bindings.client.AsyncCallback<Domain> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Read a domain.

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

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

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

      • list

        DomainListResult 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 all domains for infra.

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

        DomainListResult 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 all domains for infra.

        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.DomainListResult
        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<DomainListResult> asyncCallback)
        Paginated list of all domains for infra.

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

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

        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<DomainListResult> asyncCallback,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Paginated list of all domains for infra.

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

        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 domainId,
           Domain domain)
        If a domain with the domain-id is not already present, create a new domain. If it already exists, patch the domain

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

        Parameters:
        domainId - Domain ID (required)
        domain - (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 domainId,
           Domain domain,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        If a domain with the domain-id is not already present, create a new domain. If it already exists, patch the domain

        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:
        domainId - Domain ID (required)
        domain - (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 domainId,
           Domain domain,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        If a domain with the domain-id is not already present, create a new domain. If it already exists, patch the domain

        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:
        domainId - Domain ID (required)
        domain - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • patch

        void patch​(java.lang.String domainId,
           Domain domain,
           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        If a domain with the domain-id is not already present, create a new domain. If it already exists, patch the domain

        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:
        domainId - Domain ID (required)
        domain - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.

      • update

        Domain update​(java.lang.String domainId,
              Domain domain)
        If a domain with the domain-id is not already present, create a new domain. If it already exists, update the domain including the nested groups. This is a full replace

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

        Parameters:
        domainId - Domain ID (required)
        domain - (required)
        Returns:
        com.vmware.nsx_policy.model.Domain
        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

        Domain update​(java.lang.String domainId,
              Domain domain,
              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        If a domain with the domain-id is not already present, create a new domain. If it already exists, update the domain including the nested groups. 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:
        domainId - Domain ID (required)
        domain - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.Domain
        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 domainId,
            Domain domain,
            com.vmware.vapi.bindings.client.AsyncCallback<Domain> asyncCallback)
        If a domain with the domain-id is not already present, create a new domain. If it already exists, update the domain including the nested groups. 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.Domain

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

        Parameters:
        domainId - Domain ID (required)
        domain - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.

      • update

        void update​(java.lang.String domainId,
            Domain domain,
            com.vmware.vapi.bindings.client.AsyncCallback<Domain> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        If a domain with the domain-id is not already present, create a new domain. If it already exists, update the domain including the nested groups. 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.Domain

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

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