Class DomainsStub

  • All Implemented Interfaces:
    Domains, DomainsTypes, com.vmware.vapi.bindings.Service

    public class DomainsStub
    extends com.vmware.vapi.internal.bindings.Stub
    implements Domains
    Remote stub implementation of the Domains 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
      DomainsStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)  
      DomainsStub​(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 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.
      • 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

      • DomainsStub

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

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

      • delete

        public void delete​(java.lang.String domainId)
        Description copied from interface: Domains
        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.

        Specified by:
        delete in interface Domains
        Parameters:
        domainId - Domain ID (required)
      • delete

        public void delete​(java.lang.String domainId,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Domains
        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.

        Specified by:
        delete in interface Domains
        Parameters:
        domainId - Domain ID (required)
        invocationConfig - Configuration for the method invocation.
      • delete

        public void delete​(java.lang.String domainId,
                           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Description copied from interface: Domains
        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

        Specified by:
        delete in interface Domains
        Parameters:
        domainId - Domain ID (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • delete

        public void delete​(java.lang.String domainId,
                           com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Domains
        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

        Specified by:
        delete in interface Domains
        Parameters:
        domainId - Domain ID (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.
      • get

        public Domain get​(java.lang.String domainId)
        Description copied from interface: Domains
        Read a domain.

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

        Specified by:
        get in interface Domains
        Parameters:
        domainId - Domain ID (required)
        Returns:
        com.vmware.nsx_policy.model.Domain
      • get

        public Domain get​(java.lang.String domainId,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Domains
        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.

        Specified by:
        get in interface Domains
        Parameters:
        domainId - Domain ID (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.Domain
      • get

        public void get​(java.lang.String domainId,
                        com.vmware.vapi.bindings.client.AsyncCallback<Domain> asyncCallback)
        Description copied from interface: Domains
        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

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

        public void get​(java.lang.String domainId,
                        com.vmware.vapi.bindings.client.AsyncCallback<Domain> asyncCallback,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Domains
        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

        Specified by:
        get in interface Domains
        Parameters:
        domainId - Domain ID (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.
      • list

        public 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)
        Description copied from interface: Domains
        Paginated list of all domains for infra.

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

        Specified by:
        list in interface Domains
        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
      • list

        public 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)
        Description copied from interface: Domains
        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.

        Specified by:
        list in interface Domains
        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
      • list

        public 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)
        Description copied from interface: Domains
        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

        Specified by:
        list in interface Domains
        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

        public 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)
        Description copied from interface: Domains
        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

        Specified by:
        list in interface Domains
        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

        public void patch​(java.lang.String domainId,
                          Domain domain)
        Description copied from interface: Domains
        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.

        Specified by:
        patch in interface Domains
        Parameters:
        domainId - Domain ID (required)
        domain - (required)
      • patch

        public void patch​(java.lang.String domainId,
                          Domain domain,
                          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Domains
        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.

        Specified by:
        patch in interface Domains
        Parameters:
        domainId - Domain ID (required)
        domain - (required)
        invocationConfig - Configuration for the method invocation.
      • patch

        public void patch​(java.lang.String domainId,
                          Domain domain,
                          com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
        Description copied from interface: Domains
        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

        Specified by:
        patch in interface Domains
        Parameters:
        domainId - Domain ID (required)
        domain - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • patch

        public 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)
        Description copied from interface: Domains
        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

        Specified by:
        patch in interface Domains
        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

        public Domain update​(java.lang.String domainId,
                             Domain domain)
        Description copied from interface: Domains
        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.

        Specified by:
        update in interface Domains
        Parameters:
        domainId - Domain ID (required)
        domain - (required)
        Returns:
        com.vmware.nsx_policy.model.Domain
      • update

        public Domain update​(java.lang.String domainId,
                             Domain domain,
                             com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Domains
        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.

        Specified by:
        update in interface Domains
        Parameters:
        domainId - Domain ID (required)
        domain - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.Domain
      • update

        public void update​(java.lang.String domainId,
                           Domain domain,
                           com.vmware.vapi.bindings.client.AsyncCallback<Domain> asyncCallback)
        Description copied from interface: Domains
        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

        Specified by:
        update in interface Domains
        Parameters:
        domainId - Domain ID (required)
        domain - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • update

        public void update​(java.lang.String domainId,
                           Domain domain,
                           com.vmware.vapi.bindings.client.AsyncCallback<Domain> asyncCallback,
                           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Domains
        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

        Specified by:
        update in interface Domains
        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.