Package com.vmware.nsx_policy.global_infra.tier_0s

Interface Groups

  • All Superinterfaces:
    GroupsTypes, com.vmware.vapi.bindings.Service
    All Known Implementing Classes:
    GroupsStub
    public interface Groups
extends com.vmware.vapi.bindings.Service, GroupsTypes

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Group get​(java.lang.String tier0Id, java.lang.String groupId)
      Read Tier-0 Group
      void get​(java.lang.String tier0Id, java.lang.String groupId, com.vmware.vapi.bindings.client.AsyncCallback<Group> asyncCallback)
      Read Tier-0 Group
      void get​(java.lang.String tier0Id, java.lang.String groupId, com.vmware.vapi.bindings.client.AsyncCallback<Group> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read Tier-0 Group
      Group get​(java.lang.String tier0Id, java.lang.String groupId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Read Tier-0 Group
      GroupListResult list​(java.lang.String tier0Id, 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)
      Paginated list of all Groups for Tier-0.
      void list​(java.lang.String tier0Id, 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)
      Paginated list of all Groups for Tier-0.
      void list​(java.lang.String tier0Id, 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)
      Paginated list of all Groups for Tier-0.
      GroupListResult list​(java.lang.String tier0Id, 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)
      Paginated list of all Groups for Tier-0.

    • Method Detail

      • get

        Group get​(java.lang.String tier0Id,
          java.lang.String groupId)
        Read Tier-0 Group

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

        Parameters:
        tier0Id - (required)
        groupId - (required)
        Returns:
        com.vmware.nsx_policy.model.Group
        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

        Group get​(java.lang.String tier0Id,
          java.lang.String groupId,
          com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Read Tier-0 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.

        Parameters:
        tier0Id - (required)
        groupId - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.Group
        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 tier0Id,
         java.lang.String groupId,
         com.vmware.vapi.bindings.client.AsyncCallback<Group> asyncCallback)
        Read Tier-0 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

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

      • get

        void get​(java.lang.String tier0Id,
         java.lang.String groupId,
         com.vmware.vapi.bindings.client.AsyncCallback<Group> asyncCallback,
         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Read Tier-0 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

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

      • list

        GroupListResult list​(java.lang.String tier0Id,
                     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)
        Paginated list of all Groups for Tier-0.

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

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

        GroupListResult list​(java.lang.String tier0Id,
                     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)
        Paginated list of all Groups for Tier-0.

        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:
        tier0Id - (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
        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 tier0Id,
          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)
        Paginated list of all Groups for Tier-0.

        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

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

        void list​(java.lang.String tier0Id,
          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)
        Paginated list of all Groups for Tier-0.

        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

        Parameters:
        tier0Id - (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.