Package com.vmware.nsx_policy.global_infra.domains

Class GroupsStub

  • All Implemented Interfaces:
    Groups, GroupsTypes, com.vmware.vapi.bindings.Service
    public class GroupsStub
extends com.vmware.vapi.internal.bindings.Stub
implements Groups
    Remote stub implementation of the Groups 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
      GroupsStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)  
      GroupsStub​(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
      Group get​(java.lang.String domainId, java.lang.String groupId)
      Read group
      void get​(java.lang.String domainId, java.lang.String groupId, com.vmware.vapi.bindings.client.AsyncCallback<Group> asyncCallback)
      Read group
      void get​(java.lang.String domainId, java.lang.String groupId, com.vmware.vapi.bindings.client.AsyncCallback<Group> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read group
      Group get​(java.lang.String domainId, java.lang.String groupId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read group
      GroupListResult list​(java.lang.String domainId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.String memberTypes, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy)
      List Groups for a domain.
      void list​(java.lang.String domainId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.String memberTypes, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<GroupListResult> asyncCallback)
      List Groups for a domain.
      void list​(java.lang.String domainId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.String memberTypes, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<GroupListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      List Groups for a domain.
      GroupListResult list​(java.lang.String domainId, java.lang.String cursor, java.lang.Boolean includeMarkForDeleteObjects, java.lang.String includedFields, java.lang.String memberTypes, java.lang.Long pageSize, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      List Groups for a 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

      • GroupsStub

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

      • GroupsStub

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

    • Method Detail

      • get

        public Group get​(java.lang.String domainId,
                 java.lang.String groupId)
        Description copied from interface: Groups
        Read group

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

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

      • get

        public Group get​(java.lang.String domainId,
                 java.lang.String groupId,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Groups
        Read group

        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 Groups
        Parameters:
        domainId - Domain ID (required)
        groupId - Group ID (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.Group

      • get

        public void get​(java.lang.String domainId,
                java.lang.String groupId,
                com.vmware.vapi.bindings.client.AsyncCallback<Group> asyncCallback)
        Description copied from interface: Groups
        Read group

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

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

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

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

      • get

        public void get​(java.lang.String domainId,
                java.lang.String groupId,
                com.vmware.vapi.bindings.client.AsyncCallback<Group> asyncCallback,
                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Groups
        Read group

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

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

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

      • list

        public GroupListResult list​(java.lang.String domainId,
                            java.lang.String cursor,
                            java.lang.Boolean includeMarkForDeleteObjects,
                            java.lang.String includedFields,
                            java.lang.String memberTypes,
                            java.lang.Long pageSize,
                            java.lang.Boolean sortAscending,
                            java.lang.String sortBy)
        Description copied from interface: Groups
        List Groups for a domain. Groups can be filtered using member_types query parameter, which returns the groups that contains the specified member types. Multiple member types can be provided as comma separated values. The API also return groups having member type that are subset of provided member_types.

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

        Specified by:
        list in interface Groups
        Parameters:
        domainId - Domain ID (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)
        memberTypes - Comma Separated Member types (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.GroupListResult

      • list

        public GroupListResult list​(java.lang.String domainId,
                            java.lang.String cursor,
                            java.lang.Boolean includeMarkForDeleteObjects,
                            java.lang.String includedFields,
                            java.lang.String memberTypes,
                            java.lang.Long pageSize,
                            java.lang.Boolean sortAscending,
                            java.lang.String sortBy,
                            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Groups
        List Groups for a domain. Groups can be filtered using member_types query parameter, which returns the groups that contains the specified member types. Multiple member types can be provided as comma separated values. The API also return groups having member type that are subset of provided member_types.

        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 Groups
        Parameters:
        domainId - Domain ID (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)
        memberTypes - Comma Separated Member types (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.GroupListResult

      • list

        public void list​(java.lang.String domainId,
                 java.lang.String cursor,
                 java.lang.Boolean includeMarkForDeleteObjects,
                 java.lang.String includedFields,
                 java.lang.String memberTypes,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<GroupListResult> asyncCallback)
        Description copied from interface: Groups
        List Groups for a domain. Groups can be filtered using member_types query parameter, which returns the groups that contains the specified member types. Multiple member types can be provided as comma separated values. The API also return groups having member type that are subset of provided member_types.

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

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

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

        Specified by:
        list in interface Groups
        Parameters:
        domainId - Domain ID (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)
        memberTypes - Comma Separated Member types (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 domainId,
                 java.lang.String cursor,
                 java.lang.Boolean includeMarkForDeleteObjects,
                 java.lang.String includedFields,
                 java.lang.String memberTypes,
                 java.lang.Long pageSize,
                 java.lang.Boolean sortAscending,
                 java.lang.String sortBy,
                 com.vmware.vapi.bindings.client.AsyncCallback<GroupListResult> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Groups
        List Groups for a domain. Groups can be filtered using member_types query parameter, which returns the groups that contains the specified member types. Multiple member types can be provided as comma separated values. The API also return groups having member type that are subset of provided member_types.

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

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

        Specified by:
        list in interface Groups
        Parameters:
        domainId - Domain ID (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)
        memberTypes - Comma Separated Member types (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.